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

Annotation of mandoc/index.sgml, Revision 1.27

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">
                      6:                <link rel="stylesheet" href="style.css" type="text/css" media="all">
                      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.22      kristaps   51:                                        DOWNLOADS
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.25      kristaps   58:                                        href="ChangeLog.html">ChangeLog</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>
                     76:                                        </tbody>
                     77:                                        </table>
1.1       kristaps   78:
                     79:                                        <h2>
1.26      kristaps   80:                                        Downstream
1.1       kristaps   81:                                        </h2>
                     82:
1.24      kristaps   83:                                        <table width="100%">
                     84:                                        <col width="200">
                     85:                                        <col>
1.22      kristaps   86:                                        <tbody>
                     87:                                                <tr>
1.26      kristaps   88:                                                        <td>FreeBSD</td>
1.22      kristaps   89:                                                        <td>
1.26      kristaps   90:                                                        <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
                     91:                                                                class="external">ports/textproc/mdocml</a>
1.22      kristaps   92:                                                        </td>
                     93:                                                </tr>
                     94:                                                <tr>
1.26      kristaps   95:                                                        <td>NetBSD</td>
1.22      kristaps   96:                                                        <td>
1.26      kristaps   97:                                                        <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
                     98:                                                                class="external">pkgsrc/textproc/mdocml</a>
1.22      kristaps   99:                                                        </td>
                    100:                                                </tr>
                    101:                                                <tr>
1.26      kristaps  102:                                                        <td>OpenBSD</td>
1.22      kristaps  103:                                                        <td>
1.26      kristaps  104:                                                        <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
                    105:                                                                class="external">src/usr.bin/mandoc</a>
1.22      kristaps  106:                                                        </td>
                    107:                                                </tr>
                    108:                                        </tbody>
                    109:                                        </table>
1.1       kristaps  110:
1.22      kristaps  111:                                        <h2>
                    112:                                        Historical
                    113:                                        </h2>
1.10      kristaps  114:
1.24      kristaps  115:                                        <table width="100%">
                    116:                                        <col width="200">
                    117:                                        <col>
1.22      kristaps  118:                                        <tbody>
                    119:                                                <tr>
                    120:                                                        <td>Source archive</td>
                    121:                                                        <td>
1.24      kristaps  122:                                                        <a href="/snapshots/">/snapshots/</a>
1.22      kristaps  123:                                                        </td>
                    124:                                                </tr>
                    125:                                        </tbody>
                    126:                                        </table>
1.1       kristaps  127:                                </td>
                    128:                        </tr>
                    129:                        <tr>
                    130:                                <td>
                    131:                                        <h1>
1.18      kristaps  132:                                        DOCUMENTATION
                    133:                                        </h1>
                    134:
1.24      kristaps  135:                                        <p>
                    136:                                        These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
                    137:                                        current snapshot.
                    138:                                        </p>
                    139:
                    140:                                        <table width="100%">
                    141:                                        <col width="200">
                    142:                                        <col>
1.22      kristaps  143:                                        <tbody>
1.18      kristaps  144:                                                <tr>
                    145:                                                        <td><a href="mandoc.1.txt">mandoc(1)</a></td>
                    146:                                                        <td>format and display UNIX manuals</td>
                    147:                                                </tr>
                    148:                                                <tr>
                    149:                                                        <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
                    150:                                                        <td>mandoc special characters</td>
                    151:                                                </tr>
                    152:                                                <tr>
                    153:                                                        <td><a href="mdoc.7.txt">mdoc(7)</a></td>
                    154:                                                        <td>mdoc language reference</td>
                    155:                                                </tr>
                    156:                                                <tr>
                    157:                                                        <td><a href="man.7.txt">man(7)</a></td>
                    158:                                                        <td>man language reference</td>
                    159:                                                </tr>
                    160:                                                <tr>
                    161:                                                        <td><a href="manuals.7.txt">manuals(7)</a></td>
                    162:                                                        <td>a guide to writing UNIX manuals</td>
                    163:                                                </tr>
                    164:                                                <tr>
                    165:                                                        <td><a href="mdoc.3.txt">mdoc(3)</a></td>
                    166:                                                        <td>mdoc macro compiler library</td>
                    167:                                                </tr>
                    168:                                                <tr>
                    169:                                                        <td><a href="man.3.txt">man(3)</a></td>
                    170:                                                        <td>man macro compiler library</td>
                    171:                                                </tr>
1.22      kristaps  172:                                        </tbody>
1.18      kristaps  173:                                        </table>
                    174:                                </td>
                    175:                        </tr>
                    176:                        <tr>
                    177:                                <td>
                    178:                                        <h1>
1.1       kristaps  179:                                        CONTACT
                    180:                                        </h1>
                    181:
                    182:                                        <p>
1.22      kristaps  183:                                        For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
                    184:                                        class="external"
1.1       kristaps  185:                                        href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
1.24      kristaps  186:                                        title="Reveal this e-mail address">...</a>@kth.se.
1.1       kristaps  187:                                        </p>
1.18      kristaps  188:
                    189:                                        <p>
1.24      kristaps  190:                                        If you want to receive a semi-automated mail-out of new releases, then please write with a message
1.22      kristaps  191:                                        subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
1.18      kristaps  192:                                        </p>
1.1       kristaps  193:                                </td>
                    194:                        </tr>
                    195:                        <tr>
                    196:                                <td>
                    197:                                        <div class="foot">
1.27    ! kristaps  198:                                                Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/07/17 13:23:26 $
1.1       kristaps  199:                                        </div>
                    200:                                </td>
                    201:                        </tr>
                    202:                </tbody>
                    203:        </table>
                    204:        </body>
                    205: </html>

CVSweb