<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="resource-type" content="document">
- <link rel="stylesheet" href="index.css" type="text/css" media="all">
- <title>mdocml.bsd.lv</title>
- </head>
- <body>
- <table class="frame" summary="[frame]">
- <col width="100%">
- <tbody>
- <tr>
- <td>
- <div class="head">
- <b>mdocml</b> – mdoc macro compiler
- </div>
- </td>
- </tr>
- <tr>
- <td valign="top">
- <h1>
- DESCRIPTION
- </h1>
+<HTML>
+ <HEAD>
+ <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
+ <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
+ <TITLE>mdocml | UNIX manpage compiler</TITLE>
+ </HEAD>
+ <BODY>
+ <P CLASS="head">
+ <B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
+ </P>
+ <P CLASS="subhead">
+ Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
+ <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
+ (<A HREF="/snapshots/">archives</A>)
+ </P>
+ <H1>
+ <A NAME="description">Description</A>
+ </H1>
+ <P>
+ <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
+ package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, 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 troff implementation, for displaying <I>mdoc</I>
+ pages whilst providing token support for <I>man</I>.
+ </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, <A
+ CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
+ </P>
+ <P>
+ <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
+ HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
+ support for wide-character locales), XHTML, HTML, PostScript, and PDF.
+ It also includes <A HREF="preconv.1.html">preconv</A> for recoding multibyte manuals,
+ <A HREF="demandoc.1.html">demandoc</A> for emitting only text parts of manuals,
+ <A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals,
+ <A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and
+ <A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online.
+ It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
+ </P>
+ <P>
+ <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
+ </P>
+ <H2>
+ <A NAME="sources">Sources</A>
+ </H2>
+ <P>
+ <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
+ HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
+ <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
+ To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
+ Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
+ </P>
+ <H2>
+ Downstream
+ </H2>
+ <P>
+ Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
+ If your system does not appear below, the maintainers have not contacted me and it should not be considered
+ <Q>official</Q>.
+ Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
+ </P>
+ <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD>DragonFly BSD</TD>
+ <TD>
+ <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
+ </TD>
+ </TR>
+ <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/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/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>
+ <TR>
+ <TD>pkgsrc</TD>
+ <TD>
+ <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
+ </TD>
+ </TR>
+ <TR>
+ <TD>Minix3</TD>
+ <TD>
+ <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ <H1>
+ <A NAME="documentation">Documentation</A>
+ </H1>
+ <P>
+ These manuals are generated automatically and refer to the current release.
+ They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
+ </P>
- <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>
- SOURCES
- </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> (<a href="ChangeLog.txt">txt</a>) is written with each release.
- </p>
-
- <h2>
- Current
- </h2>
-
- <table width="100%" summary="Current Sources">
- <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>
- <tr>
- <td>Online source</td>
- <td>
- <a class="external" href="http://bsd.lv/cgi-bin/cvsweb.cgi/?cvsroot=mdocml">cvsweb</a>
- </td>
- </tr>
- </tbody>
- </table>
-
- <h2>
- Downstream
- </h2>
-
- <table width="100%" summary="Downstream Sources">
- <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/src/external/bsd/mdocml/"
- class="external">src/external/bsd/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%" summary="Archived Sources">
- <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%" summary="Documentation">
- <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/10/28 08:08:53 $
- </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="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="eqn.7.html">eqn(7)</A></TD>
+ <TD VALIGN="top">
+ eqn-mandoc language reference
+ </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>
+ <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-2012: version 1.12.4
+ </P>
+ <P>
+ <I>Ingo, can you summarise your changes here?</I>
+ </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>
+ See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
+ historical notes.
+ </P>
+ <P CLASS="foot">
+ <SMALL>
+ Copyright © 2008–2011
+ <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
+ $Date: 2012/06/09 14:19:55 $
+ </SMALL>
+ </P>
+ </BODY>
+</HTML>
git.ckatri.com / mandoc.git / blobdiff