groff
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Groff] Is there a good man page style guide somewhere?


From: Werner LEMBERG
Subject: Re: [Groff] Is there a good man page style guide somewhere?
Date: Sun, 14 Oct 2001 17:50:17 +0200 (CEST)

> I'm learning [gt]roff in order to write good man pages for some of
> my software, and one problem I'm encountering is that I'm not
> exactly sure what a man page *should* look like.

There are two macro packages available to write man pages.  The first
are the classical -man macros, completely documented in groff_man(7).
The second is the -mdoc package documented in groff_mdoc(7).  While
the -man macros are quite easy to understand, -mdoc provides a better
interface, separating page layout from logical markup.

man(7) -- this is not part of groff but comes with the program `man'
-- gives a concise description how man pages should look like.
groff_mdoc(7) also comes with a template.


    Werner

reply via email to

[Prev in Thread] Current Thread [Next in Thread]