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

Annotation of mandoc/index.sgml, Revision 1.14

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>
                     10:        <table width="600">
                     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.13      kristaps   27:                                        <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro
1.14    ! kristaps   28:                                        package of choice for BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate
        !            29:                                        <a href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation,
        !            30:                                        for displaying -mdoc pages.
1.9       kristaps   31:                                        </p>
                     32:
                     33:                                        <p>
1.13      kristaps   34:                                        Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
                     35:                                        slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
                     36:                                        this (respectively small, C, ISC-licensed, fast and regular).
1.1       kristaps   37:                                        </p>
                     38:
                     39:                                        <p>
                     40:                                        The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
1.13      kristaps   41:                                        intermediate-form output from -mdoc input.  libmdoc is a simple, fast library operating on memory
1.14    ! kristaps   42:                                        buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on).
1.1       kristaps   43:                                        </p>
1.14    ! kristaps   44:
1.1       kristaps   45:                                        <p>
1.14    ! kristaps   46:                                        The primary front-end is <span class="man">mandoc(1)</span>, which formats -mdoc manuals for display on
        !            47:                                        the terminal.  The <span class="man">mandoc(1)</span> utility is intended to deprecate usage of <a
1.13      kristaps   48:                                        href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying mdoc manuals on the
                     49:                                        terminal.
1.1       kristaps   50:                                        </p>
                     51:
                     52:                                        <p>
1.14    ! kristaps   53:                                        <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant
        !            54:                                        implementation exists, work remains for the backend library and especially the front-end utilities.  See
        !            55:                                        the <a href="#contact">contact</a> information below for submissions.
1.1       kristaps   56:                                        </p>
                     57:                                </td>
                     58:                        </tr>
                     59:                        <tr>
                     60:                                <td>
                     61:                                        <h1>
                     62:                                        INSTALLING SOURCES
                     63:                                        </h1>
                     64:
1.2       kristaps   65:                                        <p>
1.13      kristaps   66:                                        Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
1.14    ! kristaps   67:                                        variously on i386, AMD64, alpha and others.
1.2       kristaps   68:                                        </p>
                     69:
1.7       kristaps   70:                                        <p>
1.8       kristaps   71:                                        The most current version is <span class="attn">@VERSION@</span>, dated
                     72:                                        <span class="attn">@VDATE@</span>.
1.7       kristaps   73:                                        </p>
                     74:
1.1       kristaps   75:                                        <h2>
1.9       kristaps   76:                                        Snapshot source
1.1       kristaps   77:                                        </h2>
                     78:
                     79:                                        <p>
1.9       kristaps   80:                                        CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a
1.1       kristaps   81:                                        href="/snapshots/">/snapshots/</a> directory.
                     82:                                        </p>
                     83:
                     84:                                        <p class="boxed">
                     85:                                        % cd /tmp<br>
1.4       kristaps   86:                                        % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
1.1       kristaps   87:                                        % cd mdocml<br>
1.6       kristaps   88:                                        % make all<br>
                     89:                                        % make regress<br>
                     90:                                        # make install
1.1       kristaps   91:                                        </p>
                     92:
                     93:                                        <h2>
1.10      kristaps   94:                                        Snapshot port/pkgsrc
1.1       kristaps   95:                                        </h2>
                     96:
                     97:                                        <p>
1.12      kristaps   98:                                        The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
                     99:                                        href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
1.14    ! kristaps  100:                                        href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a class="external"
        !           101:                                        href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
        !           102:                                        href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
        !           103:                                        class="external"
        !           104:                                        href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
        !           105:                                        guide</a>, first.
1.1       kristaps  106:                                        </p>
                    107:
1.10      kristaps  108:                                        <h3>
                    109:                                        OpenBSD port
                    110:                                        </h3>
                    111:
1.1       kristaps  112:                                        <p class="boxed">
1.6       kristaps  113:                                        # pkg_delete mdocml<br>
1.11      kristaps  114:                                        # cd /usr/ports/textproc/<br>
1.6       kristaps  115:                                        # rm -rf mdocml<br>
                    116:                                        # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
                    117:                                        # cd mdocml<br>
                    118:                                        # make build<br>
1.10      kristaps  119:                                        # make install
                    120:                                        </p>
                    121:
                    122:                                        <h3>
                    123:                                        NetBSD pkgsrc
                    124:                                        </h3>
                    125:
                    126:                                        <p class="boxed">
                    127:                                        # pkg_delete mdocml<br>
1.11      kristaps  128:                                        # cd /usr/pkgsrc/textproc/<br>
1.10      kristaps  129:                                        # rm -rf mdocml<br>
                    130:                                        # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br>
                    131:                                        # cd mdocml<br>
                    132:                                        # make build<br>
1.6       kristaps  133:                                        # make install
1.1       kristaps  134:                                        </p>
1.12      kristaps  135:
                    136:                                        <h3>
                    137:                                        FreeBSD port
                    138:                                        </h3>
                    139:
                    140:                                        <p class="boxed">
                    141:                                        # pkg_delete mdocml<br>
                    142:                                        # cd /usr/ports/textproc/<br>
                    143:                                        # rm -rf mdocml<br>
                    144:                                        # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>
                    145:                                        # cd mdocml<br>
                    146:                                        # make build<br>
                    147:                                        # make install
                    148:                                        </p>
1.1       kristaps  149:                                </td>
                    150:                        </tr>
                    151:                        <tr>
                    152:                                <td>
                    153:                                        <h1>
                    154:                                        CONTACT
                    155:                                        </h1>
                    156:
                    157:                                        <p>
                    158:                                        Please contact Kristaps, kris<a class="external"
                    159:                                        href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
                    160:                                        onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',
                    161:                                        '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
                    162:                                        false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
                    163:                                        </p>
                    164:
                    165:                                        <p>
                    166:                                        If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
                    167:                                        checked in.  If making a bug report, please make sure it's repeatable on the most current snapshot.
                    168:                                        </p>
                    169:                                </td>
                    170:                        </tr>
                    171:                        <tr>
                    172:                                <td>
                    173:                                        <div class="foot">
1.14    ! kristaps  174:                                                Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/03/24 10:28:06 $
1.1       kristaps  175:                                        </div>
                    176:                                </td>
                    177:                        </tr>
                    178:                </tbody>
                    179:        </table>
                    180:        </body>
                    181: </html>

CVSweb