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:
“Good writing is a kind of skating which carries off the performer where he would not go, and is only right admirable when to all its beauty and speed a subserviency to the will, like that of walking, is added.”
—Ralph Waldo Emerson (1803–1882)
“Depend upon it, Sir, when a man knows he is to be hanged in a fortnight, it concentrates his mind wonderfully.”
—Samuel Johnson (1709–1784)
“Mathematics may be compared to a mill of exquisite workmanship, which grinds your stuff to any degree of fineness; but, nevertheless, what you get out depends on what you put in; and as the grandest mill in the world will not extract wheat flour from peascods, so pages of formulae will not get a definite result out of loose data.”
—Thomas Henry Huxley (1825–1895)