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:
“The Twist was a guided missile, launched from the ghetto into the very heart of suburbia. The Twist succeeded, as politics, religion, and law could never do, in writing in the heart and soul what the Supreme Court could only write on the books.”
—Eldridge Cleaver (b. 1935)
“Duties are not performed for duty’s sake, but because their neglect would make the man uncomfortable. A man performs but one duty—the duty of contenting his spirit, the duty of making himself agreeable to himself.”
—Mark Twain [Samuel Langhorne Clemens] (1835–1910)
“The degree to which the child-rearing professionals continue to be out of touch with reality is astounding. For example, a widely read manual on breast-feeding, devotes fewer than two pages to the working mother.”
—Sylvia Ann Hewitt (20th century)