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
|
<!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="style.css" type="text/css" media="all">
<title>mdocml.bsd.lv</title>
</head>
<body>
<table width="600">
<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 <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a
href="man.7.txt" class="man">man(7)</a>.
</p>
<p>
What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.
</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> are the <a href="man.3.txt" class="man">man(3)</a> and <a
href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form
output from -man or -mdoc input. 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).
</p>
<p>
The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for
display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a
limited extent, -man manuals on the terminal.
</p>
<p>
<span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant
implementation exists, work remains for the backend library and especially the front-end utilities. See
the <a href="#contact">contact</a> information below for submissions.
</p>
</td>
</tr>
<tr>
<td>
<h1>
INSTALLING SOURCES
</h1>
<p>
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
variously on i386, AMD64, alpha and others.
</p>
<p>
The most current version is <span class="attn">@VERSION@</span>, dated
<span class="attn">@VDATE@</span>.
</p>
<h2>
Snapshot source
</h2>
<p>
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a
href="/snapshots/">/snapshots/</a> directory.
</p>
<p class="boxed">
% cd /tmp<br>
% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">
http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br>
% cd mdocml<br>
% make all<br>
% make regress<br>
# make install
</p>
<h2>
Snapshot port/pkgsrc
</h2>
<p>
The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external"
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
class="external"
href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
guide</a>, first.
</p>
<h3>
OpenBSD port
</h3>
<p class="boxed">
# pkg_delete mdocml<br>
# cd /usr/ports/textproc/<br>
# rm -rf mdocml<br>
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">
http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
# cd mdocml<br>
# make build<br>
# make install
</p>
<h3>
NetBSD pkgsrc
</h3>
<p class="boxed">
# pkg_delete mdocml<br>
# cd /usr/pkgsrc/textproc/<br>
# rm -rf mdocml<br>
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">
http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
# cd mdocml<br>
# make build<br>
# make install
</p>
<h3>
FreeBSD port
</h3>
<p class="boxed">
# pkg_delete -x mdocml<br>
# cd /tmp<br>
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">
http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>
# cd mdocml<br>
# make<br>
# make install
</p>
</td>
</tr>
<tr>
<td>
<h1>
CONTACT
</h1>
<p>
Please contact Kristaps, kris<a class="external"
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so
on.
</p>
<p>
If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
</p>
</td>
</tr>
<tr>
<td>
<div class="foot">
Copyright © 2008, 2009 Kristaps Džonsons, $Date$
</div>
</td>
</tr>
</tbody>
</table>
</body>
</html>
|
