]> 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 8a394ad617830a15956985a27024cef7e6a7909c..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>
@@ -28,12 +28,7 @@
                                        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
                                        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
-                                       displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a
-                                       href="man.7.txt" class="man">man(7)</a>.
-                                       </p>
-
-                                       <p>
-                                       What are UNIX manuals?  Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.
+                                       displaying -mdoc pages whilst providing token support for -man.
                                        </p>
 
                                        <p>
                                        </p>
 
                                        <p>
@@ -43,118 +38,178 @@
                                        </p>
 
                                        <p>
                                        </p>
 
                                        <p>
-                                       The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a
-                                       href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form
-                                       output from -man or -mdoc input.  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).  
-                                       </p>
-                                       
-                                       <p>
-                                       The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for
-                                       display on the terminal.  Its purpose is to deprecate usage of groff for displaying -mdoc and, to a
-                                       limited extent, -man manuals on the terminal.
-                                       </p>
-
-                                       <p>
-                                       <span class="attn">Please submit patches, bug reports and suggestions!</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 for submissions.
+                                       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>
                                        Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
                                        </h1>
 
                                        <p>
                                        Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
-                                       variously on i386, AMD64, alpha and others. 
-                                       </p>
-
-                                       <p>
-                                       The most current version is <span class="attn">@VERSION@</span>, dated 
-                                       <span class="attn">@VDATE@</span>.
+                                       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>
-                                       Snapshot source
+                                       Downstream
                                        </h2>
 
                                        </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- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">
-                                       http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | 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>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>
 
                                        <h2>
 
                                        <h2>
-                                       Snapshot port/pkgsrc
+                                       Current
                                        </h2>
 
                                        </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 class="external"
-                                       href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
-                                       href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
-                                       class="external"
-                                       href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
-                                       guide</a>, first.
-                                       </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>
+                                               <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>
 
 
-                                       <h3>
-                                       OpenBSD port
-                                       </h3>
-
-                                       <p class="boxed">
-                                       # pkg_delete mdocml<br>
-                                       # cd /usr/ports/textproc/<br>
-                                       # rm -rf mdocml<br>
-                                       # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">
-                                       http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | 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- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">
-                                       http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
-                                       # cd mdocml<br>
-                                       # make build<br>
-                                       # make install
-                                       </p>
+                                       <h2>
+                                       Historical
+                                       </h2>
 
 
-                                       <h3>
-                                       FreeBSD port
-                                       </h3>
+                                       <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 class="boxed">
-                                       # pkg_delete -x mdocml<br>
-                                       # cd /tmp<br>
-                                       # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">
-                                       http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>
-                                       # cd mdocml<br>
-                                       # make<br>
-                                       # make install
-                                       </p>
+                                       <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>
                                </td>
                        </tr>
                        <tr>
@@ -164,24 +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; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/04/05 16:34:22 $
+                                               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