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