Annotation of mandoc/index.sgml, Revision 1.157
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
1.155 kristaps 40: <A HREF="man.cgi.7.html">man.cgi</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.156 kristaps 50: <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
51: HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A>, <A
52: HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
53: To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
54: Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
1.132 kristaps 55: </P>
1.137 kristaps 56: <H2>
1.112 kristaps 57: Downstream
1.137 kristaps 58: </H2>
1.135 kristaps 59: <P>
60: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
61: If your system does not appear below, the maintainers have not contacted me and it should not be considered
62: <Q>official</Q>.
63: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
64: </P>
1.112 kristaps 65: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 66: <COL WIDTH="175">
1.112 kristaps 67: <COL>
68: <TBODY>
69: <TR>
70: <TD>DragonFly BSD</TD>
71: <TD>
1.153 kristaps 72: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
1.112 kristaps 73: </TD>
74: </TR>
75: <TR>
76: <TD>FreeBSD</TD>
77: <TD>
1.153 kristaps 78: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
1.112 kristaps 79: </TD>
80: </TR>
81: <TR>
82: <TD>NetBSD</TD>
83: <TD>
1.153 kristaps 84: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
1.112 kristaps 85: </TD>
86: </TR>
87: <TR>
88: <TD>OpenBSD</TD>
89: <TD>
1.153 kristaps 90: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
1.112 kristaps 91: </TD>
92: </TR>
1.148 kristaps 93: <TR>
94: <TD>pkgsrc</TD>
95: <TD>
96: <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
97: </TD>
98: </TR>
1.153 kristaps 99: <TR>
100: <TD>Minix3</TD>
101: <TD>
102: <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
103: </TD>
104: </TR>
1.112 kristaps 105: </TBODY>
106: </TABLE>
107: <H1>
1.118 kristaps 108: <A NAME="documentation">Documentation</A>
1.112 kristaps 109: </H1>
110: <P>
1.135 kristaps 111: These manuals are generated automatically and refer to the current release.
112: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 113: </P>
114:
115: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 116: <COL WIDTH="175">
1.112 kristaps 117: <COL>
118: <TBODY>
119: <TR>
1.144 kristaps 120: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 121: <TD VALIGN="top">
1.144 kristaps 122: search the manual page database
123: (<A HREF="apropos.1.txt">text</A> |
124: <A HREF="apropos.1.xhtml">xhtml</A> |
125: <A HREF="apropos.1.pdf">pdf</A> |
126: <A HREF="apropos.1.ps">ps</A>)
1.112 kristaps 127: </TD>
128: </TR>
129: <TR>
1.138 kristaps 130: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 131: <TD VALIGN="top">
1.138 kristaps 132: emit only text of UNIX manuals
133: (<A HREF="demandoc.1.txt">text</A> |
134: <A HREF="demandoc.1.xhtml">xhtml</A> |
135: <A HREF="demandoc.1.pdf">pdf</A> |
136: <A HREF="demandoc.1.ps">ps</A>)
1.114 kristaps 137: </TD>
138: </TR>
139: <TR>
1.144 kristaps 140: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
141: <TD VALIGN="top">
142: format and display UNIX manuals
143: (<A HREF="mandoc.1.txt">text</A> |
144: <A HREF="mandoc.1.xhtml">xhtml</A> |
145: <A HREF="mandoc.1.pdf">pdf</A> |
146: <A HREF="mandoc.1.ps">ps</A>)
147: </TD>
148: </TR>
149: <TR>
1.120 kristaps 150: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
151: <TD VALIGN="top">
152: recode multibyte UNIX manuals
153: (<A HREF="preconv.1.txt">text</A> |
154: <A HREF="preconv.1.xhtml">xhtml</A> |
155: <A HREF="preconv.1.pdf">pdf</A> |
1.136 kristaps 156: <A HREF="preconv.1.ps">ps</A>)
1.120 kristaps 157: </TD>
158: </TR>
159: <TR>
1.112 kristaps 160: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
161: <TD VALIGN="top">
162: mandoc macro compiler library
163: (<A HREF="mandoc.3.txt">text</A> |
164: <A HREF="mandoc.3.xhtml">xhtml</A> |
165: <A HREF="mandoc.3.pdf">pdf</A> |
1.136 kristaps 166: <A HREF="mandoc.3.ps">ps</A>)
1.112 kristaps 167: </TD>
168: </TR>
169: <TR>
170: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
171: <TD VALIGN="top">
172: man language reference
173: (<A HREF="man.7.txt">text</A> |
174: <A HREF="man.7.xhtml">xhtml</A> |
175: <A HREF="man.7.pdf">pdf</A> |
1.136 kristaps 176: <A HREF="man.7.ps">ps</A>)
1.112 kristaps 177: </TD>
178: </TR>
179: <TR>
1.150 kristaps 180: <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
181: <TD VALIGN="top">
182: cgi for manpage query and display
183: (<A HREF="man.cgi.7.txt">text</A> |
184: <A HREF="man.cgi.7.xhtml">xhtml</A> |
185: <A HREF="man.cgi.7.pdf">pdf</A> |
186: <A HREF="man.cgi.7.ps">ps</A>)
187: </TD>
188: </TR>
189: <TR>
1.112 kristaps 190: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
191: <TD VALIGN="top">
192: eqn-mandoc language reference
193: (<A HREF="eqn.7.txt">text</A> |
194: <A HREF="eqn.7.xhtml">xhtml</A> |
195: <A HREF="eqn.7.pdf">pdf</A> |
1.136 kristaps 196: <A HREF="eqn.7.ps">ps</A>)
1.112 kristaps 197: </TD>
198: </TR>
199: <TR>
200: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
201: <TD VALIGN="top">
202: mandoc special characters
203: (<A HREF="mandoc_char.7.txt">text</A> |
204: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
205: <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136 kristaps 206: <A HREF="mandoc_char.7.ps">ps</A>)
1.112 kristaps 207: </TD>
208: </TR>
209: <TR>
210: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
211: <TD VALIGN="top">
212: mdoc language reference
213: (<A HREF="mdoc.7.txt">text</A> |
214: <A HREF="mdoc.7.xhtml">xhtml</A> |
215: <A HREF="mdoc.7.pdf">pdf</A> |
1.136 kristaps 216: <A HREF="mdoc.7.ps">ps</A>)
1.112 kristaps 217: </TD>
218: </TR>
219: <TR>
220: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
221: <TD VALIGN="top">
222: roff-mandoc language reference
223: (<A HREF="roff.7.txt">text</A> |
224: <A HREF="roff.7.xhtml">xhtml</A> |
225: <A HREF="roff.7.pdf">pdf</A> |
1.136 kristaps 226: <A HREF="roff.7.ps">ps</A>)
1.112 kristaps 227: </TD>
228: </TR>
229: <TR>
230: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
231: <TD VALIGN="top">
232: tbl-mandoc language reference
233: (<A HREF="tbl.7.txt">text</A> |
234: <A HREF="tbl.7.xhtml">xhtml</A> |
235: <A HREF="tbl.7.pdf">pdf</A> |
1.136 kristaps 236: <A HREF="tbl.7.ps">ps</A>)
1.112 kristaps 237: </TD>
238: </TR>
1.138 kristaps 239: <TR>
240: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
241: <TD VALIGN="top">
242: index UNIX manuals
243: (<A HREF="mandocdb.8.txt">text</A> |
244: <A HREF="mandocdb.8.xhtml">xhtml</A> |
245: <A HREF="mandocdb.8.pdf">pdf</A> |
246: <A HREF="mandocdb.8.ps">ps</A>)
247: </TD>
248: </TR>
1.112 kristaps 249: </TBODY>
250: </TABLE>
251: <H1>
1.118 kristaps 252: <A NAME="contact">Contact</A>
1.112 kristaps 253: </H1>
254: <P>
1.139 kristaps 255: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 256: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 257: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
258: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149 kristaps 259: this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112 kristaps 260: </P>
261: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 262: <COL WIDTH="175">
1.112 kristaps 263: <COL>
264: <TBODY>
265: <TR>
266: <TD>
267: disc<A CLASS="external" TITLE="Reveal this e-mail address"
268: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
269: </TD>
270: <TD>
271: bug-reports, general questions, and announcements
272: </TD>
273: </TR>
274: <TR>
275: <TD>
276: tec<A CLASS="external" TITLE="Reveal this e-mail address"
277: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
278: </TD>
279: <TD>
280: patches and system discussions
281: </TD>
282: </TR>
283: <TR>
284: <TD>
285: sou<A CLASS="external" TITLE="Reveal this e-mail address"
286: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
287: </TD>
288: <TD>
289: source commit messages
290: </TD>
291: </TR>
292: </TBODY>
293: </TABLE>
294: <H1>
1.118 kristaps 295: <A NAME="news">News</A>
1.112 kristaps 296: </H1>
1.124 kristaps 297: <P CLASS="news">
1.157 ! kristaps 298: xx-xx-2012: version 1.12.4
1.149 kristaps 299: </P>
1.151 kristaps 300: <P>
1.157 ! kristaps 301: <I>Ingo, can you summarise your changes here?</I>
1.151 kristaps 302: </P>
1.142 kristaps 303: <P>
1.157 ! kristaps 304: The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>,
! 305: <A HREF="apropos.1.html">apropos</A> (absorbing whatis), and
! 306: <A HREF="man.cgi.7.html">man.cgi</A> have been re-written to use
! 307: <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
1.141 schwarze 308: </P>
1.112 kristaps 309: <P>
310: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
311: historical notes.
312: </P>
313: <P CLASS="foot">
1.118 kristaps 314: <SMALL>
315: Copyright © 2008–2011
316: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.157 ! kristaps 317: $Date: 2012/06/09 11:30:08 $
1.118 kristaps 318: </SMALL>
1.112 kristaps 319: </P>
1.40 kristaps 320: </BODY>
321: </HTML>
CVSweb