![[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.135 ! kristaps 10: <B>mdocml</B> – mdoc macro compiler,
! 11: current version <SPAN CLASS="attn">@VERSION@</SPAN> (<SPAN class="attn">@VDATE@</SPAN>)
1.112 kristaps 12: </P>
13: <H1>
1.118 kristaps 14: <A NAME="description">Description</A>
1.112 kristaps 15: </H1>
16: <P>
17: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
18: package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
19: UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
20: HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
21: pages whilst providing token support for <I>man</I>.
22: </P>
23: <P>
24: 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
25: uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A
26: CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
27: </P>
28: <P>
29: <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121 kristaps 30: HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
31: support for wide-character locales), XHTML, HTML, PostScript, and PDF.
32: It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A
1.128 schwarze 33: HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals.
1.121 kristaps 34: It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112 kristaps 35: </P>
36: <P>
37: <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
38: </P>
39: <H1>
1.118 kristaps 40: <A NAME="sources">Sources</A>
1.112 kristaps 41: </H1>
42: <P>
1.135 ! kristaps 43: <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.
! 44: To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
! 45: Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.
! 46: The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact
! 47: us</A> if you plan to use it.
1.132 kristaps 48: </P>
1.135 ! kristaps 49: <TABLE WIDTH="100%" SUMMARY="Current Sources">
! 50: <COL WIDTH="200">
! 51: <COL>
! 52: <TBODY>
! 53: <TR>
! 54: <TD>Current</TD>
! 55: <TD>
! 56: <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> (<A HREF="/snapshots/mdocml.md5">md5</A>)
! 57: </TD>
! 58: </TR>
! 59: <TR>
! 60: <TD>Archives</TD>
! 61: <TD>
! 62: <A HREF="/snapshots/">/snapshots/</A>
! 63: </TD>
! 64: </TR>
! 65: <TR>
! 66: <TD>Online Repository</TD>
! 67: <TD>
! 68: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
! 69: </TD>
! 70: </TR>
! 71: </TBODY>
! 72: </TABLE>
! 73: <H1>
! 74: <A NAME="binaries">Binaries</A>
! 75: </H1>
1.132 kristaps 76: <P>
1.135 ! kristaps 77: Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
! 78: Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
! 79: Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
! 80: 64-bit (x86_64) architectures.
1.121 kristaps 81: </P>
1.135 ! kristaps 82: <TABLE WIDTH="100%" SUMMARY="Current Binaries">
1.134 kristaps 83: <COL WIDTH="200">
1.112 kristaps 84: <COL>
85: <TBODY>
86: <TR>
1.135 ! kristaps 87: <TD>Windows 32-bit</TD>
1.112 kristaps 88: <TD>
1.135 ! kristaps 89: <A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>
1.112 kristaps 90: </TD>
91: </TR>
92: <TR>
1.135 ! kristaps 93: <TD>Windows 64-bit</TD>
1.112 kristaps 94: <TD>
1.135 ! kristaps 95: <A HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A>
1.112 kristaps 96: </TD>
97: </TR>
1.132 kristaps 98: <TR>
1.135 ! kristaps 99: <TD>Mac OS X Universal Binary</TD>
1.132 kristaps 100: <TD>
1.135 ! kristaps 101: <A HREF="/binaries/mdocml-macosx.zip">/binaries/mdocml-macosx.zip</A>
1.132 kristaps 102: </TD>
103: </TR>
1.134 kristaps 104: <TR>
1.135 ! kristaps 105: <TD>Archives</TD>
1.134 kristaps 106: <TD>
1.135 ! kristaps 107: <A HREF="/binaries/">/binaries/</A>
1.134 kristaps 108: </TD>
109: </TR>
1.112 kristaps 110: </TBODY>
111: </TABLE>
1.135 ! kristaps 112: <H1>
1.112 kristaps 113: Downstream
1.135 ! kristaps 114: </H1>
! 115: <P>
! 116: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
! 117: If your system does not appear below, the maintainers have not contacted me and it should not be considered
! 118: <Q>official</Q>.
! 119: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
! 120: </P>
1.112 kristaps 121: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.134 kristaps 122: <COL WIDTH="200">
1.112 kristaps 123: <COL>
124: <TBODY>
125: <TR>
126: <TD>DragonFly BSD</TD>
127: <TD>
128: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
129: CLASS="external">usr.bin/mandoc</A>
130: </TD>
131: </TR>
132: <TR>
133: <TD>FreeBSD</TD>
134: <TD>
135: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
136: CLASS="external">ports/textproc/mdocml</A>
137: </TD>
138: </TR>
139: <TR>
140: <TD>NetBSD</TD>
141: <TD>
142: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
143: CLASS="external">src/external/bsd/mdocml</A>
144: </TD>
145: </TR>
146: <TR>
147: <TD>OpenBSD</TD>
148: <TD>
149: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
150: CLASS="external">src/usr.bin/mandoc</A>
151: </TD>
152: </TR>
153: </TBODY>
154: </TABLE>
155: <H1>
1.118 kristaps 156: <A NAME="documentation">Documentation</A>
1.112 kristaps 157: </H1>
158: <P>
1.135 ! kristaps 159: These manuals are generated automatically and refer to the current release.
! 160: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 161: </P>
162:
163: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.134 kristaps 164: <COL WIDTH="200">
1.112 kristaps 165: <COL>
166: <TBODY>
167: <TR>
168: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
169: <TD VALIGN="top">
170: format and display UNIX manuals
171: <SMALL>
172: (<A HREF="mandoc.1.txt">text</A> |
173: <A HREF="mandoc.1.xhtml">xhtml</A> |
174: <A HREF="mandoc.1.pdf">pdf</A> |
175: <A HREF="mandoc.1.ps">postscript</A>)
176: </SMALL>
177: </TD>
178: </TR>
179: <TR>
1.128 schwarze 180: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
1.114 kristaps 181: <TD VALIGN="top">
182: index UNIX manuals
183: <SMALL>
1.128 schwarze 184: (<A HREF="mandocdb.8.txt">text</A> |
185: <A HREF="mandocdb.8.xhtml">xhtml</A> |
186: <A HREF="mandocdb.8.pdf">pdf</A> |
187: <A HREF="mandocdb.8.ps">postscript</A>)
1.114 kristaps 188: </SMALL>
189: </TD>
190: </TR>
191: <TR>
1.120 kristaps 192: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
193: <TD VALIGN="top">
194: recode multibyte UNIX manuals
195: <SMALL>
196: (<A HREF="preconv.1.txt">text</A> |
197: <A HREF="preconv.1.xhtml">xhtml</A> |
198: <A HREF="preconv.1.pdf">pdf</A> |
199: <A HREF="preconv.1.ps">postscript</A>)
200: </SMALL>
201: </TD>
202: </TR>
203: <TR>
1.112 kristaps 204: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
205: <TD VALIGN="top">
206: mandoc macro compiler library
207: <SMALL>
208: (<A HREF="mandoc.3.txt">text</A> |
209: <A HREF="mandoc.3.xhtml">xhtml</A> |
210: <A HREF="mandoc.3.pdf">pdf</A> |
211: <A HREF="mandoc.3.ps">postscript</A>)
212: </SMALL>
213: </TD>
214: </TR>
215: <TR>
216: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
217: <TD VALIGN="top">
218: man language reference
219: <SMALL>
220: (<A HREF="man.7.txt">text</A> |
221: <A HREF="man.7.xhtml">xhtml</A> |
222: <A HREF="man.7.pdf">pdf</A> |
223: <A HREF="man.7.ps">postscript</A>)
224: </SMALL>
225: </TD>
226: </TR>
227: <TR>
228: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
229: <TD VALIGN="top">
230: eqn-mandoc language reference
231: <SMALL>
232: (<A HREF="eqn.7.txt">text</A> |
233: <A HREF="eqn.7.xhtml">xhtml</A> |
234: <A HREF="eqn.7.pdf">pdf</A> |
235: <A HREF="eqn.7.ps">postscript</A>)
236: </SMALL>
237: </TD>
238: </TR>
239: <TR>
240: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
241: <TD VALIGN="top">
242: mandoc special characters
243: <SMALL>
244: (<A HREF="mandoc_char.7.txt">text</A> |
245: <A HREF="mandoc_char.7.xhtml">xhtml</A> |
246: <A HREF="mandoc_char.7.pdf">pdf</A> |
247: <A HREF="mandoc_char.7.ps">postscript</A>)
248: </SMALL>
249: </TD>
250: </TR>
251: <TR>
252: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
253: <TD VALIGN="top">
254: mdoc language reference
255: <SMALL>
256: (<A HREF="mdoc.7.txt">text</A> |
257: <A HREF="mdoc.7.xhtml">xhtml</A> |
258: <A HREF="mdoc.7.pdf">pdf</A> |
259: <A HREF="mdoc.7.ps">postscript</A>)
260: </SMALL>
261: </TD>
262: </TR>
263: <TR>
264: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
265: <TD VALIGN="top">
266: roff-mandoc language reference
267: <SMALL>
268: (<A HREF="roff.7.txt">text</A> |
269: <A HREF="roff.7.xhtml">xhtml</A> |
270: <A HREF="roff.7.pdf">pdf</A> |
271: <A HREF="roff.7.ps">postscript</A>)
272: </SMALL>
273: </TD>
274: </TR>
275: <TR>
276: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
277: <TD VALIGN="top">
278: tbl-mandoc language reference
279: <SMALL>
280: (<A HREF="tbl.7.txt">text</A> |
281: <A HREF="tbl.7.xhtml">xhtml</A> |
282: <A HREF="tbl.7.pdf">pdf</A> |
283: <A HREF="tbl.7.ps">postscript</A>)
284: </SMALL>
285: </TD>
286: </TR>
287: </TBODY>
288: </TABLE>
289: <H1>
1.118 kristaps 290: <A NAME="contact">Contact</A>
1.112 kristaps 291: </H1>
292: <P>
293: Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the
294: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
295: before posting. Beyond that, contact Kristaps at <A
296: HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
297: this e-mail address">kris...</A>@bsd.lv.
298: </P>
299: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.134 kristaps 300: <COL WIDTH="200">
1.112 kristaps 301: <COL>
302: <TBODY>
303: <TR>
304: <TD>
305: disc<A CLASS="external" TITLE="Reveal this e-mail address"
306: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
307: </TD>
308: <TD>
309: bug-reports, general questions, and announcements
310: <SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>
311: </TD>
312: </TR>
313: <TR>
314: <TD>
315: tec<A CLASS="external" TITLE="Reveal this e-mail address"
316: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
317: </TD>
318: <TD>
319: patches and system discussions
320: <SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>
321: </TD>
322: </TR>
323: <TR>
324: <TD>
325: sou<A CLASS="external" TITLE="Reveal this e-mail address"
326: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
327: </TD>
328: <TD>
329: source commit messages
330: <SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>
331: </TD>
332: </TR>
333: </TBODY>
334: </TABLE>
335: <H1>
1.118 kristaps 336: <A NAME="news">News</A>
1.112 kristaps 337: </H1>
1.124 kristaps 338: <P CLASS="news">
1.134 kristaps 339: 16-08-2011: version 1.11.6
340: </P>
341: <P>
342: Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more
343: readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general
1.135 ! kristaps 344: improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A
! 345: HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
! 346: HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
1.134 kristaps 347: </P>
348: <P CLASS="news">
1.131 kristaps 349: 24-07-2011: version 1.11.5
1.129 kristaps 350: </P>
351: <P>
1.130 kristaps 352: Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
353: (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A>
354: manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies
355: the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
1.131 kristaps 356: Edition User's Guide</A>.
1.129 kristaps 357: </P>
1.132 kristaps 358: <P>
359: This is also the first release featuring a distributed Windows binary, available at <A
360: HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
361: </P>
1.129 kristaps 362: <P CLASS="news">
1.125 kristaps 363: 12-07-2011: version 1.11.4
1.124 kristaps 364: </P>
365: <P>
1.128 schwarze 366: Bug-fixes and clean-ups across all systems, especially in <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (note: still not
1.127 kristaps 367: connected to the general build and must be compiled with <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A
1.125 kristaps 368: HREF="man.7.html">man</A> parser. This release was significantly assisted by participants in <A CLASS="external"
369: HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11. Thanks!
1.124 kristaps 370: </P>
1.112 kristaps 371: <P>
372: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
373: historical notes.
374: </P>
375: <P CLASS="foot">
1.118 kristaps 376: <SMALL>
377: Copyright © 2008–2011
378: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.135 ! kristaps 379: $Date: 2011/08/16 12:13:27 $
1.118 kristaps 380: </SMALL>
1.112 kristaps 381: </P>
1.40 kristaps 382: </BODY>
383: </HTML>