Slowly decoupling mdoc(3) from being OpenBSD-only.

[mandoc.git] / index.sgml

diff --git a/index.sgml b/index.sgml
index 4dcba802e52e44acef9fbfaaa5c16a0cb6342817..1d576e14a61801b8b681555032e32a37dcd470c6 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -24,11 +24,16 @@
                                        </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 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.  groff amounts to over 60 000 lines of GPL C++ source, which is a
-                                       considerable encumbrance to BSD operating systems.
+                                       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>
@@ -44,7 +49,7 @@
 
                                        <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">mdochtml(1)</span> &#8211; formats mdoc input as HTML/CSS (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>
@@ -73,12 +78,17 @@
                                        i386, AMD64 and Alpha.
                                        </p>
 
+                                       <p>
+                                       The most current version is <span class="attn">@VERSION@</span>, dated 
+                                       <span class="attn">@VDATE@</span>.
+                                       </p>
+
                                        <h2>
-                                       snapshotted source
+                                       Snapshot source
                                        </h2>
 
                                        <p>
-                                       CVS sources are checkedout and snapshotted with big updates.  These may be found in the <a
+                                       CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a
                                        href="/snapshots/">/snapshots/</a> directory.
                                        </p>
 
@@ -86,11 +96,13 @@
                                        % 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
+                                       % make all<br>
+                                       % make regress<br>
+                                       # make install
                                        </p>
 
                                        <h2>
-                                       nightly port
+                                       Snapshot port
                                        </h2>
 
                                        <p>
@@ -100,12 +112,14 @@
                                        </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
+                                       # pkg_delete mdocml<br>
+                                       # cd /usr/ports/devel/<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 regress<br>
+                                       # make install
                                        </p>
                                </td>
                        </tr>
@@ -132,7 +146,7 @@
                        <tr>
                                <td>
                                        <div class="foot">
-                                               Copyright &#169; 2009 Kristaps D&#382;onsons, $Date: 2009/02/24 12:20:52 $
+                                               Copyright &#169; 2009 Kristaps D&#382;onsons, $Date: 2009/02/27 10:55:16 $
                                        </div>
                                </td>
                        </tr>