wiki:Manpages

Version 1 (modified by jdreed, 11 years ago) (diff)

--

Debian policy says every program should have a man page, even if it's not in one of the typical bin directories.

Here's a template for the imaginary program foobar

.TH foobar 1 "March 2011" Debathena debathena-college-config
.SH NAME
mit-enroll \- Become an undergrad at MIT
.SH SYNOPSIS
.B mit-enroll [
.I --pass-no-record
.B ]
.SH DESCRIPTION
.B mit-enroll
enrolls you as an undergrad at MIT.  Two popular GNOME themes are included.   
.SH OPTIONS
.IP --pass-no-record
Can only be used on the first invocation of the command.
.SH BUGS
Primary storage (usually /dev/sda) fills up quite frequently.

.I --graduate
option is not supported at this time.

.I /proc/acpi/sleep
can be disabled for days at a time.
.SH FILES
.I /usr/share/themes/Florey-Shirt/

.I /usr/share/themes/Spamit-Shirt/
.SH AUTHOR
William Barton Rogers
.SH "SEE ALSO"
.BR undocumented (7)