Annotation of mandoc/index.sgml, Revision 1.164
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.164 ! schwarze 10: <A HREF="http://www.openbsd.org/"><IMG SRC="puffy.gif" ALT="Puffy" WIDTH="100" HEIGHT="91" STYLE="float: right"></A>
1.149 kristaps 11: <B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
1.136 kristaps 12: </P>
13: <P CLASS="subhead">
14: Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
15: <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
16: (<A HREF="/snapshots/">archives</A>)
1.112 kristaps 17: </P>
18: <H1>
1.118 kristaps 19: <A NAME="description">Description</A>
1.112 kristaps 20: </H1>
21: <P>
22: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
23: package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
1.164 ! schwarze 24: UNIX manuals.
! 25: It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast.
1.112 kristaps 26: </P>
27: <P>
1.164 ! schwarze 28: The tool set features <A HREF="mandoc.1.html">mandoc</A>,
! 29: based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler,
! 30: to format output for UNIX terminals (with
1.121 kristaps 31: support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.164 ! schwarze 32: It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
! 33: <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
! 34: <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
! 35: <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
! 36: <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
! 37: </P>
! 38: <P>
! 39: <SPAN CLASS="nm">mdocml</SPAN> has predominantly been developed on OpenBSD
! 40: and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A>
! 41: and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
! 42: We strive to support all interested free operating systems, in particular
! 43: <A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>,
! 44: <A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>,
! 45: <A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>,
! 46: <A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>,
! 47: and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux,
! 48: as well as all systems running the <A CLASS="external" HREF="http://www.pkgsrc.org/">pkgsrc</A> portable package build system.
! 49: All of these projects have helped to make <SPAN CLASS="nm">mdocml</SPAN> better, by providing feedback and advice,
! 50: bug reports, and patches.
1.112 kristaps 51: </P>
52: <P>
53: <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
54: </P>
1.137 kristaps 55: <H2>
1.118 kristaps 56: <A NAME="sources">Sources</A>
1.137 kristaps 57: </H2>
1.112 kristaps 58: <P>
1.156 kristaps 59: <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
1.158 kristaps 60: HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
61: <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
1.156 kristaps 62: To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
63: Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
1.132 kristaps 64: </P>
1.137 kristaps 65: <H2>
1.112 kristaps 66: Downstream
1.137 kristaps 67: </H2>
1.135 kristaps 68: <P>
69: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
70: If your system does not appear below, the maintainers have not contacted me and it should not be considered
1.164 ! schwarze 71: <Q>official</Q>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
1.135 kristaps 72: </P>
1.112 kristaps 73: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 74: <COL WIDTH="175">
1.112 kristaps 75: <COL>
76: <TBODY>
77: <TR>
78: <TD>DragonFly BSD</TD>
79: <TD>
1.164 ! schwarze 80: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (post-1.12.2 sources)
1.159 schwarze 81: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>
82: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)
1.112 kristaps 83: </TD>
84: </TR>
85: <TR>
1.159 schwarze 86: <TD>FreeBSD 10.0, -CURRENT</TD>
1.112 kristaps 87: <TD>
1.159 schwarze 88: <A HREF="http://svnweb.freebsd.org/base/head/contrib/mdocml/" CLASS="external">contrib/mdocml</A> (1.12.1 sources)
89: <A HREF="http://svnweb.freebsd.org/base/head/usr.bin/mandoc/" CLASS="external">usr.bin/mandoc</A> (build system)
90: </TD>
91: </TR>
92: <TR>
93: <TD>FreeBSD 9.x, 8.x</TD>
94: <TD>
1.164 ! schwarze 95: <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.2 port)
1.112 kristaps 96: </TD>
97: </TR>
98: <TR>
99: <TD>NetBSD</TD>
100: <TD>
1.159 schwarze 101: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A> (1.12.1 sources plus patches and build system)
1.112 kristaps 102: </TD>
103: </TR>
104: <TR>
105: <TD>OpenBSD</TD>
106: <TD>
1.164 ! schwarze 107: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (post-1.12.2 sources under active development and build system)
1.112 kristaps 108: </TD>
109: </TR>
1.148 kristaps 110: <TR>
111: <TD>pkgsrc</TD>
112: <TD>
1.160 schwarze 113: <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.2 port)
1.148 kristaps 114: </TD>
115: </TR>
1.153 kristaps 116: <TR>
117: <TD>Minix3</TD>
118: <TD>
1.159 schwarze 119: <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A> (1.10.9 sources and build system)
1.153 kristaps 120: </TD>
121: </TR>
1.160 schwarze 122: <TR>
123: <TD>Alpine Linux</TD>
124: <TD>
1.162 schwarze 125: <A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port)
1.160 schwarze 126: </TD>
127: </TR>
1.112 kristaps 128: </TBODY>
129: </TABLE>
130: <H1>
1.118 kristaps 131: <A NAME="documentation">Documentation</A>
1.112 kristaps 132: </H1>
133: <P>
1.135 kristaps 134: These manuals are generated automatically and refer to the current release.
135: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 136: </P>
137:
138: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 139: <COL WIDTH="175">
1.112 kristaps 140: <COL>
141: <TBODY>
142: <TR>
1.144 kristaps 143: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 144: <TD VALIGN="top">
1.144 kristaps 145: search the manual page database
1.112 kristaps 146: </TD>
147: </TR>
148: <TR>
1.138 kristaps 149: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 150: <TD VALIGN="top">
1.138 kristaps 151: emit only text of UNIX manuals
1.114 kristaps 152: </TD>
153: </TR>
154: <TR>
1.144 kristaps 155: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
156: <TD VALIGN="top">
157: format and display UNIX manuals
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: </TD>
165: </TR>
166: <TR>
1.112 kristaps 167: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
168: <TD VALIGN="top">
169: mandoc macro compiler library
170: </TD>
171: </TR>
172: <TR>
1.159 schwarze 173: <TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD>
174: <TD VALIGN="top">
175: roff table parser library for mandoc
176: </TD>
177: </TR>
178: <TR>
179: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
180: <TD VALIGN="top">
181: eqn-mandoc language reference
182: </TD>
183: </TR>
184: <TR>
1.112 kristaps 185: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
186: <TD VALIGN="top">
187: man language reference
188: </TD>
189: </TR>
190: <TR>
1.150 kristaps 191: <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
192: <TD VALIGN="top">
193: cgi for manpage query and display
194: </TD>
195: </TR>
196: <TR>
1.112 kristaps 197: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
198: <TD VALIGN="top">
199: mandoc special characters
200: </TD>
201: </TR>
202: <TR>
203: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
204: <TD VALIGN="top">
205: mdoc language reference
206: </TD>
207: </TR>
208: <TR>
209: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
210: <TD VALIGN="top">
211: roff-mandoc language reference
212: </TD>
213: </TR>
214: <TR>
215: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
216: <TD VALIGN="top">
217: tbl-mandoc language reference
218: </TD>
219: </TR>
1.138 kristaps 220: <TR>
221: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
222: <TD VALIGN="top">
223: index UNIX manuals
224: </TD>
225: </TR>
1.112 kristaps 226: </TBODY>
227: </TABLE>
1.162 schwarze 228: <H2>
229: <A NAME="links">Supplementary Information</A>
230: </H2>
231: <UL>
232: <LI>
233: <A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons
234: </LI>
235: <LI>
236: <A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A>
237: chapter regarding manual pages
238: </LI>
239: <LI>
240: <A HREF="press.html">Publications and media coverage</A>
241: concerning mdocml and mandoc
242: </LI>
243: <LI>
244: <A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons
245: </LI>
246: </UL>
1.112 kristaps 247: <H1>
1.118 kristaps 248: <A NAME="contact">Contact</A>
1.112 kristaps 249: </H1>
250: <P>
1.139 kristaps 251: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 252: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 253: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
254: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149 kristaps 255: this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112 kristaps 256: </P>
257: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 258: <COL WIDTH="175">
1.112 kristaps 259: <COL>
260: <TBODY>
261: <TR>
262: <TD>
263: disc<A CLASS="external" TITLE="Reveal this e-mail address"
264: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
265: </TD>
266: <TD>
267: bug-reports, general questions, and announcements
268: </TD>
269: </TR>
270: <TR>
271: <TD>
272: tec<A CLASS="external" TITLE="Reveal this e-mail address"
273: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
274: </TD>
275: <TD>
276: patches and system discussions
277: </TD>
278: </TR>
279: <TR>
280: <TD>
281: sou<A CLASS="external" TITLE="Reveal this e-mail address"
282: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
283: </TD>
284: <TD>
285: source commit messages
286: </TD>
287: </TR>
288: </TBODY>
289: </TABLE>
290: <H1>
1.118 kristaps 291: <A NAME="news">News</A>
1.112 kristaps 292: </H1>
1.124 kristaps 293: <P CLASS="news">
1.159 schwarze 294: xx-xx-2013: version 1.13.0
295: </P>
296: <P>
297: The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
298: HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
299: use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
300: </P>
301: <P CLASS="news">
1.160 schwarze 302: 05-10-2013: version 1.12.2
1.159 schwarze 303: </P>
304: <P>
305: The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter,
306: to be called as <CODE>mandoc -Tman</CODE>, is now fully functional.
307: </P>
308: <P>
309: The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system)
310: input option, and the <CODE>-Tutf8</CODE> output mode now actually works.
311: </P>
312: <P>
313: The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones,
314: but only replaces them when the build actually succeeds.
315: </P>
316: <P>
317: The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance),
318: and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end).
319: Plus several bugfixes regarding indentation, line breaks, and vertical spacing,
320: and regarding <EM>RS</EM> following <EM>TP</EM>.
321: </P>
322: <P>
323: The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape,
324: the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character)
325: and <EM>it</EM> (input line trap) requests.
326: Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests.
327: </P>
328: <P>
329: In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures,
330: delimiter handling, list indentation and horizontal and vertical spacing,
331: formatting of the <EM>Lk</EM>, <EM>%U</EM>, and <EM>%C</EM> macros,
332: plus some bugfixes related to the handling of syntax errors like badly nested font blocks,
333: stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks,
334: and non-text children of <EM>Nm</EM> blocks.
1.149 kristaps 335: </P>
1.151 kristaps 336: <P>
1.159 schwarze 337: In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected,
338: and in <A HREF="man.7.html">man(7)</A> files, a crash was fixed that was triggered by some particular unclosed <EM>T{</EM> macros.
1.151 kristaps 339: </P>
1.142 kristaps 340: <P>
1.159 schwarze 341: For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,
342: a very small, very simplistic groff-versus-mandoc output comparison tool.
343: </P>
344: <P CLASS="news">
1.160 schwarze 345: 23-03-2012: version 1.12.1
1.159 schwarze 346: </P>
347: <P>
348: Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are
349: now much more robust.
350: A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.
351: These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility
352: such as GNU troff.
353: </P>
354: <P>
355: The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A
356: HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated
357: on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.
358: </P>
359: <P>
360: The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"
361: HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"
362: CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"
363: CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.
364: </P>
365: <P>
366: Lastly, I'm no longer providing binaries, as nobody has asked for them.
1.141 schwarze 367: </P>
1.163 schwarze 368: <H2>
369: <A>History</A>
370: </H2>
371: <UL>
372: <LI>
373: <A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010.
374: Briefly explaining the most important changes in each release in relatively easy terms.
375: Very many changes are not mentioned here.
376: </LI>
377: <LI>
378: <A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008.
379: One-line entries for important commits, releases, merges, hackathons and talks.
380: Makes it easy to find out who did what, and when, and when it became available where.
381: However, this is still incomplete, mentioning only a small fraction of all commits,
382: and to keep the size down, the individual entries are extremely terse and technical.
383: Feel free to look up more details and longer explanations about individual entries
384: in the ChangeLog or in CVS.
385: </LI>
386: <LI>
387: <A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project.
388: Very technical information of varying quality, strictly chronological.
389: All commits are mentioned, but some messages neglect to mention some changes.
390: Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long -
391: more than 25,000 lines, more than 700 kB.
392: </LI>
393: <LI>
394: <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project.
395: Source code, diffs and commit messages for each source file. The real thing.
396: </LI>
397: </UL>
1.112 kristaps 398: <P CLASS="foot">
1.118 kristaps 399: <SMALL>
400: Copyright © 2008–2011
401: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.159 schwarze 402: © 2013 Ingo Schwarze,
1.164 ! schwarze 403: $Date: 2013/10/13 18:34:51 $
1.118 kristaps 404: </SMALL>
1.112 kristaps 405: </P>
1.40 kristaps 406: </BODY>
407: </HTML>
CVSweb
![[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