man page template
On Wed, 11 Mar 1998 16:00:20 -0500 (EST), Adam Heath <email@example.com> said:
> ps: Anybody will to help me write some manpages? Or give me any
> pointers? Those are the only bugs left on my packages.
See man(7), troff(1) and this, which is Tom Christiansen's man page
To: Graham Barr <firstname.lastname@example.org>
cc: Tom Christiansen <email@example.com>,
Andreas J Koenig <firstname.lastname@example.org>,
Perl5 Porters <email@example.com>, firstname.lastname@example.org
In-reply-to: Your message of "Fri, 02 Jan 1998 14:34:11 CST."
Date: Fri, 02 Jan 1998 13:50:02 -0700
From: Tom Christiansen <email@example.com>
.TH NAME SECTION
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
foo, bar \- programs to do something
a short usage summary
long drawn out discussion of the program. it's a good idea
to break this up into subsections using the .SS macros, like
.SS "A Sample Subection"
.SS "Yet Another Sample Subection"
Some people make this separate from the description.
.SH "RETURN VALUE"
What the program or function returns if successful.
Return codes, either exit status or errno settings.
give some example uses of the program
envariables this program might care about
all files used by the program. typical usage is like this:
.\" set tabstop to longest possible filename, plus a wee bit
.ta \w'/usr/lib/perl/getopts.pl 'u
\fI/usr/man\fR default man tree
\fI/usr/man/man*/*.*\fR unformatted (nroff source) man pages
.SH "SEE ALSO"
.\" Always quote multiple words for .SH
other man pages to check out, like man(1), man(7), makewhatis(8), catman(8)
things to take special care with. sometimes called WARNINGS.
all the possible error messages the program can print out, and
what they mean.
things that are broken or just don't work quite right.
bugs you don't plan to fix :-)
who wrote it (or AUTHORS if multiple)
programs derived from other sources sometimes have this.
E-mail the word "unsubscribe" to firstname.lastname@example.org
TO UNSUBSCRIBE FROM THIS MAILING LIST. Trouble? E-mail to email@example.com .