- <p>
- <span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package
- of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX
- manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a
- href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
- displaying -mdoc pages whilst providing token support for -man.
- </p>
-
- <p>
- 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 uncertain output, and varies in operation from system to system. mdocml strives to fix
- this (respectively small, C, ISC-licensed, fast and regular).
- </p>
-
- <p>
- The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
- validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may
- be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i>
- mandoc</i>, which formats manuals for display on the terminal.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
- DOWNLOADS
- </h1>
-
- <p>
- Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
- variously on i386, AMD64, alpha, and others. The most current version is <span
- class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a
- href="ChangeLog.html">ChangeLog</a> is written with each release.
- </p>
-
- <h2>
- Current
- </h2>
-
- <table width="100%">
- <col width="200">
- <col>
- <tbody>
- <tr>
- <td>Source archive</td>
- <td>
- <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
- (<a href="/snapshots/mdocml.md5">md5</a>)
- </td>
- </tr>
- </tbody>
- </table>
-
- <h2>
- Downstream
- </h2>
-
- <table width="100%">
- <col width="200">
- <col>
- <tbody>
- <tr>
- <td>FreeBSD</td>
- <td>
- <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
- class="external">ports/textproc/mdocml</a>
- </td>
- </tr>
- <tr>
- <td>NetBSD</td>
- <td>
- <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
- class="external">pkgsrc/textproc/mdocml</a>
- </td>
- </tr>
- <tr>
- <td>OpenBSD</td>
- <td>
- <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
- class="external">src/usr.bin/mandoc</a>
- </td>
- </tr>
- </tbody>
- </table>
-
- <h2>
- Historical
- </h2>
-
- <table width="100%">
- <col width="200">
- <col>
- <tbody>
- <tr>
- <td>Source archive</td>
- <td>
- <a href="/snapshots/">/snapshots/</a>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
- DOCUMENTATION
- </h1>
-
- <p>
- These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the
- current snapshot.
- </p>
-
- <table width="100%">
- <col width="200">
- <col>
- <tbody>
- <tr>
- <td><a href="mandoc.1.html">mandoc(1)</a> [<a href="mandoc.1.txt">text</a>]</td>
- <td>format and display UNIX manuals</td>
- </tr>
- <tr>
- <td><a href="mandoc_char.7.html">mandoc_char(7)</a> [<a href="mandoc_char.7.txt">text</a>]</td>
- <td>mandoc special characters</td>
- </tr>
- <tr>
- <td><a href="mdoc.7.html">mdoc(7)</a> [<a href="mdoc.7.txt">text</a>]</td>
- <td>mdoc language reference</td>
- </tr>
- <tr>
- <td><a href="man.7.html">man(7)</a> [<a href="man.7.txt">text</a>]</td>
- <td>man language reference</td>
- </tr>
- <tr>
- <td><a href="manuals.7.html">manuals(7)</a> [<a href="manuals.7.txt">text</a>]</td>
- <td>a guide to writing UNIX manuals</td>
- </tr>
- <tr>
- <td><a href="mdoc.3.html">mdoc(3)</a> [<a href="mdoc.3.txt">text</a>]</td>
- <td>mdoc macro compiler library</td>
- </tr>
- <tr>
- <td><a href="man.3.html">man(3)</a> [<a href="man.3.txt">text</a>]</td>
- <td>man macro compiler library</td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
- CONTACT
- </h1>
-
- <p>
- For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a
- class="external"
- href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
- title="Reveal this e-mail address">...</a>@kth.se.
- </p>
-
- <p>
- If you want to receive a semi-automated mail-out of new releases, then please write with a message
- subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <div class="foot">
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/09/23 11:02:21 $
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </body>
-</html>
+ <TABLE WIDTH="100%" SUMMARY="Documentation">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
+ <TD VALIGN="top">
+ search the manual page database
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
+ <TD VALIGN="top">
+ emit only text of UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
+ <TD VALIGN="top">
+ format and display UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
+ <TD VALIGN="top">
+ recode multibyte UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
+ <TD VALIGN="top">
+ mandoc macro compiler library
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD>
+ <TD VALIGN="top">
+ roff table parser library for mandoc
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
+ <TD VALIGN="top">
+ eqn-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
+ <TD VALIGN="top">
+ man language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
+ <TD VALIGN="top">
+ cgi for manpage query and display
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
+ <TD VALIGN="top">
+ mandoc special characters
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
+ <TD VALIGN="top">
+ mdoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
+ <TD VALIGN="top">
+ roff-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
+ <TD VALIGN="top">
+ tbl-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
+ <TD VALIGN="top">
+ index UNIX manuals
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ <H2>
+ <A NAME="links">Supplementary Information</A>
+ </H2>
+ <UL>
+ <LI>
+ <A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons
+ </LI>
+ <LI>
+ <A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A>
+ chapter regarding manual pages
+ </LI>
+ <LI>
+ <A HREF="press.html">Publications and media coverage</A>
+ concerning mdocml and mandoc
+ </LI>
+ <LI>
+ <A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons
+ </LI>
+ </UL>
+ <H1>
+ <A NAME="contact">Contact</A>
+ </H1>
+ <P>
+ Use the mailing lists for bug-reports, patches, questions, etc. Please check the
+ <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
+ before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
+ contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
+ this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
+ </P>
+ <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD>
+ disc<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ bug-reports, general questions, and announcements
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ tec<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ patches and system discussions
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ sou<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ source commit messages
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ <H1>
+ <A NAME="news">News</A>
+ </H1>
+ <P CLASS="news">
+ xx-xx-2014: version 1.13.0
+ </P>
+ <P>
+ The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
+ HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
+ use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
+ </P>
+ <P CLASS="news">
+ 31-12-2013: version 1.12.3
+ </P>
+ <P>
+ In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation
+ now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
+ Thanks to Franco Fichtner for doing part of the work.
+ </P>
+ <P>
+ The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes.
+ </P>
+ <P>
+ In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted
+ by doubling them, just like in <A HREF="man.7.html">man(7)</A>.
+ Thanks to Tsugutomo ENAMI for the patch.
+ </P>
+ <P>
+ At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing
+ now works. Thanks to Franco Fichtner for the patch.
+ </P>
+ <P>
+ For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the
+ man-ext .UR/.UE (uniform resource identifier) block macros.
+ </P>
+ <P>
+ The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open
+ more gracefully.
+ </P>
+ <P>
+ The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS.
+ </P>
+ <P>
+ In the <A HREF="man.7.html">man(7)</A> formatter, reset indentation when leaving a block,
+ not just when entering the next one.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing
+ number registers and stops parsing the number right before the first non-digit character.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence
+ syntax \C'uXXXX' for Unicode characters.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family)
+ and .hw (hyphenation points) requests and the \d and \u escape sequences.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> manual got a new ESCAPE SEQUENCE REFERENCE.
+ </P>
+ <P CLASS="news">
+ 05-10-2013: version 1.12.2
+ </P>
+ <P>
+ The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter,
+ to be called as <CODE>mandoc -Tman</CODE>, is now fully functional.
+ </P>
+ <P>
+ The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system)
+ input option, and the <CODE>-Tutf8</CODE> output mode now actually works.
+ </P>
+ <P>
+ The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones,
+ but only replaces them when the build actually succeeds.
+ </P>
+ <P>
+ The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance),
+ and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end).
+ Plus several bugfixes regarding indentation, line breaks, and vertical spacing,
+ and regarding <EM>RS</EM> following <EM>TP</EM>.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape,
+ the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character)
+ and <EM>it</EM> (input line trap) requests.
+ Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests.
+ </P>
+ <P>
+ In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures,
+ delimiter handling, list indentation and horizontal and vertical spacing,
+ formatting of the <EM>Lk</EM>, <EM>%U</EM>, and <EM>%C</EM> macros,
+ plus some bugfixes related to the handling of syntax errors like badly nested font blocks,
+ stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks,
+ and non-text children of <EM>Nm</EM> blocks.
+ </P>
+ <P>
+ In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected,
+ and in <A HREF="man.7.html">man(7)</A> files, a crash was fixed that was triggered by some particular unclosed <EM>T{</EM> macros.
+ </P>
+ <P>
+ For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,
+ a very small, very simplistic groff-versus-mandoc output comparison tool.
+ </P>
+ <H2>
+ <A>History</A>
+ </H2>
+ <UL>
+ <LI>
+ <A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010.
+ Briefly explaining the most important changes in each release in relatively easy terms.
+ Very many changes are not mentioned here.
+ </LI>
+ <LI>
+ <A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008.
+ One-line entries for important commits, releases, merges, hackathons and talks.
+ Makes it easy to find out who did what, and when, and when it became available where.
+ However, this is still incomplete, mentioning only a small fraction of all commits,
+ and to keep the size down, the individual entries are extremely terse and technical.
+ Feel free to look up more details and longer explanations about individual entries
+ in the ChangeLog or in CVS.
+ </LI>
+ <LI>
+ <A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project.
+ Very technical information of varying quality, strictly chronological.
+ All commits are mentioned, but some messages neglect to mention some changes.
+ Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long -
+ more than 25,000 lines, more than 700 kB.
+ </LI>
+ <LI>
+ <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project.
+ Source code, diffs and commit messages for each source file. The real thing.
+ </LI>
+ </UL>
+ <P CLASS="foot">
+ <SMALL>
+ Copyright © 2008–2011
+ <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
+ © 2013 Ingo Schwarze,
+ $Date: 2013/12/31 17:47:17 $
+ </SMALL>
+ </P>
+ </BODY>
+</HTML>
git.ckatri.com / mandoc.git / blobdiff