| 1 | Debian policy says every program should have a man page, even if it's not in one of the typical bin directories. |
| 2 | |
| 3 | Here's a template for the imaginary program foobar |
| 4 | {{{ |
| 5 | .TH foobar 1 "March 2011" Debathena debathena-college-config |
| 6 | .SH NAME |
| 7 | mit-enroll \- Become an undergrad at MIT |
| 8 | .SH SYNOPSIS |
| 9 | .B mit-enroll [ |
| 10 | .I --pass-no-record |
| 11 | .B ] |
| 12 | .SH DESCRIPTION |
| 13 | .B mit-enroll |
| 14 | enrolls you as an undergrad at MIT. Two popular GNOME themes are included. |
| 15 | .SH OPTIONS |
| 16 | .IP --pass-no-record |
| 17 | Can only be used on the first invocation of the command. |
| 18 | .SH BUGS |
| 19 | Primary storage (usually /dev/sda) fills up quite frequently. |
| 20 | |
| 21 | .I --graduate |
| 22 | option is not supported at this time. |
| 23 | |
| 24 | .I /proc/acpi/sleep |
| 25 | can be disabled for days at a time. |
| 26 | .SH FILES |
| 27 | .I /usr/share/themes/Florey-Shirt/ |
| 28 | |
| 29 | .I /usr/share/themes/Spamit-Shirt/ |
| 30 | .SH AUTHOR |
| 31 | William Barton Rogers |
| 32 | .SH "SEE ALSO" |
| 33 | .BR undocumented (7) |
| 34 | }}} |