![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc|
Return to index.sgml CVS log | Up to [cvsweb.bsd.lv] / mandoc |
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
31: considerable encumbrance to BSD operating system.
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.1 kristaps 76: <h2>
1.4 ! kristaps 77: snapshotted source
1.1 kristaps 78: </h2>
79:
80: <p>
1.4 ! kristaps 81: CVS sources are checkedout and snapshotted with big updates. These may be found in the <a
1.1 kristaps 82: href="/snapshots/">/snapshots/</a> directory.
83: </p>
84:
85: <p class="boxed">
86: % cd /tmp<br>
1.4 ! kristaps 87: % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
1.1 kristaps 88: % cd mdocml<br>
1.4 ! kristaps 89: % make && make regress && make install
1.1 kristaps 90: </p>
91:
92: <h2>
93: nightly port
94: </h2>
95:
96: <p>
1.4 ! kristaps 97: The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not
1.1 kristaps 98: yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.
1.4 ! kristaps 99: You <span class="emph">must</span> have the ports tree installed.
1.1 kristaps 100: </p>
101:
102: <p class="boxed">
1.4 ! kristaps 103: % sudo pkg_delete mdocml<br>
1.3 kristaps 104: % cd /usr/ports/devel/<br>
1.4 ! kristaps 105: % sudo rm -rf mdocml<br>
! 106: % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | sudo tar -zvxf -<br>
1.1 kristaps 107: % cd mdocml<br>
1.4 ! kristaps 108: % sudo make && sudo make regress && sudo make install
1.1 kristaps 109: </p>
110: </td>
111: </tr>
112: <tr>
113: <td>
114: <h1>
115: CONTACT
116: </h1>
117:
118: <p>
119: Please contact Kristaps, kris<a class="external"
120: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
121: onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
122: '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
123: false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
124: </p>
125:
126: <p>
127: If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
128: checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
129: </p>
130: </td>
131: </tr>
132: <tr>
133: <td>
134: <div class="foot">
1.4 ! kristaps 135: Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/23 16:01:33 $
1.1 kristaps 136: </div>
137: </td>
138: </tr>
139: </tbody>
140: </table>
141: </body>
142: </html>