[BACK]Return to index.sgml CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/index.sgml, Revision 1.35

1.1       kristaps    1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
                      2: <html>
                      3:        <head>
                      4:                <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
                      5:                <meta name="resource-type" content="document">
1.28      kristaps    6:                <link rel="stylesheet" href="index.css" type="text/css" media="all">
1.1       kristaps    7:                <title>mdocml.bsd.lv</title>
                      8:        </head>
                      9:        <body>
1.24      kristaps   10:        <table class="frame">
1.1       kristaps   11:                <col width="100%">
                     12:                <tbody>
                     13:                        <tr>
                     14:                                <td>
                     15:                                        <div class="head">
                     16:                                                <b>mdocml</b> &#8211; mdoc macro compiler
                     17:                                        </div>
                     18:                                </td>
                     19:                        </tr>
                     20:                        <tr>
                     21:                                <td valign="top">
                     22:                                        <h1>
                     23:                                        DESCRIPTION
                     24:                                        </h1>
                     25:
                     26:                                        <p>
1.16      kristaps   27:                                        <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro package
                     28:                                        of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX
                     29:                                        manuals.  The mission of <span class="nm">mdocml</span> is to deprecate <a
                     30:                                        href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
1.18      kristaps   31:                                        displaying -mdoc pages whilst providing token support for -man.
1.9       kristaps   32:                                        </p>
                     33:
                     34:                                        <p>
1.13      kristaps   35:                                        Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
                     36:                                        slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
                     37:                                        this (respectively small, C, ISC-licensed, fast and regular).
1.1       kristaps   38:                                        </p>
                     39:
                     40:                                        <p>
1.19      kristaps   41:                                        The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
                     42:                                        validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
                     43:                                        be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
                     44:                                        mandoc</i>, which formats manuals for display on the terminal.
1.1       kristaps   45:                                        </p>
                     46:                                </td>
                     47:                        </tr>
                     48:                        <tr>
                     49:                                <td>
                     50:                                        <h1>
1.33      kristaps   51:                                        SOURCES
1.1       kristaps   52:                                        </h1>
                     53:
1.2       kristaps   54:                                        <p>
1.13      kristaps   55:                                        Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
1.24      kristaps   56:                                        variously on i386, AMD64, alpha, and others.  The most current version is <span
1.22      kristaps   57:                                        class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>.  A full <a
1.34      kristaps   58:                                        href="ChangeLog.html">ChangeLog</a> (<a href="ChangeLog.txt">txt</a>) is written with each release.
1.7       kristaps   59:                                        </p>
                     60:
1.1       kristaps   61:                                        <h2>
1.26      kristaps   62:                                        Current
1.1       kristaps   63:                                        </h2>
                     64:
1.24      kristaps   65:                                        <table width="100%">
                     66:                                        <col width="200">
                     67:                                        <col>
1.22      kristaps   68:                                        <tbody>
                     69:                                                <tr>
1.26      kristaps   70:                                                        <td>Source archive</td>
1.22      kristaps   71:                                                        <td>
1.26      kristaps   72:                                                        <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
                     73:                                                        (<a href="/snapshots/mdocml.md5">md5</a>)
1.22      kristaps   74:                                                        </td>
                     75:                                                </tr>
1.33      kristaps   76:                                                <tr>
                     77:                                                        <td>Online source</td>
                     78:                                                        <td>
                     79:                                                        <a class="external" href="http://bsd.lv/cgi-bin/cvsweb.cgi/?cvsroot=mdocml">cvsweb</a>
                     80:                                                        </td>
                     81:                                                </tr>
1.22      kristaps   82:                                        </tbody>
                     83:                                        </table>
1.1       kristaps   84:
                     85:                                        <h2>
1.26      kristaps   86:                                        Downstream
1.1       kristaps   87:                                        </h2>
                     88:
1.24      kristaps   89:                                        <table width="100%">
                     90:                                        <col width="200">
                     91:                                        <col>
1.22      kristaps   92:                                        <tbody>
                     93:                                                <tr>
1.26      kristaps   94:                                                        <td>FreeBSD</td>
1.22      kristaps   95:                                                        <td>
1.26      kristaps   96:                                                        <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
                     97:                                                                class="external">ports/textproc/mdocml</a>
1.22      kristaps   98:                                                        </td>
                     99:                                                </tr>
                    100:                                                <tr>
1.26      kristaps  101:                                                        <td>NetBSD</td>
1.22      kristaps  102:                                                        <td>
1.35    ! kristaps  103:                                                        <a href="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
        !           104:                                                                class="external">src/external/bsd/mdocml<a/>
1.22      kristaps  105:                                                        </td>
                    106:                                                </tr>
                    107:                                                <tr>
1.26      kristaps  108:                                                        <td>OpenBSD</td>
1.22      kristaps  109:                                                        <td>
1.26      kristaps  110:                                                        <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
                    111:                                                                class="external">src/usr.bin/mandoc</a>
