![[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">
1.40 kristaps 2: <HTML>
3: <HEAD>
4: <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
5: <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
1.149 kristaps 6: <TITLE>mdocml | UNIX manpage compiler</TITLE>
1.40 kristaps 7: </HEAD>
8: <BODY>
1.112 kristaps 9: <P CLASS="head">
1.149 kristaps 10: <B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
1.136 kristaps 11: </P>
12: <P CLASS="subhead">
13: Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
14: <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
15: (<A HREF="/snapshots/">archives</A>)
1.112 kristaps 16: </P>
17: <H1>
1.118 kristaps 18: <A NAME="description">Description</A>
1.112 kristaps 19: </H1>
20: <P>
21: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
22: package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
23: UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
24: HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
25: pages whilst providing token support for <I>man</I>.
26: </P>
27: <P>
28: Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs slowly, produces
29: uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A
30: CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
31: </P>
32: <P>
33: <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121 kristaps 34: HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
35: support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.138 kristaps 36: It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
37: <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
1.144 kristaps 38: <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
1.150 kristaps 39: <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
40: <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
1.121 kristaps 41: It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112 kristaps 42: </P>
43: <P>
44: <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
45: </P>
1.137 kristaps 46: <H2>
1.118 kristaps 47: <A NAME="sources">Sources</A>
1.137 kristaps 48: </H2>
1.112 kristaps 49: <P>
1.145 kristaps 50: <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
51: need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
1.150 kristaps 52: HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A
53: HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
54: systems — see the <I>Makefile</I> if you're running Linux). To build and install into <I>/usr/local/</I>, just
55: run <CODE>make install</CODE>. Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are
56: usually taken by existing utilities.
1.132 kristaps 57: </P>
1.137 kristaps 58: <H2>
1.135 kristaps 59: <A NAME="binaries">Binaries</A>
1.137 kristaps 60: </H2>
1.132 kristaps 61: <P>
1.135 kristaps 62: Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
63: Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
64: Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
65: 64-bit (x86_64) architectures.
1.121 kristaps 66: </P>
1.137 kristaps 67: <H2>
1.112 kristaps 68: Downstream
1.137 kristaps 69: </H2>
1.135 kristaps 70: <P>
71: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
72: If your system does not appear below, the maintainers have not contacted me and it should not be considered
73: <Q>official</Q>.
74: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
75: </P>
1.112 kristaps 76: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 77: <COL WIDTH="175">
1.112 kristaps 78: <COL>
79: <TBODY>
80: <TR>
81: <TD>DragonFly BSD</TD>
82: <TD>
83: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
84: CLASS="external">usr.bin/mandoc</A>
85: </TD>
86: </TR>
87: <TR>
88: <TD>FreeBSD</TD>
89: <TD>
90: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
91: CLASS="external">ports/textproc/mdocml</A>
92: </TD>
93: </TR>
94: <TR>
95: <TD>NetBSD</TD>
96: <TD>
97: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
98: CLASS="external">src/external/bsd/mdocml</A>
99: </TD>
100: </TR>
101: <TR>
102: <TD>OpenBSD</TD>
103: <TD>
104: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
105: CLASS="external">src/usr.bin/mandoc</A>
106: </TD>
107: </TR>
1.148 kristaps 108: <TR>
109: <TD>pkgsrc</TD>
110: <TD>
111: <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
112: </TD>
113: </TR>
1.112 kristaps 114: </TBODY>
115: </TABLE>
116: <H1>
1.118 kristaps 117: <A NAME="documentation">Documentation</A>
1.112 kristaps 118: </H1>
119: <P>
1.135 kristaps 120: These manuals are generated automatically and refer to the current release.
121: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 122: </P>
123:
124: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 125: <COL WIDTH="175">
1.112 kristaps 126: <COL>
127: <TBODY>
128: <TR>
1.144 kristaps 129: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 130: <TD VALIGN="top">
1.144 kristaps 131: search the manual page database
132: (<A HREF="apropos.1.txt">text</A> |
133: <A HREF="apropos.1.xhtml">xhtml</A> |
134: <A HREF="apropos.1.pdf">pdf</A> |
135: <A HREF="apropos.1.ps">ps</A>)
1.112 kristaps 136: </TD>
137: </TR>
138: <TR>
1.138 kristaps 139: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 140: <TD VALIGN="top">
1.138 kristaps 141: emit only text of UNIX manuals
142: (<A HREF="demandoc.1.txt">text</A> |
143: <A HREF="demandoc.1.xhtml">xhtml</A> |
144: <A HREF="demandoc.1.pdf">pdf</A> |
145: <A HREF="demandoc.1.ps">ps</A>)
1.114 kristaps 146: </TD>
147: </TR>
148: <TR>
1.144 kristaps 149: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
150: <TD VALIGN="top">
151: format and display UNIX manuals
152: (<A HREF="mandoc.1.txt">text</A> |
153: <A HREF="mandoc.1.xhtml">xhtml</A> |
154: <A HREF="mandoc.1.pdf">pdf</A> |
155: <A HREF="mandoc.1.ps">ps</A>)
156: </TD>
157: </TR>
158: <TR>
1.120 kristaps 159: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
160: <TD VALIGN="top">
161: recode multibyte UNIX manuals
162: (<A HREF="preconv.1.txt">text</A> |
163: <A HREF="preconv.1.xhtml">xhtml</A> |
164: <A HREF="preconv.1.pdf">pdf</A> |
1.136 kristaps 165: <A HREF="preconv.1.ps">ps</A>)
1.120 kristaps 166: </TD>
167: </TR>
168: <TR>
1.149 kristaps 169: <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>
170: <TD VALIGN="top">
171: search the manual page database
172: (<A HREF="whatis.1.txt">text</A> |
173: <A HREF="whatis.1.xhtml">xhtml</A> |
174: <A HREF="whatis.1.pdf">pdf</A> |
175: <A HREF="whatis.1.ps">ps</A>)
176: </TD>
177: </TR>
178: <TR>
1.112 kristaps 179: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
180: <TD VALIGN="top">
181: mandoc macro compiler library
182: (<A HREF="mandoc.3.txt">text</A> |
183: <A HREF="mandoc.3.xhtml">xhtml</A> |
184: <A HREF="mandoc.3.pdf">pdf</A> |
1.136 kristaps 185: <A HREF="mandoc.3.ps">ps</A>)
1.112 kristaps 186: </TD>
187: </TR>
188: <TR>
189: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
190: <TD VALIGN="top">
191: man language reference
192: (<A HREF="man.7.txt">text</A> |
193: <A HREF="man.7.xhtml">xhtml</A> |
194: <A HREF="man.7.pdf">pdf</A> |
1.136 kristaps 195: <A HREF="man.7.ps">ps</A>)
1.112 kristaps 196: </TD>
197: </TR>
198: <TR>
1.150 kristaps 199: <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
200: <TD VALIGN="top">
201: cgi for manpage query and display
202: (<A HREF="man.cgi.7.txt">text</A> |
203: <A HREF="man.cgi.7.xhtml">xhtml</A> |
204: <A HREF="man.cgi.7.pdf">pdf</A> |
205: <A HREF="man.cgi.7.ps">ps</A>)
206: </TD>
207: </TR>
208: <TR>
1.112 kristaps 209: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
210: <TD VALIGN="top">
211: eqn-mandoc language reference
212: (<A HREF="eqn.7.txt">text</A> |
213: <A HREF="eqn.7.xhtml">xhtml</A> |
214: <A HREF="eqn.7.pdf">pdf</A> |
1.136 kristaps 215: <A HREF="eqn.7.ps">ps</A>)
1.112 kristaps 216: </TD>
217: </TR>
218: <TR>
219: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
220: <TD VALIGN="top">
221: mandoc special characters
222: (<A HREF="mandoc_char.7.txt">text</A> |
223: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
224: <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136 kristaps 225: <A HREF="mandoc_char.7.ps">ps</A>)
1.112 kristaps 226: </TD>
227: </TR>
228: <TR>
229: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
230: <TD VALIGN="top">
231: mdoc language reference
232: (<A HREF="mdoc.7.txt">text</A> |
233: <A HREF="mdoc.7.xhtml">xhtml</A> |
234: <A HREF="mdoc.7.pdf">pdf</A> |
1.136 kristaps 235: <A HREF="mdoc.7.ps">ps</A>)
1.112 kristaps 236: </TD>
237: </TR>
238: <TR>
239: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
240: <TD VALIGN="top">
241: roff-mandoc language reference
242: (<A HREF="roff.7.txt">text</A> |
243: <A HREF="roff.7.xhtml">xhtml</A> |
244: <A HREF="roff.7.pdf">pdf</A> |
1.136 kristaps 245: <A HREF="roff.7.ps">ps</A>)
1.112 kristaps 246: </TD>
247: </TR>
248: <TR>
249: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
250: <TD VALIGN="top">
251: tbl-mandoc language reference
252: (<A HREF="tbl.7.txt">text</A> |
253: <A HREF="tbl.7.xhtml">xhtml</A> |
254: <A HREF="tbl.7.pdf">pdf</A> |
1.136 kristaps 255: <A HREF="tbl.7.ps">ps</A>)
1.112 kristaps 256: </TD>
257: </TR>
1.138 kristaps 258: <TR>
1.150 kristaps 259: <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>
260: <TD VALIGN="top">
261: update a man.cgi manpage cache
262: (<A HREF="catman.8.txt">text</A> |
263: <A HREF="catman.8.xhtml">xhtml</A> |
264: <A HREF="catman.8.pdf">pdf</A> |
265: <A HREF="catman.8.ps">ps</A>)
266: </TD>
267: </TR>
268: <TR>
1.138 kristaps 269: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
270: <TD VALIGN="top">
271: index UNIX manuals
272: (<A HREF="mandocdb.8.txt">text</A> |
273: <A HREF="mandocdb.8.xhtml">xhtml</A> |
274: <A HREF="mandocdb.8.pdf">pdf</A> |
275: <A HREF="mandocdb.8.ps">ps</A>)
276: </TD>
277: </TR>
1.112 kristaps 278: </TBODY>
279: </TABLE>
280: <H1>
1.118 kristaps 281: <A NAME="contact">Contact</A>
1.112 kristaps 282: </H1>
283: <P>
1.139 kristaps 284: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 285: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 286: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
287: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149 kristaps 288: this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112 kristaps 289: </P>
290: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 291: <COL WIDTH="175">
1.112 kristaps 292: <COL>
293: <TBODY>
294: <TR>
295: <TD>
296: disc<A CLASS="external" TITLE="Reveal this e-mail address"
297: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
298: </TD>
299: <TD>
300: bug-reports, general questions, and announcements
301: </TD>
302: </TR>
303: <TR>
304: <TD>
305: tec<A CLASS="external" TITLE="Reveal this e-mail address"
306: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
307: </TD>
308: <TD>
309: patches and system discussions
310: </TD>
311: </TR>
312: <TR>
313: <TD>
314: sou<A CLASS="external" TITLE="Reveal this e-mail address"
315: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
316: </TD>
317: <TD>
318: source commit messages
319: </TD>
320: </TR>
321: </TBODY>
322: </TABLE>
323: <H1>
1.118 kristaps 324: <A NAME="news">News</A>
1.112 kristaps 325: </H1>
1.124 kristaps 326: <P CLASS="news">
1.152 ! kristaps 327: 23-03-2011: version 1.12.1
1.149 kristaps 328: </P>
329: <P>
330: Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are
1.152 ! kristaps 331: now much more robust.
! 332: A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.
! 333: These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility
! 334: such as GNU troff.
1.150 kristaps 335: </P>
336: <P>
337: The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A
338: HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated
339: on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.
1.149 kristaps 340: </P>
1.151 kristaps 341: <P>
1.152 ! kristaps 342: The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"
1.151 kristaps 343: HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"
344: CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"
345: CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.
346: </P>
1.142 kristaps 347: <P>
1.152 ! kristaps 348: Lastly, I'm no longer providing binaries, as nobody has asked for them.
1.141 schwarze 349: </P>
1.112 kristaps 350: <P>
351: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
352: historical notes.
353: </P>
354: <P CLASS="foot">
1.118 kristaps 355: <SMALL>
356: Copyright © 2008–2011
357: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.152 ! kristaps 358: $Date: 2011/12/14 23:17:12 $
1.118 kristaps 359: </SMALL>
1.112 kristaps 360: </P>
1.40 kristaps 361: </BODY>
362: </HTML>