Annotation of mandoc/index.sgml, Revision 1.144
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.47 kristaps 6: <TITLE>mdocml | mdoc macro compiler</TITLE>
1.40 kristaps 7: </HEAD>
8: <BODY>
1.112 kristaps 9: <P CLASS="head">
1.136 kristaps 10: <B>mdocml</B> – mdoc macro compiler, current version @VERSION@ (@VDATE@)
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>)
16: |
17: Binaries: <A
18: HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A
19: HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A
20: HREF="/binaries/mdocml-macosx.zip">mac os x</A>
21: (<A HREF="/binaries/">archives</A>)
1.112 kristaps 22: </P>
23: <H1>
1.118 kristaps 24: <A NAME="description">Description</A>
1.112 kristaps 25: </H1>
26: <P>
27: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
28: package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
29: UNIX 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 troff implementation, for displaying <I>mdoc</I>
31: pages whilst providing token support for <I>man</I>.
32: </P>
33: <P>
34: 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
35: uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A
36: CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
37: </P>
38: <P>
39: <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121 kristaps 40: HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
41: support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.138 kristaps 42: It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
43: <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
1.144 ! kristaps 44: <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
! 45: <A HREF="apropos.1.html">apropos</A>, for semantic search of manual content.
1.121 kristaps 46: It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112 kristaps 47: </P>
48: <P>
49: <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
50: </P>
1.137 kristaps 51: <H2>
1.118 kristaps 52: <A NAME="sources">Sources</A>
1.137 kristaps 53: </H2>
1.112 kristaps 54: <P>
1.135 kristaps 55: <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.
56: To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
57: Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.
58: The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact
59: us</A> if you plan to use it.
1.132 kristaps 60: </P>
1.137 kristaps 61: <H2>
1.135 kristaps 62: <A NAME="binaries">Binaries</A>
1.137 kristaps 63: </H2>
1.132 kristaps 64: <P>
1.135 kristaps 65: Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
66: Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
67: Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
68: 64-bit (x86_64) architectures.
1.121 kristaps 69: </P>
1.137 kristaps 70: <H2>
1.112 kristaps 71: Downstream
1.137 kristaps 72: </H2>
1.135 kristaps 73: <P>
74: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
75: If your system does not appear below, the maintainers have not contacted me and it should not be considered
76: <Q>official</Q>.
77: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
78: </P>
1.112 kristaps 79: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 80: <COL WIDTH="175">
1.112 kristaps 81: <COL>
82: <TBODY>
83: <TR>
84: <TD>DragonFly BSD</TD>
85: <TD>
86: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
87: CLASS="external">usr.bin/mandoc</A>
88: </TD>
89: </TR>
90: <TR>
91: <TD>FreeBSD</TD>
92: <TD>
93: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
94: CLASS="external">ports/textproc/mdocml</A>
95: </TD>
96: </TR>
97: <TR>
98: <TD>NetBSD</TD>
99: <TD>
100: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
101: CLASS="external">src/external/bsd/mdocml</A>
102: </TD>
103: </TR>
104: <TR>
105: <TD>OpenBSD</TD>
106: <TD>
107: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
108: CLASS="external">src/usr.bin/mandoc</A>
109: </TD>
110: </TR>
111: </TBODY>
112: </TABLE>
113: <H1>
1.118 kristaps 114: <A NAME="documentation">Documentation</A>
1.112 kristaps 115: </H1>
116: <P>
1.135 kristaps 117: These manuals are generated automatically and refer to the current release.
118: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 119: </P>
120:
121: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 122: <COL WIDTH="175">
1.112 kristaps 123: <COL>
124: <TBODY>
125: <TR>
1.144 ! kristaps 126: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 127: <TD VALIGN="top">
1.144 ! kristaps 128: search the manual page database
! 129: (<A HREF="apropos.1.txt">text</A> |
! 130: <A HREF="apropos.1.xhtml">xhtml</A> |
! 131: <A HREF="apropos.1.pdf">pdf</A> |
! 132: <A HREF="apropos.1.ps">ps</A>)
1.112 kristaps 133: </TD>
134: </TR>
135: <TR>
1.138 kristaps 136: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 137: <TD VALIGN="top">
1.138 kristaps 138: emit only text of UNIX manuals
139: (<A HREF="demandoc.1.txt">text</A> |
140: <A HREF="demandoc.1.xhtml">xhtml</A> |
141: <A HREF="demandoc.1.pdf">pdf</A> |
142: <A HREF="demandoc.1.ps">ps</A>)
1.114 kristaps 143: </TD>
144: </TR>
145: <TR>
1.144 ! kristaps 146: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
! 147: <TD VALIGN="top">
! 148: format and display UNIX manuals
! 149: (<A HREF="mandoc.1.txt">text</A> |
! 150: <A HREF="mandoc.1.xhtml">xhtml</A> |
! 151: <A HREF="mandoc.1.pdf">pdf</A> |
! 152: <A HREF="mandoc.1.ps">ps</A>)
! 153: </TD>
! 154: </TR>
! 155: <TR>
1.120 kristaps 156: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
157: <TD VALIGN="top">
158: recode multibyte UNIX manuals
159: (<A HREF="preconv.1.txt">text</A> |
160: <A HREF="preconv.1.xhtml">xhtml</A> |
161: <A HREF="preconv.1.pdf">pdf</A> |
1.136 kristaps 162: <A HREF="preconv.1.ps">ps</A>)
1.120 kristaps 163: </TD>
164: </TR>
165: <TR>
1.112 kristaps 166: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
167: <TD VALIGN="top">
168: mandoc macro compiler library
169: (<A HREF="mandoc.3.txt">text</A> |
170: <A HREF="mandoc.3.xhtml">xhtml</A> |
171: <A HREF="mandoc.3.pdf">pdf</A> |
1.136 kristaps 172: <A HREF="mandoc.3.ps">ps</A>)
1.112 kristaps 173: </TD>
174: </TR>
175: <TR>
176: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
177: <TD VALIGN="top">
178: man language reference
179: (<A HREF="man.7.txt">text</A> |
180: <A HREF="man.7.xhtml">xhtml</A> |
181: <A HREF="man.7.pdf">pdf</A> |
1.136 kristaps 182: <A HREF="man.7.ps">ps</A>)
1.112 kristaps 183: </TD>
184: </TR>
185: <TR>
186: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
187: <TD VALIGN="top">
188: eqn-mandoc language reference
189: (<A HREF="eqn.7.txt">text</A> |
190: <A HREF="eqn.7.xhtml">xhtml</A> |
191: <A HREF="eqn.7.pdf">pdf</A> |
1.136 kristaps 192: <A HREF="eqn.7.ps">ps</A>)
1.112 kristaps 193: </TD>
194: </TR>
195: <TR>
196: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
197: <TD VALIGN="top">
198: mandoc special characters
199: (<A HREF="mandoc_char.7.txt">text</A> |
200: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
201: <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136 kristaps 202: <A HREF="mandoc_char.7.ps">ps</A>)
1.112 kristaps 203: </TD>
204: </TR>
205: <TR>
206: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
207: <TD VALIGN="top">
208: mdoc language reference
209: (<A HREF="mdoc.7.txt">text</A> |
210: <A HREF="mdoc.7.xhtml">xhtml</A> |
211: <A HREF="mdoc.7.pdf">pdf</A> |
1.136 kristaps 212: <A HREF="mdoc.7.ps">ps</A>)
1.112 kristaps 213: </TD>
214: </TR>
215: <TR>
216: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
217: <TD VALIGN="top">
218: roff-mandoc language reference
219: (<A HREF="roff.7.txt">text</A> |
220: <A HREF="roff.7.xhtml">xhtml</A> |
221: <A HREF="roff.7.pdf">pdf</A> |
1.136 kristaps 222: <A HREF="roff.7.ps">ps</A>)
1.112 kristaps 223: </TD>
224: </TR>
225: <TR>
226: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
227: <TD VALIGN="top">
228: tbl-mandoc language reference
229: (<A HREF="tbl.7.txt">text</A> |
230: <A HREF="tbl.7.xhtml">xhtml</A> |
231: <A HREF="tbl.7.pdf">pdf</A> |
1.136 kristaps 232: <A HREF="tbl.7.ps">ps</A>)
1.112 kristaps 233: </TD>
234: </TR>
1.138 kristaps 235: <TR>
236: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
237: <TD VALIGN="top">
238: index UNIX manuals
239: (<A HREF="mandocdb.8.txt">text</A> |
240: <A HREF="mandocdb.8.xhtml">xhtml</A> |
241: <A HREF="mandocdb.8.pdf">pdf</A> |
242: <A HREF="mandocdb.8.ps">ps</A>)
243: </TD>
244: </TR>
1.112 kristaps 245: </TBODY>
246: </TABLE>
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.112 kristaps 255: this e-mail address">kris...</A>@bsd.lv.
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
1.140 kristaps 268: (<A HREF="/archives/discuss/">archive</A>)
1.112 kristaps 269: </TD>
270: </TR>
271: <TR>
272: <TD>
273: tec<A CLASS="external" TITLE="Reveal this e-mail address"
274: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
275: </TD>
276: <TD>
277: patches and system discussions
1.140 kristaps 278: (<A HREF="/archives/tech/">archive</A>)
1.112 kristaps 279: </TD>
280: </TR>
281: <TR>
282: <TD>
283: sou<A CLASS="external" TITLE="Reveal this e-mail address"
284: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
285: </TD>
286: <TD>
287: source commit messages
1.140 kristaps 288: (<A HREF="/archives/source/">archive</A>)
1.112 kristaps 289: </TD>
290: </TR>
291: </TBODY>
292: </TABLE>
293: <H1>
1.118 kristaps 294: <A NAME="news">News</A>
1.112 kristaps 295: </H1>
1.124 kristaps 296: <P CLASS="news">
1.144 ! kristaps 297: xx-xx-2011: version 1.xx.x
1.141 schwarze 298: </P>
299: <P>
1.143 kristaps 300: This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>. This mode
301: allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively
302: support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.
303: The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes.
1.142 kristaps 304: </P>
305: <P>
1.144 ! kristaps 306: While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.
! 307: This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content.
! 308: </P>
! 309: <P>
! 310: In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made
! 311: considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE
! 312: SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections
! 313: down to the bottom of the page.
1.142 kristaps 314: </P>
315: <P>
316: Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
317: completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both
318: with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and
319: several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now
320: nicer for very long titles.
1.141 schwarze 321: </P>
322: <P CLASS="news">
1.139 kristaps 323: 02-09-2011: version 1.11.7
1.138 kristaps 324: </P>
325: <P>
326: Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the
1.139 kristaps 327: historical <CODE>deroff</CODE> utility. Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.
1.138 kristaps 328: </P>
329: <P CLASS="news">
1.134 kristaps 330: 16-08-2011: version 1.11.6
331: </P>
332: <P>
333: Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more
334: readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general
1.135 kristaps 335: improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A
336: HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
337: HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
1.134 kristaps 338: </P>
339: <P CLASS="news">
1.131 kristaps 340: 24-07-2011: version 1.11.5
1.129 kristaps 341: </P>
342: <P>
1.130 kristaps 343: Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
344: (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A>
345: manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies
346: the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
1.131 kristaps 347: Edition User's Guide</A>.
1.129 kristaps 348: </P>
1.132 kristaps 349: <P>
350: This is also the first release featuring a distributed Windows binary, available at <A
351: HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
352: </P>
1.112 kristaps 353: <P>
354: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
355: historical notes.
356: </P>
357: <P CLASS="foot">
1.118 kristaps 358: <SMALL>
359: Copyright © 2008–2011
360: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.144 ! kristaps 361: $Date: 2011/10/05 21:43:11 $
1.118 kristaps 362: </SMALL>
1.112 kristaps 363: </P>
1.40 kristaps 364: </BODY>
365: </HTML>
CVSweb