Subject: misc/36126: mdoc documentation
To: None <misc-bug-people@netbsd.org, gnats-admin@netbsd.org,>
From: brad harder <bharder@methodlogic.net>
List: netbsd-bugs
Date: 04/05/2007 18:00:02
>Number: 36126
>Category: misc
>Synopsis: mdoc(7) documentation incomplete
>Confidential: no
>Severity: non-critical
>Priority: medium
>Responsible: misc-bug-people
>State: open
>Class: doc-bug
>Submitter-Id: net
>Arrival-Date: Thu Apr 05 18:00:01 +0000 2007
>Originator: brad harder <bharder@methodlogic.net>
>Release: NetBSD 4.0_BETA2
>Organization:
http://www.methodlogic.net
>Environment:
System: NetBSD manchester 4.0_BETA2 NetBSD 4.0_BETA2 (manchester) #27: Fri Mar 30 11:27:33 PDT 2007 root@manchester:/usr/obj/sys/arch/i386/compile/manchester i386
Architecture: i386
Machine: i386
>Description:
While following the "why XML?" thread on netbsd-docs ml, Greg Woods described how to define a URL in mdoc(7) format
>> How do you define a URL in mdoc?
> UTSL:
> .Lk href [ anchortext/punc ] ...
but the actual man page description for his solution is:
.Lk To be written.
the situation is the same for .Mt
>How-To-Repeat:
man 7 mdoc
>Fix:
For example:
--- groff_mdoc.man.orig 2007-04-03 17:47:55.000000000 -0700
+++ groff_mdoc.man 2007-04-05 10:44:36.000000000 -0700
@@ -3863,7 +3863,10 @@
It is neither callable nor parsed.
.
.It Li .Lk
-To be written.
+link (for conversion to HTML).
+.Pp
+.Dl Usage: .Lk Ao href Ac Bo anchor-text Bc
+.Pp
.
.It Li .Me
Exact usage unknown.
@@ -3875,7 +3878,10 @@
Its default width is 6n.
.
.It Li .Mt
-To be written.
+mailto (for conversion to HTML).
+.Pp
+.Dl Usage: .Mt Ao email_address Ac
+.Pp
.
.It Li .Ot
Exact usage unknown.