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:
“‘Tis hard to say, if greater want of skill
Appear in writing or in judging ill;”
—Alexander Pope (1688–1744)
“The desire of the man is for the woman, but the desire of the woman is for the desire of the man.”
—Germaine de Staël (1766–1817)
“Our brains are no longer conditioned for reverence and awe. We cannot imagine a Second Coming that would not be cut down to size by the televised evening news, or a Last Judgment not subject to pages of holier-than-Thou second- guessing in The New York Review of Books.”
—John Updike (b. 1932)