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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="resource-type" content="document">
<link rel="stylesheet" href="index.css" type="text/css" media="all">
<title>mdocml.bsd.lv</title>
</head>
<body>
<table class="frame" summary="[frame]">
<col width="100%">
<tbody>
<tr>
<td>
<div class="head">
<b>mdocml</b> – mdoc macro compiler
</div>
</td>
</tr>
<tr>
<td valign="top">
<h1>
DESCRIPTION
</h1>
<p>
<span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package
of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX
manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
displaying -mdoc pages whilst providing token support for -man.
</p>
<p>
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix
this (respectively small, C, ISC-licensed, fast and regular).
</p>
<p>
The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may
be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i>
mandoc</i>, which formats manuals for display on the terminal.
</p>
</td>
</tr>
<tr>
<td>
<h1>
SOURCES
</h1>
<p>
Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
systems, tested variously on i386, AMD64, alpha, and others. The most current version is <span
class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a
href="ChangeLog.html">ChangeLog</a> (<a href="ChangeLog.txt">txt</a>) is written with each release.
</p>
<h2>
Current
</h2>
<table width="100%" summary="Current Sources">
<col width="200">
<col>
<tbody>
<tr>
<td>Source archive</td>
<td>
<a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
(<a href="/snapshots/mdocml.md5">md5</a>)
</td>
</tr>
<tr>
<td>Online source</td>
<td>
<a class="external" href="http://bsd.lv/cgi-bin/cvsweb.cgi/?cvsroot=mdocml">cvsweb</a>
</td>
</tr>
</tbody>
</table>
<h2>
Downstream
</h2>
<table width="100%" summary="Downstream Sources">
<col width="200">
<col>
<tbody>
<tr>
<td>DragonFly BSD</td>
<td>
<a href="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
class="external">usr.bin/mandoc</a>
</td>
</tr>
<tr>
<td>FreeBSD</td>
<td>
<a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
class="external">ports/textproc/mdocml</a>
</td>
</tr>
<tr>
<td>NetBSD</td>
<td>
<a href="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
class="external">src/external/bsd/mdocml</a>
</td>
</tr>
<tr>
<td>OpenBSD</td>
<td>
<a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
class="external">src/usr.bin/mandoc</a>
</td>
</tr>
</tbody>
</table>
<h2>
Historical
</h2>
<table width="100%" summary="Archived Sources">
<col width="200">
<col>
<tbody>
<tr>
<td>Source archive</td>
<td>
<a href="/snapshots/">/snapshots/</a>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<h1>
DOCUMENTATION
</h1>
<p>
These manuals are generated automatically and refer to the current snapshot.
</p>
<table width="100%" summary="Documentation">
<col width="200">
<col>
<tbody>
<tr>
<td><a href="mandoc.1.html">mandoc(1)</a> (<a href="mandoc.1.txt">text</a>)</td>
<td>format and display UNIX manuals</td>
</tr>
<tr>
<td><a href="mandoc_char.7.html">mandoc_char(7)</a> (<a href="mandoc_char.7.txt">text</a>)</td>
<td>mandoc special characters</td>
</tr>
<tr>
<td><a href="mdoc.7.html">mdoc(7)</a> (<a href="mdoc.7.txt">text</a>)</td>
<td>mdoc language reference</td>
</tr>
<tr>
<td><a href="man.7.html">man(7)</a> (<a href="man.7.txt">text</a>)</td>
<td>man language reference</td>
</tr>
<tr>
<td><a href="manuals.7.html">manuals(7)</a> (<a href="manuals.7.txt">text</a>)</td>
<td>a guide to writing UNIX manuals</td>
</tr>
<tr>
<td><a href="mdoc.3.html">mdoc(3)</a> (<a href="mdoc.3.txt">text</a>)</td>
<td>mdoc macro compiler library</td>
</tr>
<tr>
<td><a href="man.3.html">man(3)</a> (<a href="man.3.txt">text</a>)</td>
<td>man macro compiler library</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<h1>
CONTACT
</h1>
<p>
For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a
class="external"
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
title="Reveal this e-mail address">...</a>@kth.se.
</p>
<p>
If you want to receive a semi-automated mail-out of new releases, then please write with a message
subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
</p>
</td>
</tr>
<tr>
<td>
<div class="foot">
Copyright © 2008, 2009 Kristaps Džonsons, $Date$
</div>
</td>
</tr>
</tbody>
</table>
</body>
</html>
|
