]> git.cameronkatri.com Git - mandoc.git/blobdiff - index.sgml
git.ckatri.com / mandoc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
args() should return ARGS_ERROR, not 0.
[mandoc.git] / index.sgml
diff --git a/index.sgml b/index.sgml
index 4dcba802e52e44acef9fbfaaa5c16a0cb6342817..2bceb68061dbec86bcaf7bd7434239cf44beda65 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -7,7 +7,7 @@
                <title>mdocml.bsd.lv</title>
        </head>
        <body>
                <title>mdocml.bsd.lv</title>
        </head>
        <body>
-       <table width="600">
+       <table class="frame">
                <col width="100%">
                <tbody>
                        <tr>
                <col width="100%">
                <tbody>
                        <tr>
@@ -24,89 +24,192 @@
                                        </h1>
 
                                        <p>
                                        </h1>
 
                                        <p>
-                                       <span class="nm">mdocml</span> is a suite of tools that compile &#8220;mdoc&#8221;, the roff macro
-                                       package of the 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 &#8220;-mdoc&#8221;, the roff macro package
+                                       of choice for BSD manual pages, and &#8220;-man&#8221;, 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
                                        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 systems.
+                                       displaying -mdoc pages whilst providing token support for -man.
                                        </p>
 
                                        <p>
                                        </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.
+                                       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>
                                        </p>
 
                                        <p>
-                                       There are three utilities implementing <span class="man">mdoc(3)</span>:
-                                       </p>
-
-                                       <ul>
-                                       <li><span class="man">mdocterm(1)</span> &#8211; formats mdoc input for display on the terminal
-                                       <li><span class="man">mdochtml(1)</span> &#8211; formats mdoc input as strict HTML (nascent)
-                                       <li><span class="man">mdoclint(1)</span> &#8211; validates mdoc input
-                                       <li><span class="man">mdoctree(1)</span> &#8211; 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 &#8220;catman&#8221; 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>
                                        </p>
                                </td>
                        </tr>
                        <tr>
                                <td>
                                        <h1>
-                                       INSTALLING SOURCES
+                                       DOWNLOADS
                                        </h1>
 
                                        <p>
                                        </h1>
 
                                        <p>
-                                       Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on
-                                       i386, AMD64 and Alpha.
+                                       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="/snapshots/ChangeLog">ChangeLog</a> is written with each release.
                                        </p>
 
                                        <h2>
                                        </p>
 
                                        <h2>
-                                       snapshotted source
+                                       Downstream
                                        </h2>
 
                                        </h2>
 
-                                       <p>
-                                       CVS sources are checkedout and snapshotted with big updates.  These may be found in the <a
-                                       href="/snapshots/">/snapshots/</a> directory.
-                                       </p>
+                                       <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">
-                                       % cd /tmp<br>
-                                       % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
-                                       % cd mdocml<br>
-                                       % make && make regress && make install
-                                       </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>
+                                               <tr>
+                                                       <td>FreeBSD port</td>
+                                                       <td>
+                                                       <a href="/ports-freebsd/mdocml.tar.gz">/ports-freebsd/mdocml.tar.gz</a> 
+                                                       (<a href="/ports-freebsd/mdocml.md5">md5</a>)
+                                                       </td>
+                                               </tr>
+                                               <tr>
+                                                       <td>NetBSD pkgsrc</td>
+                                                       <td>
+                                                       <a href="/ports-netbsd/mdocml.tar.gz">/ports-netbsd/mdocml.tar.gz</a> 
+                                                       (<a href="/ports-netbsd/mdocml.md5">md5</a>)
+                                                       </td>
+                                               </tr>
+                                               <tr>
+                                                       <td>OpenBSD port</td>
+                                                       <td>
+                                                       <a href="/ports-openbsd/mdocml.tar.gz">/ports-openbsd/mdocml.tar.gz</a> 
+                                                       (<a href="/ports-openbsd/mdocml.md5">md5</a>)
+                                                       </td>
+                                               </tr>
+                                       </tbody>
+                                       </table>
 
                                        <h2>
 
                                        <h2>
-                                       nightly port
+                                       Historical
                                        </h2>
 
                                        </h2>
 
+                                       <table width="100%">
+                                       <col width="200">
+                                       <col>
+                                       <tbody>
+                                               <tr>
+                                                       <td>Source archive</td>
+                                                       <td>
+                                                       <a href="/snapshots/">/snapshots/</a> 
+                                                       </td>
+                                               </tr>
+                                               <tr>
+                                                       <td>FreeBSD port</td>
+                                                       <td>
+                                                       <a href="/ports-freebsd/">/ports-freebsd/</a> 
+                                                       </td>
+                                               </tr>
+                                               <tr>
+                                                       <td>NetBSD pkgsrc</td>
+                                                       <td>
+                                                       <a href="/ports-netbsd/">/ports-netbsd/</a> 
+                                                       </td>
+                                               </tr>
+                                               <tr>
+                                                       <td>OpenBSD port</td>
+                                                       <td>
+                                                       <a href="/ports-openbsd/">/ports-openbsd/</a> 
+                                                       </td>
+                                               </tr>
+                                       </tbody>
+                                       </table>
+                               </td>
+                       </tr>
+                       <tr>
+                               <td>
+                                       <h1>
+                                       DOCUMENTATION
+                                       </h1>
+
                                        <p>
                                        <p>
-                                       The source 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.
-                                       You <span class="emph">must</span> have the ports tree installed.
+                                       These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
+                                       current snapshot.
                                        </p>
 
                                        </p>
 
-                                       <p class="boxed">
-                                       % sudo pkg_delete mdocml<br>
-                                       % cd /usr/ports/devel/<br>
-                                       % sudo rm -rf mdocml<br>
-                                       % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | sudo tar -zvxf -<br>
-                                       % cd mdocml<br>
-                                       % sudo make && sudo make regress && sudo make install
-                                       </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>
                                </td>
                        </tr>
                        <tr>
@@ -116,23 +219,22 @@
                                        </h1>
 
                                        <p>
                                        </h1>
 
                                        <p>
-                                       Please contact Kristaps, kris<a class="external"
+                                       For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
+                                       class="external"
                                        href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
                                        href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
-                                       onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;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>
-                                       
+
                                        <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">
                                        </p>
                                </td>
                        </tr>
                        <tr>
                                <td>
                                        <div class="foot">
-                                               Copyright &#169; 2009 Kristaps D&#382;onsons, $Date: 2009/02/24 12:20:52 $
+                                               Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/07/04 08:06:42 $
                                        </div>
                                </td>
                        </tr>
                                        </div>
                                </td>
                        </tr>
A git conversion mirror of mandoc.bsd.lv