<title>mdocml.bsd.lv</title>
</head>
<body>
- <table width="600">
+ <table class="frame">
<col width="100%">
<tbody>
<tr>
</h1>
<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
+ <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 BSD mdoc pages.
+ displaying -mdoc pages whilst providing token support for -man.
</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).
+ 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 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.
+ 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>
- INSTALLING SOURCES
+ DOWNLOADS
</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>.
+ 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>
- Snapshot source
+ Current
</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>
+ <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>
- Snapshot port/pkgsrc
+ Downstream
</h2>
- <p>
- The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at <a
- href="/ports-openbsd/">/ports-openbsd/</a> and <a href="/ports-netbsd/">/ports-netbsd/</a>,
- respectively. Please read the <a href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a> or
- <a href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a>, first.
- </p>
-
- <h3>
- OpenBSD port
- </h3>
+ <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>
- <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>
+ <h2>
+ Historical
+ </h2>
- <h3>
- NetBSD pkgsrc
- </h3>
+ <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 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>
+ These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
+ current snapshot.
</p>
+
+ <table width="100%">
+ <col width="200">
+ <col>
+ <tbody>
+ <tr>
+ <td><a href="mandoc.1.txt">mandoc(1)</a></td>
+ <td>format and display UNIX manuals</td>
+ </tr>
+ <tr>
+ <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
+ <td>mandoc special characters</td>
+ </tr>
+ <tr>
+ <td><a href="mdoc.7.txt">mdoc(7)</a></td>
+ <td>mdoc language reference</td>
+ </tr>
+ <tr>
+ <td><a href="man.7.txt">man(7)</a></td>
+ <td>man language reference</td>
+ </tr>
+ <tr>
+ <td><a href="manuals.7.txt">manuals(7)</a></td>
+ <td>a guide to writing UNIX manuals</td>
+ </tr>
+ <tr>
+ <td><a href="mdoc.3.txt">mdoc(3)</a></td>
+ <td>mdoc macro compiler library</td>
+ </tr>
+ <tr>
+ <td><a href="man.3.txt">man(3)</a></td>
+ <td>man macro compiler library</td>
+ </tr>
+ </tbody>
+ </table>
</td>
</tr>
<tr>
</h1>
<p>
- Please contact Kristaps, kris<a class="external"
+ 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=="
- 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.
+ title="Reveal this e-mail address">...</a>@kth.se.
</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.
+ 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 © 2009 Kristaps Džonsons, $Date: 2009/03/21 09:50:07 $
+ Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/07/20 20:09:49 $
</div>
</td>
</tr>
git.ckatri.com / mandoc.git / blobdiff