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:
“Writing criticism is to writing fiction and poetry as hugging the shore is to sailing in the open sea.”
—John Updike (b. 1932)
“Argument is conclusive ... but ... it does not remove doubt, so that the mind may rest in the sure knowledge of the truth, unless it finds it by the method of experiment.... For if any man who never saw fire proved by satisfactory arguments that fire burns ... his hearer’s mind would never be satisfied, nor would he avoid the fire until he put his hand in it ... that he might learn by experiment what argument taught.”
—Roger Bacon (c. 1214–1294)
“For most of my adult life, I have been an emotional hit-and- run driver—that is, a reporter. I made people like me, trust me, open their hearts and their minds to me, and cry and bleed on to the pages of my neat little notebooks, and then I went back to a safe place and made a story out of it.”
—Anna Quindlen (b. 1952)