<!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="style.css" type="text/css" media="all">
- <title>mdocml.bsd.lv</title>
- </head>
- <body>
- <table width="600">
- <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>
-
- <p>
- <span class="nm">mdocml</span> is a suite of tools that compile “mdoc”, the roff macro
- package of the BSD manual pages. 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 BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a
- considerable encumbrance to BSD operating system.
- </p>
-
- <p>
- The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
- intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers
- of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span
- class="man">mdoc(3)</span> reference manual.
- </p>
-
- <p>
- There are three utilities implementing <span class="man">mdoc(3)</span>:
- </p>
-
- <ul>
- <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal
- <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent)
- <li><span class="man">mdoclint(1)</span> – validates mdoc input
- <li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree
- </ul>
-
- <p>
- The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a
- href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the
- terminal, either directly or cached as a “catman” page.
- </p>
-
- <p>
- <span class="attn">Please submit patches!</span> Although a significant implementation exists, work
- remains for the backend library and especially the front-end utilities. See the <a
- href="#contact">contact</a> information below to submit patches and bug reports.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
- INSTALLING SOURCES
- </h1>
-
- <h2>
- nightly source
- </h2>
-
- <p>
- CVS sources are checkedout and snapshotted nightly. These may be found in the <a
- href="/snapshots/">/snapshots/</a> directory.
- </p>
-
- <p class="boxed">
- % cd /tmp<br>
- % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -<br>
- % cd mdocml<br>
- % make<br>
- % make regress<br>
- % make install
- </p>
-
- <h2>
- nightly port
- </h2>
-
- <p>
- The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not
- yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.
- </p>
-
- <p>
- If installing for the first time:
- </p>
-
- <p class="boxed">
- % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -<br>
- % cd mdocml<br>
- % sudo make<br>
- % sudo make install
- </p>
-
- <p>
- Subsequent installations:
- </p>
-
- <p class="boxed">
- % sudo pkg_add -r mdocml
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
- CONTACT
- </h1>
-
- <p>
- Please contact Kristaps, kris<a class="external"
- href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
- onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
- '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
- false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
- </p>
-
- <p>
- If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
- checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <div class="foot">
- Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/23 15:19:47 $
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </body>
-</html>
+<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 | mdoc macro compiler</TITLE>
+ </HEAD>
+ <BODY>
+ <P CLASS="head">
+ <B>mdocml</B> – mdoc macro compiler
+ </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, XHTML,
+ HTML, PostScript, and PDF. 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>
+
+ <H1>
+ <A NAME="sources">Sources</A>
+ </H1>
+
+ <P>
+ <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A
+ HREF="makewhatis.1.html">makewhatis</A> requires <A CLASS="external"
+ HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is
+ installed by default on all BSD operating systems). The most current version is <SPAN CLASS="attn">@VERSION@</SPAN>,
+ dated <SPAN class="attn">@VDATE@</SPAN>. If your system doesn't come with <SPAN CLASS="nm">mdocml</SPAN> (see
+ <Q>Downstream</Q>), run <CODE>make</CODE> to compile and <CODE>make install</CODE> to install into <I>/usr/local</I>.
+ Note that <A HREF="makewhatis.1.html">makewhatis</A> is not yet linked to the build. You must run <CODE>make
+ makewhatis</CODE> to build it (it does not install).
+ </P>
+
+ <H2>
+ Current
+ </H2>
+
+ <TABLE WIDTH="100%" SUMMARY="Current Sources">
+ <COL WIDTH="175">
+ <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 HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+
+ <H2>
+ Downstream
+ </H2>
+
+ <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>
+ </TBODY>
+ </TABLE>
+
+ <H2>
+ Historical
+ </H2>
+
+ <TABLE WIDTH="100%" SUMMARY="Archived Sources">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD>Source archive</TD>
+ <TD>
+ <A HREF="/snapshots/">/snapshots/</A>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+
+ <H1>
+ <A NAME="documentation">Documentation</A>
+ </H1>
+
+ <P>
+ These manuals are generated automatically and refer to the current snapshot.
+ </P>
+
+ <TABLE WIDTH="100%" SUMMARY="Documentation">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
+ <TD VALIGN="top">
+ format and display UNIX manuals
+ <SMALL>
+ (<A HREF="mandoc.1.txt">text</A> |
+ <A HREF="mandoc.1.xhtml">xhtml</A> |
+ <A HREF="mandoc.1.pdf">pdf</A> |
+ <A HREF="mandoc.1.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD>
+ <TD VALIGN="top">
+ index UNIX manuals
+ <SMALL>
+ (<A HREF="makewhatis.1.txt">text</A> |
+ <A HREF="makewhatis.1.xhtml">xhtml</A> |
+ <A HREF="makewhatis.1.pdf">pdf</A> |
+ <A HREF="makewhatis.1.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
+ <TD VALIGN="top">
+ recode multibyte UNIX manuals
+ <SMALL>
+ (<A HREF="preconv.1.txt">text</A> |
+ <A HREF="preconv.1.xhtml">xhtml</A> |
+ <A HREF="preconv.1.pdf">pdf</A> |
+ <A HREF="preconv.1.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
+ <TD VALIGN="top">
+ mandoc macro compiler library
+ <SMALL>
+ (<A HREF="mandoc.3.txt">text</A> |
+ <A HREF="mandoc.3.xhtml">xhtml</A> |
+ <A HREF="mandoc.3.pdf">pdf</A> |
+ <A HREF="mandoc.3.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
+ <TD VALIGN="top">
+ man language reference
+ <SMALL>
+ (<A HREF="man.7.txt">text</A> |
+ <A HREF="man.7.xhtml">xhtml</A> |
+ <A HREF="man.7.pdf">pdf</A> |
+ <A HREF="man.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
+ <TD VALIGN="top">
+ eqn-mandoc language reference
+ <SMALL>
+ (<A HREF="eqn.7.txt">text</A> |
+ <A HREF="eqn.7.xhtml">xhtml</A> |
+ <A HREF="eqn.7.pdf">pdf</A> |
+ <A HREF="eqn.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
+ <TD VALIGN="top">
+ mandoc special characters
+ <SMALL>
+ (<A HREF="mandoc_char.7.txt">text</A> |
+ <A HREF="mandoc_char.7.xhtml">xhtml</A> |
+ <A HREF="mandoc_char.7.pdf">pdf</A> |
+ <A HREF="mandoc_char.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
+ <TD VALIGN="top">
+ mdoc language reference
+ <SMALL>
+ (<A HREF="mdoc.7.txt">text</A> |
+ <A HREF="mdoc.7.xhtml">xhtml</A> |
+ <A HREF="mdoc.7.pdf">pdf</A> |
+ <A HREF="mdoc.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
+ <TD VALIGN="top">
+ roff-mandoc language reference
+ <SMALL>
+ (<A HREF="roff.7.txt">text</A> |
+ <A HREF="roff.7.xhtml">xhtml</A> |
+ <A HREF="roff.7.pdf">pdf</A> |
+ <A HREF="roff.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
+ <TD VALIGN="top">
+ tbl-mandoc language reference
+ <SMALL>
+ (<A HREF="tbl.7.txt">text</A> |
+ <A HREF="tbl.7.xhtml">xhtml</A> |
+ <A HREF="tbl.7.pdf">pdf</A> |
+ <A HREF="tbl.7.ps">postscript</A>)
+ </SMALL>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+
+ <H1>
+ <A NAME="contact">Contact</A>
+ </H1>
+
+ <P>
+ Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the
+ <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
+ before posting. 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.
+ </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
+ <SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>
+ </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
+ <SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>
+ </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
+ <SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+
+ <H1>
+ <A NAME="news">News</A>
+ </H1>
+
+ <P CLASS="news">
+ 19-05-2011: version 1.11.3
+ </P>
+ <P>
+ Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input.
+ See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details.
+ This allows for non-ASCII characters (e.g., <I>\[u5000]</I>) to be rendered in the locale's encoding, if said
+ environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead).
+ Locale support can be turned off at compile time by removing <I>-DUSE_WCHAR</I> in the <I>Makefile</I>, in which case
+ <B>-Tlocale</B> is always a synonym for <B>-Tascii</B>.
+ </P>
+ <P>
+ Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as <A
+ HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility.
+ </P>
+
+ <P CLASS="news">
+ 12-05-2011: version 1.11.2
+ </P>
+ <P>
+ Corrected some installation issues in version 1.11.1.
+ Further migration to <A HREF="mandoc.3.html">libmandoc</A>.
+ Initial public release (this utility is very much under development) of <A HREF="makewhatis.1.html">makewhatis</A>,
+ initially named mandoc-db.
+ This utility produces keyword databases of manual content
+ <A HREF="http://mdocml.bsd.lv/mandoc-cgi/index.html">mandoc-cgi</A>, which features semantic querying of manual content.
+ </P>
+
+ <P CLASS="news">
+ 04-04-2011: version 1.11.1
+ </P>
+ <P>
+ The earlier <I>libroff</I>, <I>libmdoc</I>, and <I>libman</I> soup have been merged into
+ a single library, <A HREF="mandoc.3.html">libmandoc</A>, which manages all aspects of
+ parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing).
+ </P>
+ <P>
+ Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in
+ place. For the time being, this is limited to the recognition of equation blocks;
+ future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework.
+ </P>
+ <P>
+ As usual, many general fixes and improvements have also occurred. In particular, a great
+ deal of redundancy and superfluous code has been removed with the merging of the backend
+ libraries.
+ </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: 2011/05/26 12:14:46 $
+ </SMALL>
+ </P>
+ </BODY>
+</HTML>
git.ckatri.com / mandoc.git / blobdiff