.Dd $Date: 2014/04/07 21:14:41 $

.Dt MANUALS 7

.Os

.Sh Name

.

.Nm Practical UNIX Manuals

.Nd mdoc: structure, style, and composition

.

.Sh Description

.

So you've written a UNIX utility, library, or driver—or have started writing one—and you want to document your work in a manual. What happens next?

.Pp

Practical UNIX Manuals: mdoc is a guide for writing portable and maintainable UNIX manuals ( manpages ) in the mdoc language.

.Pp

mdoc? Formatters for the language are available by default on all modern UNIX installations and may be downloaded for non-UNIX systems. Furthermore, mdoc annotates content semantically, not presentationally, producing consistent manpages across systems. For an analysis of mdoc and competing formats, refer to Fixing on a Standard Language for UNIX Manuals, published in the USENIX magazine. Why? Formatters for the language are available by default on all modern UNIX installations and may be downloaded for non-UNIX systems. Furthermore,annotates content semantically, not presentationally, producing consistent manpages across systems. For an analysis ofand competing formats, refer to, published in the USENIX magazine.

.Pp

This book is structured first as a series of tutorials, then a guide to best practises: it is not a reference! For that, refer to your local mdoc manual.

.Pp

I also feature the History of UNIX Manpages, which chronicles the development of manpages from the 1960s to the present day.

.

0.1.4 , and date, 07 April 2014. All content licensed under Creative Commons' Attribution Share-Alike : deriving works must attribute the author, Kristaps Dzonsons , and use a similar license. Citations should include the current version,, and date, 07 April 2014.

.

.Sh Practical UNIX Manuals: mdoc

.

.Ss On-line

.Bd -unfilled

.Lk Table of Contents : tree of HTML documents

.Lk Full Text : single HTML document

.Ed

.Ss Off-line

.Bd -unfilled

.Lk Document Tree : archive of HTML tree

.Lk Single Document : archive of HTML document

.Ed

.Sh The History of UNIX Manpages

.

.Ss On-line

.Bd -unfilled

.Lk Full Text : single HTML document

.Ed

.Sh News

.Bl -ohang

.It 07 April 2014, 0.1.4

Polished (editing) text in various places. Cleaned up markup for more variable media. Removed XHTML (of course, it's still used for the ePub) in favour of clean HTML5.

.

.It 02 January 2012, 0.1.3

Added GNU troff archives and edited content in Part 3 as suggested by an outside contributor (thanks!).

.

.It 07 November 2011, 0.1.2

Major addition of the History of UNIX Manpages study. Also moved this page's Table of Contents to its own page (to free up space) and simplified this page. Valuable editorial fixes thanks to an outside contributor: fixed History links and clarified several concepts in the first few chapters among other improvements.

.El

.Lk See cvsweb for old news.

.

.