Using groff

[Greg 'groggy' Lehey]

On Sunday, 10 December 2006 at 18:04:26 -0900, Beech Rintoul wrote:
> I need to write a man page for a port I just adopted. I have absolutely no
> experience dealing with man pages or groff. Would one of you gurus point me
> at a good tutorial. The man page for groff is pretty overwhelming. I googled,
> but didn't find much that wasn't in the man page. Is there a tutorial
> specific to man pages? I can copy the style from other pages, but I have no
> clue where to begin.

RTFM :-)  In this case, the man page to read is mdoc(7).  It contains
a fair amount of information not only on the syntax needed, but also
the sometimes idiosyncratic structure (for example, a section entitled
AUTHORS even if there's only one author).

If you forget the name of the man page, man man.  It's mentioned in
the SEE ALSO section at the bottom.

Greg
--
See complete headers for address and phone numbers.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/freebsd-ports/attachments/20061211/93819f5e/attachment.pgp