-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.xml
113 lines (113 loc) · 4.65 KB
/
index.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="initial-scale=1.0, user-scalable=no" />
<meta charset="utf-8" />
<link rel="stylesheet" href="css/index.css" />
<title>Practical UNIX Manuals: mdoc</title>
</head>
<body>
<div>
<div>.Dd $Date$</div>
<div>.Dt MANUALS 7</div>
<div>.Os</div>
<div><span>.Sh</span><span class="h1">Name</span></div>
<div>.</div>
<div><span>.Nm</span><span>Practical UNIX Manuals</span></div>
<div><span>.Nd</span><span><i>mdoc</i>: structure, style, and composition</span></div>
<div><span>.\"</span><span><small>(Quick Download: <a href="mdoc.epub">ePub</a> | View: <a href="mdoc.html">HTML</a>)</small>
</span></div>
<div>.</div>
<div><span>.Sh</span><span class="h1">Description</span></div>
<div>.</div>
<div>
<div>
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?
</div>
</div>
<div>.Pp</div>
<div>
<div>
<i>Practical UNIX Manuals: mdoc</i> is a guide for writing portable and maintainable UNIX manuals
(<q>manpages</q>) in the <i>mdoc</i> language.
</div>
</div>
<div>.Pp</div>
<div>
<div>
Why <i>mdoc</i>?
Formatters for the language are available by default on all modern UNIX installations and may be downloaded for
non-UNIX systems.
Furthermore, <i>mdoc</i> annotates content semantically, not presentationally, producing consistent manpages
across systems.
For an analysis of <i>mdoc</i> and competing formats, refer to
<i><a class="external" href="http://www.usenix.org/publications/login/2009-10/pdfs/dzonsons.pdf">Fixing on a
Standard Language for UNIX Manuals</a></i>, published in the USENIX magazine.
</div>
</div>
<div>.Pp</div>
<div>
<div>
This book is structured first as a series of tutorials, then a guide to best practises: it is
<b>not</b> a reference! For that, refer to your local <i>mdoc</i> manual.
</div>
</div>
<div>.Pp</div>
<div>
<div>
I also feature the <i>History of UNIX Manpages</i>, which chronicles the development of manpages from the 1960s
to the present day.
</div>
</div>
<div>.</div>
<div>
<div>
<a href="http://creativecommons.org/licenses/by-sa/3.0/"><img src="license.png" ALT="CC BY-SA" /></a>
</div>
<div>
All content licensed under Creative Commons' <a class="external"
href="http://creativecommons.org/licenses/by-sa/3.0/">Attribution Share-Alike</a>: deriving works must
attribute the author, <a class="external" href="http://kristaps.bsd.lv">Kristaps Dzonsons</a>, and use a similar license.
Citations should include the current version, <span class="ver">@VERSION@</span>, and date, @DATE@.
</div>
</div>
<div>.</div>
<div><span>.Sh</span><span id="mdoc" class="h1">Practical UNIX Manuals: <i>mdoc</i></span></div>
<div>.</div>
<div><span>.Ss</span><span class="h2">On-line</span></div>
<div>.Bd -unfilled</div>
<div><span>.Lk</span><span><a href="toc.html">Table of Contents</a>: tree of HTML documents</span></div>
<div><span>.Lk</span><span><a href="mdoc.html">Full Text</a>: single HTML document</span></div>
<div>.Ed</div>
<div><span>.Ss</span><span class="h2">Off-line</span></div>
<div>.Bd -unfilled</div>
<div><span>.Lk</span><span><a href="mdoc.epub">e-Book</a>: e-Pub 2.0.1 archive</span></div>
<div><span>.Lk</span><span><a href="mdoc.multi-html.tgz">Document Tree</a>: archive of HTML tree</span></div>
<div><span>.Lk</span><span><a href="mdoc.single-html.tgz">Single Document</a>: archive of HTML document</span></div>
<div>.Ed</div>
<div><span>.Sh</span><span id="history" class="h1">The History of UNIX Manpages</span></div>
<div>.</div>
<div><span>.Ss</span><span class="h2">On-line</span></div>
<div>.Bd -unfilled</div>
<div><span>.Lk</span><span><a href="history.html">Full Text</a>: single HTML document</span></div>
<div>.Ed</div>
<div><span>.Sh</span><span class="h1">News</span></div>
<div>.Bl -ohang</div>
<nav data-sblg-nav="1" data-sblg-navcontent="1">
<div><span>.It</span><span>${sblg-date}, <span class="ver">${sblg-title}</span></span></div>
<div>
<div>
${sblg-aside}
</div>
</div>
<div>.</div>
</nav>
<div>.El</div>
<div><span>.Lk</span><span>See <a href="/cgi-bin/cvsweb/index.sgml?cvsroot=manpages">cvsweb</a> for old news.</span></div>
<div>.</div>
<div>.</div>
<div><span>.\"</span><span id="copy">© 2010–2011, 2014, 2016, <a href="http://kristaps.bsd.lv">Kristaps Dzonsons</a></span></div>
</div>
</body>
</html>