Writing Man Pages
On 4.4BSD and its descendants, including FreeBSD, NetBSD, OpenBSD, DragonFly BSD, and OS X, and in GNU/Linux systems, two groff macro packages are available for use in writing manual pages, man and mdoc. The man macro package is older and is the traditional macro package used to write manual pages on UNIX systems, whereas the mdoc package is newer and offers more support for semantic structuring of documents. The commands man groff_man and man groff_mdoc may be used in 4.4BSD-descended systems, and in GNU/Linux, to bring up the online documentation (man pages) for using the man and mdoc macro packages, respectively.
In addition, one can simply inspect the source code for man pages installed on the system to see how they are written, typically found in /usr/share/man and other directories on 4.4BSD-descended systems and GNU/Linux systems. (To find the location of the manual page source file for command command, type man -w command.)
Man pages can also be written in DocBook or LinuxDoc format, then converted to groff.
Read more about this topic: Man Page
Famous quotes containing the words writing, man and/or pages:
“Success and failure on the public level never mattered much to me, in fact I feel more at home with the latter, having breathed deep of its vivifying air all my writing life up to the last couple of years.”
—Samuel Beckett (1906–1989)
“Classical and romantic: private language of a family quarrel, a dead dispute over the distribution of emphasis between man and nature.”
—Cyril Connolly (1903–1974)
“Perhaps these pages are more particularly addressed to poor students. As for the rest of my readers, they will accept such portions as apply to them.”
—Henry David Thoreau (1817–1862)