- <p>
- <span class="nm">mdocml</span> is a suite of tools compiling “mdoc”, the roff macro
- package for 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.
- </p>
-
- <p>
- Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some 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 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 HTML/CSS (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>
-
- <p>
- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on
- i386, AMD64 and Alpha.
- </p>
-
- <p>
- The most current version is <span class="attn">@VERSION@</span>, dated
- <span class="attn">@VDATE@</span>.
- </p>
-
- <h2>
- Snapshot source
- </h2>
-
- <p>
- CVS sources are checkedout and snapshotted with version updates. 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.tar.gz | tar -zvxf -<br>
- % cd mdocml<br>
- % make all<br>
- % make regress<br>
- # make install
- </p>
-
- <h2>
- Snapshot port/pkgsrc
- </h2>
-
- <p>
- The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
- href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
- href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a
- href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, <a
- href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or <a
- href="http://www.freebsd.org/ports/">FreeBSD Ports Guide</a> first.
- </p>
-
- <h3>
- OpenBSD port
- </h3>
-
- <p class="boxed">
- # pkg_delete mdocml<br>
- # cd /usr/ports/textproc/<br>
- # rm -rf mdocml<br>
- # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
- # cd mdocml<br>
- # make build<br>
- # make install
- </p>
-
- <h3>
- NetBSD pkgsrc
- </h3>
-
- <p class="boxed">
- # pkg_delete mdocml<br>
- # cd /usr/pkgsrc/textproc/<br>
- # rm -rf mdocml<br>
- # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br>
- # cd mdocml<br>
- # make build<br>
- # make install
- </p>
-
- <h3>
- FreeBSD port
- </h3>
-
- <p class="boxed">
- # pkg_delete mdocml<br>
- # cd /usr/ports/textproc/<br>
- # rm -rf mdocml<br>
- # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>
- # cd mdocml<br>
- # make build<br>
- # make install
- </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/03/23 21:46:04 $
- </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