![[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>
1.13 ! kristaps 27: <span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro
1.9 kristaps 28: package for BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a
1.1 kristaps 29: href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
1.9 kristaps 30: displaying BSD mdoc pages.
31: </p>
32:
33: <p>
1.13 ! kristaps 34: Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs
! 35: slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix
! 36: this (respectively small, C, ISC-licensed, fast and regular).
1.1 kristaps 37: </p>
38:
39: <p>
40: The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
1.13 ! kristaps 41: intermediate-form output from -mdoc input. libmdoc is a simple, fast library operating on memory
! 42: buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on). The primary
! 43: front-end is <span class="man">mandoc(1)</span>, which formats -mdoc manuals for display on the
! 44: terminal.
1.1 kristaps 45: </p>
46:
47: <p>
1.13 ! kristaps 48: The <span class="man">mandoc(1)</span> utility is intended to deprecate usage of <a
! 49: href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying mdoc manuals on the
! 50: terminal.
1.1 kristaps 51: </p>
52:
53: <p>
54: <span class="attn">Please submit patches!</span> Although a significant implementation exists, work
55: remains for the backend library and especially the front-end utilities. See the <a
56: href="#contact">contact</a> information below to submit patches and bug reports.
57: </p>
58: </td>
59: </tr>
60: <tr>
61: <td>
62: <h1>
63: INSTALLING SOURCES
64: </h1>
65:
1.2 kristaps 66: <p>
1.13 ! kristaps 67: Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
! 68: variously on i386, AMD64, Alpha and others.
1.2 kristaps 69: </p>
70:
1.7 kristaps 71: <p>
1.8 kristaps 72: The most current version is <span class="attn">@VERSION@</span>, dated
73: <span class="attn">@VDATE@</span>.
1.7 kristaps 74: </p>
75:
1.1 kristaps 76: <h2>
1.9 kristaps 77: Snapshot source
1.1 kristaps 78: </h2>
79:
80: <p>
1.9 kristaps 81: CVS sources are checkedout and snapshotted with version 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.6 kristaps 89: % make all<br>
90: % make regress<br>
91: # make install
1.1 kristaps 92: </p>
93:
94: <h2>
1.10 kristaps 95: Snapshot port/pkgsrc
1.1 kristaps 96: </h2>
97:
98: <p>
1.12 kristaps 99: The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
100: href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
101: href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a
102: href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, <a
103: href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or <a
104: href="http://www.freebsd.org/ports/">FreeBSD Ports Guide</a> first.
1.1 kristaps 105: </p>
106:
1.10 kristaps 107: <h3>
108: OpenBSD port
109: </h3>
110:
1.1 kristaps 111: <p class="boxed">
1.6 kristaps 112: # pkg_delete mdocml<br>
1.11 kristaps 113: # cd /usr/ports/textproc/<br>
1.6 kristaps 114: # rm -rf mdocml<br>
115: # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
116: # cd mdocml<br>
117: # make build<br>
1.10 kristaps 118: # make install
119: </p>
120:
121: <h3>
122: NetBSD pkgsrc
123: </h3>
124:
125: <p class="boxed">
126: # pkg_delete mdocml<br>
1.11 kristaps 127: # cd /usr/pkgsrc/textproc/<br>
1.10 kristaps 128: # rm -rf mdocml<br>
129: # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br>
130: # cd mdocml<br>
131: # make build<br>
1.6 kristaps 132: # make install
1.1 kristaps 133: </p>
1.12 kristaps 134:
135: <h3>
136: FreeBSD port
137: </h3>
138:
139: <p class="boxed">
140: # pkg_delete mdocml<br>
141: # cd /usr/ports/textproc/<br>
142: # rm -rf mdocml<br>
143: # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>
144: # cd mdocml<br>
145: # make build<br>
146: # make install
147: </p>
1.1 kristaps 148: </td>
149: </tr>
150: <tr>
151: <td>
152: <h1>
153: CONTACT
154: </h1>
155:
156: <p>
157: Please contact Kristaps, kris<a class="external"
158: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
159: onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
160: '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
161: false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
162: </p>
163:
164: <p>
165: If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
166: checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
167: </p>
168: </td>
169: </tr>
170: <tr>
171: <td>
172: <div class="foot">
1.13 ! kristaps 173: Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/03/23 21:46:04 $
1.1 kristaps 174: </div>
175: </td>
176: </tr>
177: </tbody>
178: </table>
179: </body>
180: </html>