![[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.149 kristaps 6: <TITLE>mdocml | UNIX manpage compiler</TITLE>
1.40 kristaps 7: </HEAD>
8: <BODY>
1.112 kristaps 9: <P CLASS="head">
1.149 kristaps 10: <B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
1.136 kristaps 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>)
1.112 kristaps 16: </P>
17: <H1>
1.118 kristaps 18: <A NAME="description">Description</A>
1.112 kristaps 19: </H1>
20: <P>
21: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
22: package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
23: UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
24: HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
25: pages whilst providing token support for <I>man</I>.
26: </P>
27: <P>
28: 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
29: uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A
30: CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
31: </P>
32: <P>
33: <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121 kristaps 34: HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
35: support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.138 kristaps 36: It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
37: <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
1.144 kristaps 38: <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
1.150 kristaps 39: <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
40: <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
1.121 kristaps 41: It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112 kristaps 42: </P>
43: <P>
44: <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
45: </P>
1.137 kristaps 46: <H2>
1.118 kristaps 47: <A NAME="sources">Sources</A>
1.137 kristaps 48: </H2>
1.112 kristaps 49: <P>
1.145 kristaps 50: <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
51: need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
1.150 kristaps 52: HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A
53: HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
54: systems — see the <I>Makefile</I> if you're running Linux). To build and install into <I>/usr/local/</I>, just
55: run <CODE>make install</CODE>. Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are
56: usually taken by existing utilities.
1.132 kristaps 57: </P>
1.137 kristaps 58: <H2>
1.112 kristaps 59: Downstream
1.137 kristaps 60: </H2>
1.135 kristaps 61: <P>
62: Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
63: If your system does not appear below, the maintainers have not contacted me and it should not be considered
64: <Q>official</Q>.
65: Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
66: </P>
1.112 kristaps 67: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136 kristaps 68: <COL WIDTH="175">
1.112 kristaps 69: <COL>
70: <TBODY>
71: <TR>
72: <TD>DragonFly BSD</TD>
73: <TD>
1.153 kristaps 74: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
1.112 kristaps 75: </TD>
76: </TR>
77: <TR>
78: <TD>FreeBSD</TD>
79: <TD>
1.153 kristaps 80: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
1.112 kristaps 81: </TD>
82: </TR>
83: <TR>
84: <TD>NetBSD</TD>
85: <TD>
1.153 kristaps 86: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
1.112 kristaps 87: </TD>
88: </TR>
89: <TR>
90: <TD>OpenBSD</TD>
91: <TD>
1.153 kristaps 92: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
1.112 kristaps 93: </TD>
94: </TR>
1.148 kristaps 95: <TR>
96: <TD>pkgsrc</TD>
97: <TD>
98: <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
99: </TD>
100: </TR>
1.153 kristaps 101: <TR>
102: <TD>Minix3</TD>
103: <TD>
104: <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
105: </TD>
106: </TR>
1.112 kristaps 107: </TBODY>
108: </TABLE>
109: <H1>
1.118 kristaps 110: <A NAME="documentation">Documentation</A>
1.112 kristaps 111: </H1>
112: <P>
1.135 kristaps 113: These manuals are generated automatically and refer to the current release.
114: They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112 kristaps 115: </P>
116:
117: <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136 kristaps 118: <COL WIDTH="175">
1.112 kristaps 119: <COL>
120: <TBODY>
121: <TR>
1.144 kristaps 122: <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112 kristaps 123: <TD VALIGN="top">
1.144 kristaps 124: search the manual page database
1.112 kristaps 125: </TD>
126: </TR>
127: <TR>
1.138 kristaps 128: <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114 kristaps 129: <TD VALIGN="top">
1.138 kristaps 130: emit only text of UNIX manuals
1.114 kristaps 131: </TD>
132: </TR>
133: <TR>
1.144 kristaps 134: <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
135: <TD VALIGN="top">
136: format and display UNIX manuals
137: </TD>
138: </TR>
139: <TR>
1.120 kristaps 140: <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
141: <TD VALIGN="top">
142: recode multibyte UNIX manuals
143: </TD>
144: </TR>
145: <TR>
1.149 kristaps 146: <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>
147: <TD VALIGN="top">
148: search the manual page database
149: </TD>
150: </TR>
151: <TR>
1.112 kristaps 152: <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
153: <TD VALIGN="top">
154: mandoc macro compiler library
155: </TD>
156: </TR>
157: <TR>
1.154.2.2! schwarze 158: <TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD>
! 159: <TD VALIGN="top">
! 160: roff table parser library for mandoc
! 161: </TD>
! 162: </TR>
! 163: <TR>
1.112 kristaps 164: <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
165: <TD VALIGN="top">
166: man language reference
167: </TD>
168: </TR>
169: <TR>
1.150 kristaps 170: <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
171: <TD VALIGN="top">
172: cgi for manpage query and display
173: </TD>
174: </TR>
175: <TR>
1.112 kristaps 176: <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
177: <TD VALIGN="top">
178: eqn-mandoc language reference
179: </TD>
180: </TR>
181: <TR>
182: <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
183: <TD VALIGN="top">
184: mandoc special characters
185: </TD>
186: </TR>
187: <TR>
188: <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
189: <TD VALIGN="top">
190: mdoc language reference
191: </TD>
192: </TR>
193: <TR>
194: <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
195: <TD VALIGN="top">
196: roff-mandoc language reference
197: </TD>
198: </TR>
199: <TR>
200: <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
201: <TD VALIGN="top">
202: tbl-mandoc language reference
203: </TD>
204: </TR>
1.138 kristaps 205: <TR>
1.150 kristaps 206: <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>
207: <TD VALIGN="top">
208: update a man.cgi manpage cache
209: </TD>
210: </TR>
211: <TR>
1.138 kristaps 212: <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
213: <TD VALIGN="top">
214: index UNIX manuals
215: </TD>
216: </TR>
1.112 kristaps 217: </TBODY>
218: </TABLE>
219: <H1>
1.118 kristaps 220: <A NAME="contact">Contact</A>
1.112 kristaps 221: </H1>
222: <P>
1.139 kristaps 223: Use the mailing lists for bug-reports, patches, questions, etc. Please check the
1.112 kristaps 224: <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139 kristaps 225: before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
226: contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149 kristaps 227: this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112 kristaps 228: </P>
229: <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136 kristaps 230: <COL WIDTH="175">
1.112 kristaps 231: <COL>
232: <TBODY>
233: <TR>
234: <TD>
235: disc<A CLASS="external" TITLE="Reveal this e-mail address"
236: HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
237: </TD>
238: <TD>
239: bug-reports, general questions, and announcements
240: </TD>
241: </TR>
242: <TR>
243: <TD>
244: tec<A CLASS="external" TITLE="Reveal this e-mail address"
245: HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
246: </TD>
247: <TD>
248: patches and system discussions
249: </TD>
250: </TR>
251: <TR>
252: <TD>
253: sou<A CLASS="external" TITLE="Reveal this e-mail address"
254: HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
255: </TD>
256: <TD>
257: source commit messages
258: </TD>
259: </TR>
260: </TBODY>
261: </TABLE>
262: <H1>
1.118 kristaps 263: <A NAME="news">News</A>
1.112 kristaps 264: </H1>
1.124 kristaps 265: <P CLASS="news">
1.152 kristaps 266: 23-03-2011: version 1.12.1
1.149 kristaps 267: </P>
268: <P>
269: Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are
1.152 kristaps 270: now much more robust.
271: A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.
272: These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility
273: such as GNU troff.
1.150 kristaps 274: </P>
275: <P>
276: The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A
277: HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated
278: on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.
1.149 kristaps 279: </P>
1.151 kristaps 280: <P>
1.152 kristaps 281: The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"
1.151 kristaps 282: HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"
283: CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"
284: CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.
285: </P>
1.142 kristaps 286: <P>
1.152 kristaps 287: Lastly, I'm no longer providing binaries, as nobody has asked for them.
1.141 schwarze 288: </P>
1.112 kristaps 289: <P>
290: See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
291: historical notes.
292: </P>
293: <P CLASS="foot">
1.118 kristaps 294: <SMALL>
295: Copyright © 2008–2011
296: <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.154.2.2! schwarze 297: $Date: 2013/09/18 01:55:09 $
1.118 kristaps 298: </SMALL>
1.112 kristaps 299: </P>
1.40 kristaps 300: </BODY>
301: </HTML>