1.22      kristaps  112:                                                        </td>
                    113:                                                </tr>
                    114:                                        </tbody>
                    115:                                        </table>
1.1       kristaps  116:
1.22      kristaps  117:                                        <h2>
                    118:                                        Historical
                    119:                                        </h2>
1.10      kristaps  120:
1.24      kristaps  121:                                        <table width="100%">
                    122:                                        <col width="200">
                    123:                                        <col>
1.22      kristaps  124:                                        <tbody>
                    125:                                                <tr>
                    126:                                                        <td>Source archive</td>
                    127:                                                        <td>
1.24      kristaps  128:                                                        <a href="/snapshots/">/snapshots/</a>
1.22      kristaps  129:                                                        </td>
                    130:                                                </tr>
                    131:                                        </tbody>
                    132:                                        </table>
1.1       kristaps  133:                                </td>
                    134:                        </tr>
                    135:                        <tr>
                    136:                                <td>
                    137:                                        <h1>
1.18      kristaps  138:                                        DOCUMENTATION
                    139:                                        </h1>
                    140:
1.24      kristaps  141:                                        <p>
1.29      kristaps  142:                                        These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the
1.24      kristaps  143:                                        current snapshot.
                    144:                                        </p>
                    145:
                    146:                                        <table width="100%">
                    147:                                        <col width="200">
                    148:                                        <col>
1.22      kristaps  149:                                        <tbody>
1.18      kristaps  150:                                                <tr>
1.34      kristaps  151:                                                        <td><a href="mandoc.1.html">mandoc(1)</a> (<a href="mandoc.1.txt">text</a>)</td>
1.18      kristaps  152:                                                        <td>format and display UNIX manuals</td>
                    153:                                                </tr>
                    154:                                                <tr>
1.34      kristaps  155:                                                        <td><a href="mandoc_char.7.html">mandoc_char(7)</a> (<a href="mandoc_char.7.txt">text</a>)</td>
1.18      kristaps  156:                                                        <td>mandoc special characters</td>
                    157:                                                </tr>
                    158:                                                <tr>
1.34      kristaps  159:                                                        <td><a href="mdoc.7.html">mdoc(7)</a> (<a href="mdoc.7.txt">text</a>)</td>
1.18      kristaps  160:                                                        <td>mdoc language reference</td>
                    161:                                                </tr>
                    162:                                                <tr>
1.34      kristaps  163:                                                        <td><a href="man.7.html">man(7)</a> (<a href="man.7.txt">text</a>)</td>
1.18      kristaps  164:                                                        <td>man language reference</td>
                    165:                                                </tr>
                    166:                                                <tr>
1.34      kristaps  167:                                                        <td><a href="manuals.7.html">manuals(7)</a> (<a href="manuals.7.txt">text</a>)</td>
1.18      kristaps  168:                                                        <td>a guide to writing UNIX manuals</td>
                    169:                                                </tr>
                    170:                                                <tr>
1.34      kristaps  171:                                                        <td><a href="mdoc.3.html">mdoc(3)</a> (<a href="mdoc.3.txt">text</a>)</td>
1.18      kristaps  172:                                                        <td>mdoc macro compiler library</td>
                    173:                                                </tr>
                    174:                                                <tr>
1.34      kristaps  175:                                                        <td><a href="man.3.html">man(3)</a> (<a href="man.3.txt">text</a>)</td>
1.18      kristaps  176:                                                        <td>man macro compiler library</td>
                    177:                                                </tr>
1.22      kristaps  178:                                        </tbody>
1.18      kristaps  179:                                        </table>
                    180:                                </td>
                    181:                        </tr>
                    182:                        <tr>
                    183:                                <td>
                    184:                                        <h1>
1.1       kristaps  185:                                        CONTACT
                    186:                                        </h1>
                    187:
                    188:                                        <p>
1.22      kristaps  189:                                        For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
                    190:                                        class="external"
1.1       kristaps  191:                                        href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
1.24      kristaps  192:                                        title="Reveal this e-mail address">...</a>@kth.se.
1.1       kristaps  193:                                        </p>
1.18      kristaps  194:
                    195:                                        <p>
1.24      kristaps  196:                                        If you want to receive a semi-automated mail-out of new releases, then please write with a message
1.22      kristaps  197:                                        subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
1.18      kristaps  198:                                        </p>
1.1       kristaps  199:                                </td>
                    200:                        </tr>
                    201:                        <tr>
                    202:                                <td>
                    203:                                        <div class="foot">
1.35    ! kristaps  204:                                                Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/10/20 18:31:04 $
1.1       kristaps  205:                                        </div>
                    206:                                </td>
                    207:                        </tr>
                    208:                </tbody>
                    209:        </table>
                    210:        </body>
                    211: </html>

CVSweb