Templates
man page
.TH NAME SECTION "3 Jan 2000"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
.\" ----------------------------------------------------------------------
.SH NAME
progname \- program to do something
.\" denote multiple entry points on previous line; makewhatis will catch
them
.\" ----------------------------------------------------------------------
.SH SYNOPSIS
A short usage summary
.\" ----------------------------------------------------------------------
.SH "DESCRIPTION"
Long drawn out discussion of the program. It's a good idea
to break this up into subsections using the .SS macros, like
these:
.SS "A Sample Subsection"
Subsection 1.
.SS "Yet Another Sample Subsection"
Subsection 2.
.\" ----------------------------------------------------------------------
.SH OPTIONS
Some people make this separate from the description.
.\" ----------------------------------------------------------------------
.SH "RETURN VALUE"
.TP 25
Function returns with
If
.TP 25
0
Everything is OK.
.\" ----------------------------------------------------------------------
.SH ERRORS
.TP 25
Program exits with
If
.TP 25
0
Everything is OK.
.TP 25
1
Usage error.
.\" ----------------------------------------------------------------------
.SH EXAMPLES
Give some example uses of the program.
.PP
.Vb
\& These lines hold sample output or
\& a keyboard session.
.Ve
.PP
.\" ----------------------------------------------------------------------
.SH ENVIRONMENT
Environment variables this program might care about
.\" ----------------------------------------------------------------------
.SH FILES
All files used by the program. Typical usage is like this:
.PP
.TP 25
\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)
.\" ----------------------------------------------------------------------
.SH NOTES
Miscellaneous commentary
.\" ----------------------------------------------------------------------
.SH CAVEATS
Things to take special care with; sometimes called WARNINGS.
.\" ----------------------------------------------------------------------
.SH DIAGNOSTICS
All the possible error messages the program can print out, and
what they mean. Use the .TP format above.
.\" ----------------------------------------------------------------------
.SH BUGS
Things that are broken or just don't work quite right.
.\" ----------------------------------------------------------------------
.SH RESTRICTIONS
Bugs you don't plan to fix :-)
.\" ----------------------------------------------------------------------
.SH AUTHOR
Who wrote it (or AUTHORS if multiple), often in the form
.br
Your full name
.br
Your organization or mail address
.\" ----------------------------------------------------------------------
.SH HISTORY
Programs derived from other sources sometimes have this.
.\" ----------------------------------------------------------------------
Template for man pages.