![[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>
1.153 ! kristaps 83: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
1.112 kristaps 84: </TD>
85: </TR>
86: <TR>
87: <TD>FreeBSD</TD>
88: <TD>
1.153 ! kristaps 89: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
1.112 kristaps 90: </TD>
91: </TR>
92: <TR>
93: <TD>NetBSD</TD>
94: <TD>
1.153 ! kristaps 95: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
1.112 kristaps 96: </TD>
97: </TR>
98: <TR>
99: <TD>OpenBSD</TD>
100: <TD>
1.153 ! kristaps 101: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
1.112 kristaps 102: </TD>
103: </TR>
1.148 kristaps 104: <TR>
105: <TD>pkgsrc</TD>
106: <TD>
107: <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
108: </TD>
109: </TR>
1.153 ! kristaps 110: <TR>
! 111: <TD>Minix3</TD>
! 112: <TD>
! 113: <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
! 114: </TD>
! 115: </TR>
1.112 kristaps 116: </TBODY>
117: </TABLE>
118: <H1>
1.118 kristaps 119: <A NAME="documentation">Documentation</A>
1.112 kristaps 120: </H1>
121: <P>
1.135 kristaps 122: These manuals are generated automatically and refer to the current release.
123: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 124: </P>
125:
126: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 127: <COL WIDTH="175">
1.112 kristaps 128: <COL>
129: <TBODY>
130: <TR>
1.144 kristaps 131: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 132: <TD VALIGN="top">
1.144 kristaps 133: search the manual page database
134: (<A HREF="apropos.1.txt">text</A> |
135: <A HREF="apropos.1.xhtml">xhtml</A> |
136: <A HREF="apropos.1.pdf">pdf</A> |
137: <A HREF="apropos.1.ps">ps</A>)
1.112 kristaps 138: </TD>
139: </TR>
140: <TR>
1.138 kristaps 141: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 142: <TD VALIGN="top">
1.138 kristaps 143: emit only text of UNIX manuals
144: (<A HREF="demandoc.1.txt">text</A> |
145: <A HREF="demandoc.1.xhtml">xhtml</A> |
146: <A HREF="demandoc.1.pdf">pdf</A> |
147: <A HREF="demandoc.1.ps">ps</A>)
1.114 kristaps 148: </TD>
149: </TR>
150: <TR>
1.144 kristaps 151: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
152: <TD VALIGN="top">
153: format and display UNIX manuals
154: (<A HREF="mandoc.1.txt">text</A> |
155: <A HREF="mandoc.1.xhtml">xhtml</A> |
156: <A HREF="mandoc.1.pdf">pdf</A> |
157: <A HREF="mandoc.1.ps">ps</A>)
158: </TD>
159: </TR>
160: <TR>
1.120 kristaps 161: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
162: <TD VALIGN="top">
163: recode multibyte UNIX manuals
164: (<A HREF="preconv.1.txt">text</A> |
165: <A HREF="preconv.1.xhtml">xhtml</A> |
166: <A HREF="preconv.1.pdf">pdf</A> |
1.136 kristaps 167: <A HREF="preconv.1.ps">ps</A>)
1.120 kristaps 168: </TD>
169: </TR>
170: <TR>
1.149 kristaps 171: <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>
172: <TD VALIGN="top">
173: search the manual page database
174: (<A HREF="whatis.1.txt">text</A> |
175: <A HREF="whatis.1.xhtml">xhtml</A> |
176: <A HREF="whatis.1.pdf">pdf</A> |
177: <A HREF="whatis.1.ps">ps</A>)
178: </TD>
179: </TR>
180: <TR>
1.112 kristaps 181: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
182: <TD VALIGN="top">
183: mandoc macro compiler library
184: (<A HREF="mandoc.3.txt">text</A> |
185: <A HREF="mandoc.3.xhtml">xhtml</A> |
186: <A HREF="mandoc.3.pdf">pdf</A> |
1.136 kristaps 187: <A HREF="mandoc.3.ps">ps</A>)
1.112 kristaps 188: </TD>
189: </TR>
190: <TR>
191: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
192: <TD VALIGN="top">
193: man language reference
194: (<A HREF="man.7.txt">text</A> |
195: <A HREF="man.7.xhtml">xhtml</A> |
196: <A HREF="man.7.pdf">pdf</A> |
1.136 kristaps 197: <A HREF="man.7.ps">ps</A>)
1.112 kristaps 198: </TD>
199: </TR>
200: <TR>
1.150 kristaps 201: <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
202: <TD VALIGN="top">
203: cgi for manpage query and display
204: (<A HREF="man.cgi.7.txt">text</A> |
205: <A HREF="man.cgi.7.xhtml">xhtml</A> |
206: <A HREF="man.cgi.7.pdf">pdf</A> |
207: <A HREF="man.cgi.7.ps">ps</A>)
208: </TD>
209: </TR>
210: <TR>
1.112 kristaps 211: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
212: <TD VALIGN="top">
213: eqn-mandoc language reference
214: (<A HREF="eqn.7.txt">text</A> |
215: <A HREF="eqn.7.xhtml">xhtml</A> |
216: <A HREF="eqn.7.pdf">pdf</A> |
1.136 kristaps 217: <A HREF="eqn.7.ps">ps</A>)
1.112 kristaps 218: </TD>
219: </TR>
220: <TR>
221: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
222: <TD VALIGN="top">
223: mandoc special characters
224: (<A HREF="mandoc_char.7.txt">text</A> |
225: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
226: <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136 kristaps 227: <A HREF="mandoc_char.7.ps">ps</A>)
1.112 kristaps 228: </TD>
229: </TR>
230: <TR>
231: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
232: <TD VALIGN="top">
233: mdoc language reference
234: (<A HREF="mdoc.7.txt">text</A> |
235: <A HREF="mdoc.7.xhtml">xhtml</A> |
236: <A HREF="mdoc.7.pdf">pdf</A> |
1.136 kristaps 237: <A HREF="mdoc.7.ps">ps</A>)
1.112 kristaps 238: </TD>
239: </TR>
240: <TR>
241: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
242: <TD VALIGN="top">
243: roff-mandoc language reference
244: (<A HREF="roff.7.txt">text</A> |
245: <A HREF="roff.7.xhtml">xhtml</A> |
246: <A HREF="roff.7.pdf">pdf</A> |
1.136 kristaps 247: <A HREF="roff.7.ps">ps</A>)
1.112 kristaps 248: </TD>
249: </TR>
250: <TR>
251: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
252: <TD VALIGN="top">
253: tbl-mandoc language reference
254: (<A HREF="tbl.7.txt">text</A> |
255: <A HREF="tbl.7.xhtml">xhtml</A> |
256: <A HREF="tbl.7.pdf">pdf</A> |
1.136 kristaps 257: <A HREF="tbl.7.ps">ps</A>)
1.112 kristaps 258: </TD>
259: </TR>
1.138 kristaps 260: <TR>
1.150 kristaps 261: <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>
262: <TD VALIGN="top">
263: update a man.cgi manpage cache
264: (<A HREF="catman.8.txt">text</A> |
265: <A HREF="catman.8.xhtml">xhtml</A> |
266: <A HREF="catman.8.pdf">pdf</A> |
267: <A HREF="catman.8.ps">ps</A>)
268: </TD>
269: </TR>
270: <TR>
1.138 kristaps 271: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
272: <TD VALIGN="top">
273: index UNIX manuals
274: (<A HREF="mandocdb.8.txt">text</A> |
275: <A HREF="mandocdb.8.xhtml">xhtml</A> |
276: <A HREF="mandocdb.8.pdf">pdf</A> |
277: <A HREF="mandocdb.8.ps">ps</A>)
278: </TD>
279: </TR>
1.112 kristaps 280: </TBODY>
281: </TABLE>
282: <H1>
1.118 kristaps 283: <A NAME="contact">Contact</A>
1.112 kristaps 284: </H1>
285: <P>
1.139 kristaps 286: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 287: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 288: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
289: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149 kristaps 290: this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112 kristaps 291: </P>
292: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 293: <COL WIDTH="175">
1.112 kristaps 294: <COL>
295: <TBODY>
296: <TR>
297: <TD>
298: disc<A CLASS="external" TITLE="Reveal this e-mail address"
299: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
300: </TD>
301: <TD>
302: bug-reports, general questions, and announcements
303: </TD>
304: </TR>
305: <TR>
306: <TD>
307: tec<A CLASS="external" TITLE="Reveal this e-mail address"
308: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
309: </TD>
310: <TD>
311: patches and system discussions
312: </TD>
313: </TR>
314: <TR>
315: <TD>
316: sou<A CLASS="external" TITLE="Reveal this e-mail address"
317: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
318: </TD>
319: <TD>
320: source commit messages
321: </TD>
322: </TR>
323: </TBODY>
324: </TABLE>
325: <H1>
1.118 kristaps 326: <A NAME="news">News</A>
1.112 kristaps 327: </H1>
1.124 kristaps 328: <P CLASS="news">
1.152 kristaps 329: 23-03-2011: version 1.12.1
1.149 kristaps 330: </P>
331: <P>
332: Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are
1.152 kristaps 333: now much more robust.
334: A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.
335: These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility
336: such as GNU troff.
1.150 kristaps 337: </P>
338: <P>
339: The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A
340: HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated
341: on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.
1.149 kristaps 342: </P>
1.151 kristaps 343: <P>
1.152 kristaps 344: The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"
1.151 kristaps 345: HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"
346: CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"
347: CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.
348: </P>
1.142 kristaps 349: <P>
1.152 kristaps 350: Lastly, I'm no longer providing binaries, as nobody has asked for them.
1.141 schwarze 351: </P>
1.112 kristaps 352: <P>
353: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
354: historical notes.
355: </P>
356: <P CLASS="foot">
1.118 kristaps 357: <SMALL>
358: Copyright © 2008–2011
359: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.153 ! kristaps 360: $Date: 2012/03/24 01:54:43 $
1.118 kristaps 361: </SMALL>
1.112 kristaps 362: </P>
1.40 kristaps 363: </BODY>
364: </HTML>