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