Annotation of mandoc/index.sgml, Revision 1.8
1.1 kristaps 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> – 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 “mdoc”, 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
1.5 kristaps 31: considerable encumbrance to BSD operating systems.
1.1 kristaps 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> – formats mdoc input for display on the terminal
47: <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent)
48: <li><span class="man">mdoclint(1)</span> – validates mdoc input
49: <li><span class="man">mdoctree(1)</span> – 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 “catman” 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:
1.2 kristaps 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:
1.7 kristaps 76: <p>
1.8 ! kristaps 77: The most current version is <span class="attn">@VERSION@</span>, dated
! 78: <span class="attn">@VDATE@</span>.
1.7 kristaps 79: </p>
80:
1.1 kristaps 81: <h2>
1.4 kristaps 82: snapshotted source
1.1 kristaps 83: </h2>
84:
85: <p>
1.4 kristaps 86: CVS sources are checkedout and snapshotted with big updates. These may be found in the <a
1.1 kristaps 87: href="/snapshots/">/snapshots/</a> directory.
88: </p>
89:
90: <p class="boxed">
91: % cd /tmp<br>
1.4 kristaps 92: % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
1.1 kristaps 93: % cd mdocml<br>
1.6 kristaps 94: % make all<br>
95: % make regress<br>
96: # make install
1.1 kristaps 97: </p>
98:
99: <h2>
100: nightly port
101: </h2>
102:
103: <p>
1.4 kristaps 104: The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not
1.1 kristaps 105: yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.
1.4 kristaps 106: You <span class="emph">must</span> have the ports tree installed.
1.1 kristaps 107: </p>
108:
109: <p class="boxed">
1.6 kristaps 110: # pkg_delete mdocml<br>
111: # cd /usr/ports/devel/<br>
112: # rm -rf mdocml<br>
113: # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
114: # cd mdocml<br>
115: # make build<br>
116: # make regress<br>
117: # make install
1.1 kristaps 118: </p>
119: </td>
120: </tr>
121: <tr>
122: <td>
123: <h1>
124: CONTACT
125: </h1>
126:
127: <p>
128: Please contact Kristaps, kris<a class="external"
129: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
130: onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
131: '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
132: false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
133: </p>
134:
135: <p>
136: If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
137: checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
138: </p>
139: </td>
140: </tr>
141: <tr>
142: <td>
143: <div class="foot">
1.8 ! kristaps 144: Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/25 12:37:18 $
1.1 kristaps 145: </div>
146: </td>
147: </tr>
148: </tbody>
149: </table>
150: </body>
151: </html>
CVSweb