![[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.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.145 kristaps 55: <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
56: need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
57: HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
58: systems — see the <I>Makefile</I> if you're running Linux). To build and install into <I>/usr/local/</I>, just
59: run <CODE>make install</CODE>. Be careful: the <B>preconv</B> and <B>apropos</B> binary names are usually taken by
60: existing utilities.
1.132 kristaps 61: </P>
1.137 kristaps 62: <H2>
1.135 kristaps 63: <A NAME="binaries">Binaries</A>
1.137 kristaps 64: </H2>
1.132 kristaps 65: <P>
1.135 kristaps 66: Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
67: Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
68: Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
69: 64-bit (x86_64) architectures.
1.121 kristaps 70: </P>
1.137 kristaps 71: <H2>
1.112 kristaps 72: Downstream
1.137 kristaps 73: </H2>
1.135 kristaps 74: <P>
75: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
76: If your system does not appear below, the maintainers have not contacted me and it should not be considered
77: <Q>official</Q>.
78: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
79: </P>
1.112 kristaps 80: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 81: <COL WIDTH="175">
1.112 kristaps 82: <COL>
83: <TBODY>
84: <TR>
85: <TD>DragonFly BSD</TD>
86: <TD>
87: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
88: CLASS="external">usr.bin/mandoc</A>
89: </TD>
90: </TR>
91: <TR>
92: <TD>FreeBSD</TD>
93: <TD>
94: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
95: CLASS="external">ports/textproc/mdocml</A>
96: </TD>
97: </TR>
98: <TR>
99: <TD>NetBSD</TD>
100: <TD>
101: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
102: CLASS="external">src/external/bsd/mdocml</A>
103: </TD>
104: </TR>
105: <TR>
106: <TD>OpenBSD</TD>
107: <TD>
108: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
109: CLASS="external">src/usr.bin/mandoc</A>
110: </TD>
111: </TR>
112: </TBODY>
113: </TABLE>
114: <H1>
1.118 kristaps 115: <A NAME="documentation">Documentation</A>
1.112 kristaps 116: </H1>
117: <P>
1.135 kristaps 118: These manuals are generated automatically and refer to the current release.
119: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 120: </P>
121:
122: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 123: <COL WIDTH="175">
1.112 kristaps 124: <COL>
125: <TBODY>
126: <TR>
1.144 kristaps 127: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 128: <TD VALIGN="top">
1.144 kristaps 129: search the manual page database
130: (<A HREF="apropos.1.txt">text</A> |
131: <A HREF="apropos.1.xhtml">xhtml</A> |
132: <A HREF="apropos.1.pdf">pdf</A> |
133: <A HREF="apropos.1.ps">ps</A>)
1.112 kristaps 134: </TD>
135: </TR>
136: <TR>
1.138 kristaps 137: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 138: <TD VALIGN="top">
1.138 kristaps 139: emit only text of UNIX manuals
140: (<A HREF="demandoc.1.txt">text</A> |
141: <A HREF="demandoc.1.xhtml">xhtml</A> |
142: <A HREF="demandoc.1.pdf">pdf</A> |
143: <A HREF="demandoc.1.ps">ps</A>)
1.114 kristaps 144: </TD>
145: </TR>
146: <TR>
1.144 kristaps 147: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
148: <TD VALIGN="top">
149: format and display UNIX manuals
150: (<A HREF="mandoc.1.txt">text</A> |
151: <A HREF="mandoc.1.xhtml">xhtml</A> |
152: <A HREF="mandoc.1.pdf">pdf</A> |
153: <A HREF="mandoc.1.ps">ps</A>)
154: </TD>
155: </TR>
156: <TR>
1.120 kristaps 157: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
158: <TD VALIGN="top">
159: recode multibyte UNIX manuals
160: (<A HREF="preconv.1.txt">text</A> |
161: <A HREF="preconv.1.xhtml">xhtml</A> |
162: <A HREF="preconv.1.pdf">pdf</A> |
1.136 kristaps 163: <A HREF="preconv.1.ps">ps</A>)
1.120 kristaps 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: (<A HREF="mandoc.3.txt">text</A> |
171: <A HREF="mandoc.3.xhtml">xhtml</A> |
172: <A HREF="mandoc.3.pdf">pdf</A> |
1.136 kristaps 173: <A HREF="mandoc.3.ps">ps</A>)
1.112 kristaps 174: </TD>
175: </TR>
176: <TR>
177: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
178: <TD VALIGN="top">
179: man language reference
180: (<A HREF="man.7.txt">text</A> |
181: <A HREF="man.7.xhtml">xhtml</A> |
182: <A HREF="man.7.pdf">pdf</A> |
1.136 kristaps 183: <A HREF="man.7.ps">ps</A>)
1.112 kristaps 184: </TD>
185: </TR>
186: <TR>
187: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
188: <TD VALIGN="top">
189: eqn-mandoc language reference
190: (<A HREF="eqn.7.txt">text</A> |
191: <A HREF="eqn.7.xhtml">xhtml</A> |
192: <A HREF="eqn.7.pdf">pdf</A> |
1.136 kristaps 193: <A HREF="eqn.7.ps">ps</A>)
1.112 kristaps 194: </TD>
195: </TR>
196: <TR>
197: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
198: <TD VALIGN="top">
199: mandoc special characters
200: (<A HREF="mandoc_char.7.txt">text</A> |
201: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
202: <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136 kristaps 203: <A HREF="mandoc_char.7.ps">ps</A>)
1.112 kristaps 204: </TD>
205: </TR>
206: <TR>
207: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
208: <TD VALIGN="top">
209: mdoc language reference
210: (<A HREF="mdoc.7.txt">text</A> |
211: <A HREF="mdoc.7.xhtml">xhtml</A> |
212: <A HREF="mdoc.7.pdf">pdf</A> |
1.136 kristaps 213: <A HREF="mdoc.7.ps">ps</A>)
1.112 kristaps 214: </TD>
215: </TR>
216: <TR>
217: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
218: <TD VALIGN="top">
219: roff-mandoc language reference
220: (<A HREF="roff.7.txt">text</A> |
221: <A HREF="roff.7.xhtml">xhtml</A> |
222: <A HREF="roff.7.pdf">pdf</A> |
1.136 kristaps 223: <A HREF="roff.7.ps">ps</A>)
1.112 kristaps 224: </TD>
225: </TR>
226: <TR>
227: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
228: <TD VALIGN="top">
229: tbl-mandoc language reference
230: (<A HREF="tbl.7.txt">text</A> |
231: <A HREF="tbl.7.xhtml">xhtml</A> |
232: <A HREF="tbl.7.pdf">pdf</A> |
1.136 kristaps 233: <A HREF="tbl.7.ps">ps</A>)
1.112 kristaps 234: </TD>
235: </TR>
1.138 kristaps 236: <TR>
237: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
238: <TD VALIGN="top">
239: index UNIX manuals
240: (<A HREF="mandocdb.8.txt">text</A> |
241: <A HREF="mandocdb.8.xhtml">xhtml</A> |
242: <A HREF="mandocdb.8.pdf">pdf</A> |
243: <A HREF="mandocdb.8.ps">ps</A>)
244: </TD>
245: </TR>
1.112 kristaps 246: </TBODY>
247: </TABLE>
248: <H1>
1.118 kristaps 249: <A NAME="contact">Contact</A>
1.112 kristaps 250: </H1>
251: <P>
1.139 kristaps 252: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 253: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 254: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
255: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.112 kristaps 256: this e-mail address">kris...</A>@bsd.lv.
257: </P>
258: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 259: <COL WIDTH="175">
1.112 kristaps 260: <COL>
261: <TBODY>
262: <TR>
263: <TD>
264: disc<A CLASS="external" TITLE="Reveal this e-mail address"
265: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
266: </TD>
267: <TD>
268: bug-reports, general questions, and announcements
1.140 kristaps 269: (<A HREF="/archives/discuss/">archive</A>)
1.112 kristaps 270: </TD>
271: </TR>
272: <TR>
273: <TD>
274: tec<A CLASS="external" TITLE="Reveal this e-mail address"
275: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
276: </TD>
277: <TD>
278: patches and system discussions
1.140 kristaps 279: (<A HREF="/archives/tech/">archive</A>)
1.112 kristaps 280: </TD>
281: </TR>
282: <TR>
283: <TD>
284: sou<A CLASS="external" TITLE="Reveal this e-mail address"
285: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
286: </TD>
287: <TD>
288: source commit messages
1.140 kristaps 289: (<A HREF="/archives/source/">archive</A>)
1.112 kristaps 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.146 ! kristaps 298: 08-10-2011: version 1.12.0
1.141 schwarze 299: </P>
300: <P>
1.143 kristaps 301: This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>. This mode
302: allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively
303: support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.
304: 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 305: </P>
306: <P>
1.144 kristaps 307: While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.
1.146 ! kristaps 308: This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content. <A
! 309: HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search
! 310: (such as for functions, utilities, etc.) and regular expressions.
1.144 kristaps 311: </P>
312: <P>
313: In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made
314: considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE
315: SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections
316: down to the bottom of the page.
1.142 kristaps 317: </P>
318: <P>
319: Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
320: completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both
321: with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and
322: several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now
323: nicer for very long titles.
1.141 schwarze 324: </P>
325: <P CLASS="news">
1.139 kristaps 326: 02-09-2011: version 1.11.7
1.138 kristaps 327: </P>
328: <P>
329: Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the
1.139 kristaps 330: 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 331: </P>
332: <P CLASS="news">
1.134 kristaps 333: 16-08-2011: version 1.11.6
334: </P>
335: <P>
336: Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more
337: readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general
1.135 kristaps 338: improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A
339: HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
340: HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
1.134 kristaps 341: </P>
342: <P CLASS="news">
1.131 kristaps 343: 24-07-2011: version 1.11.5
1.129 kristaps 344: </P>
345: <P>
1.130 kristaps 346: Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
347: (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A>
348: manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies
349: the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
1.131 kristaps 350: Edition User's Guide</A>.
1.129 kristaps 351: </P>
1.132 kristaps 352: <P>
353: This is also the first release featuring a distributed Windows binary, available at <A
354: HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
355: </P>
1.112 kristaps 356: <P>
357: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
358: historical notes.
359: </P>
360: <P CLASS="foot">
1.118 kristaps 361: <SMALL>
362: Copyright © 2008–2011
363: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.146 ! kristaps 364: $Date: 2011/10/06 23:15:56 $
1.118 kristaps 365: </SMALL>
1.112 kristaps 366: </P>
1.40 kristaps 367: </BODY>
368: </HTML>