NetBSD Lintified.
[mandoc.git] / index.sgml
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <meta name="resource-type" content="document">
6 <link rel="stylesheet" href="style.css" type="text/css" media="all">
7 <title>mdocml.bsd.lv</title>
8 </head>
9 <body>
10 <table width="600">
11 <col width="100%">
12 <tbody>
13 <tr>
14 <td>
15 <div class="head">
16 <b>mdocml</b> &#8211; mdoc macro compiler
17 </div>
18 </td>
19 </tr>
20 <tr>
21 <td valign="top">
22 <h1>
23 DESCRIPTION
24 </h1>
25
26 <p>
27 <span class="nm">mdocml</span> is a suite of tools that compile &#8220;mdoc&#8221;, the roff macro
28 package of the BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a
29 href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
30 displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a
31 considerable encumbrance to BSD operating systems.
32 </p>
33
34 <p>
35 The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
36 intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers
37 of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span
38 class="man">mdoc(3)</span> reference manual.
39 </p>
40
41 <p>
42 There are three utilities implementing <span class="man">mdoc(3)</span>:
43 </p>
44
45 <ul>
46 <li><span class="man">mdocterm(1)</span> &#8211; formats mdoc input for display on the terminal
47 <li><span class="man">mdochtml(1)</span> &#8211; formats mdoc input as strict HTML (nascent)
48 <li><span class="man">mdoclint(1)</span> &#8211; validates mdoc input
49 <li><span class="man">mdoctree(1)</span> &#8211; prints input abstract syntax tree
50 </ul>
51
52 <p>
53 The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a
54 href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the
55 terminal, either directly or cached as a &#8220;catman&#8221; page.
56 </p>
57
58 <p>
59 <span class="attn">Please submit patches!</span> Although a significant implementation exists, work
60 remains for the backend library and especially the front-end utilities. See the <a
61 href="#contact">contact</a> information below to submit patches and bug reports.
62 </p>
63 </td>
64 </tr>
65 <tr>
66 <td>
67 <h1>
68 INSTALLING SOURCES
69 </h1>
70
71 <p>
72 Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on
73 i386, AMD64 and Alpha.
74 </p>
75
76 <h2>
77 snapshotted source
78 </h2>
79
80 <p>
81 CVS sources are checkedout and snapshotted with big updates. These may be found in the <a
82 href="/snapshots/">/snapshots/</a> directory.
83 </p>
84
85 <p class="boxed">
86 % cd /tmp<br>
87 % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
88 % cd mdocml<br>
89 % make all<br>
90 % make regress<br>
91 # make install
92 </p>
93
94 <h2>
95 nightly port
96 </h2>
97
98 <p>
99 The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not
100 yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.
101 You <span class="emph">must</span> have the ports tree installed.
102 </p>
103
104 <p class="boxed">
105 # pkg_delete mdocml<br>
106 # cd /usr/ports/devel/<br>
107 # rm -rf mdocml<br>
108 # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
109 # cd mdocml<br>
110 # make build<br>
111 # make regress<br>
112 # make install
113 </p>
114 </td>
115 </tr>
116 <tr>
117 <td>
118 <h1>
119 CONTACT
120 </h1>
121
122 <p>
123 Please contact Kristaps, kris<a class="external"
124 href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
125 onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',
126 '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
127 false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
128 </p>
129
130 <p>
131 If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
132 checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
133 </p>
134 </td>
135 </tr>
136 <tr>
137 <td>
138 <div class="foot">
139 Copyright &#169; 2009 Kristaps D&#382;onsons, $Date: 2009/02/25 12:32:50 $
140 </div>
141 </td>
142 </tr>
143 </tbody>
144 </table>
145 </body>
146 </html>