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

Annotation of mandoc/index.sgml, Revision 1.154

1.1       kristaps    1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
1.40      kristaps    2: <HTML>
                      3:        <HEAD>
                      4:                <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
                      5:                <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
1.149     kristaps    6:                <TITLE>mdocml | UNIX manpage compiler</TITLE>
1.40      kristaps    7:        </HEAD>
                      8:        <BODY>
1.112     kristaps    9:                <P CLASS="head">
1.149     kristaps   10:                        <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)
1.136     kristaps   11:                </P>
                     12:                <P CLASS="subhead">
                     13:                        Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
                     14:                        <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
                     15:                        (<A HREF="/snapshots/">archives</A>)
1.112     kristaps   16:                </P>
                     17:                <H1>
1.118     kristaps   18:                        <A NAME="description">Description</A>
1.112     kristaps   19:                </H1>
                     20:                <P>
                     21:                        <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
                     22:                        package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
                     23:                        UNIX manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
                     24:                        HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
                     25:                        pages whilst providing token support for <I>man</I>.
                     26:                </P>
                     27:                <P>
                     28:                        Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs slowly, produces
                     29:                        uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A
                     30:                        CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
                     31:                </P>
                     32:                <P>
                     33:                        <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121     kristaps   34:                        HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
                     35:                        support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.138     kristaps   36:                        It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
                     37:                        <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
1.144     kristaps   38:                        <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
1.150     kristaps   39:                        <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
                     40:                        <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
1.121     kristaps   41:                        It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112     kristaps   42:                </P>
                     43:                <P>
                     44:                        <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                     45:                </P>
1.137     kristaps   46:                <H2>
1.118     kristaps   47:                        <A NAME="sources">Sources</A>
1.137     kristaps   48:                </H2>
1.112     kristaps   49:                <P>
1.145     kristaps   50:                        <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
                     51:                        need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
1.150     kristaps   52:                        HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A
                     53:                        HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
                     54:                        systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just
                     55:                        run <CODE>make install</CODE>.  Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are
                     56:                        usually taken by existing utilities.
1.132     kristaps   57:                </P>
1.137     kristaps   58:                <H2>
1.112     kristaps   59:                        Downstream
1.137     kristaps   60:                </H2>
1.135     kristaps   61:                <P>
                     62:                        Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
                     63:                        If your system does not appear below, the maintainers have not contacted me and it should not be considered
                     64:                        <Q>official</Q>.
                     65:                        Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
                     66:                </P>
1.112     kristaps   67:                <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136     kristaps   68:                        <COL WIDTH="175">
1.112     kristaps   69:                        <COL>
                     70:                        <TBODY>
                     71:                                <TR>
                     72:                                        <TD>DragonFly BSD</TD>
                     73:                                        <TD>
1.153     kristaps   74:                                        <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
1.112     kristaps   75:                                        </TD>
                     76:                                </TR>
                     77:                                <TR>
                     78:                                        <TD>FreeBSD</TD>
                     79:                                        <TD>
1.153     kristaps   80:                                        <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
1.112     kristaps   81:                                        </TD>
                     82:                                </TR>
                     83:                                <TR>
                     84:                                        <TD>NetBSD</TD>
                     85:                                        <TD>
1.153     kristaps   86:                                        <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
1.112     kristaps   87:                                        </TD>
                     88:                                </TR>
                     89:                                <TR>
                     90:                                        <TD>OpenBSD</TD>
                     91:                                        <TD>
1.153     kristaps   92:                                        <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
1.112     kristaps   93:                                        </TD>
                     94:                                </TR>
1.148     kristaps   95:                                <TR>
                     96:                                        <TD>pkgsrc</TD>
                     97:                                        <TD>
                     98:                                        <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
                     99:                                        </TD>
                    100:                                </TR>
1.153     kristaps  101:                                <TR>
                    102:                                        <TD>Minix3</TD>
                    103:                                        <TD>
                    104:                                        <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
                    105:                                        </TD>
                    106:                                </TR>
1.112     kristaps  107:                        </TBODY>
                    108:                </TABLE>
                    109:                <H1>
1.118     kristaps  110:                        <A NAME="documentation">Documentation</A>
1.112     kristaps  111:                </H1>
                    112:                <P>
1.135     kristaps  113:                        These manuals are generated automatically and refer to the current release.
                    114:                        They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112     kristaps  115:                </P>
                    116:
                    117:                <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136     kristaps  118:                        <COL WIDTH="175">
1.112     kristaps  119:                        <COL>
                    120:                        <TBODY>
                    121:                                <TR>
1.144     kristaps  122:                                        <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
1.112     kristaps  123:                                        <TD VALIGN="top">
1.144     kristaps  124:                                                search the manual page database
                    125:                                                        (<A HREF="apropos.1.txt">text</A> |
                    126:                                                        <A HREF="apropos.1.xhtml">xhtml</A> |
                    127:                                                        <A HREF="apropos.1.pdf">pdf</A> |
                    128:                                                        <A HREF="apropos.1.ps">ps</A>)
1.112     kristaps  129:                                        </TD>
                    130:                                </TR>
                    131:                                <TR>
1.138     kristaps  132:                                        <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114     kristaps  133:                                        <TD VALIGN="top">
1.138     kristaps  134:                                                emit only text of UNIX manuals
                    135:                                                        (<A HREF="demandoc.1.txt">text</A> |
                    136:                                                        <A HREF="demandoc.1.xhtml">xhtml</A> |
                    137:                                                        <A HREF="demandoc.1.pdf">pdf</A> |
                    138:                                                        <A HREF="demandoc.1.ps">ps</A>)
1.114     kristaps  139:                                        </TD>
                    140:                                </TR>
                    141:                                <TR>
1.144     kristaps  142:                                        <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
                    143:                                        <TD VALIGN="top">
                    144:                                                format and display UNIX manuals
                    145:                                                        (<A HREF="mandoc.1.txt">text</A> |
                    146:                                                        <A HREF="mandoc.1.xhtml">xhtml</A> |
                    147:                                                        <A HREF="mandoc.1.pdf">pdf</A> |
                    148:                                                        <A HREF="mandoc.1.ps">ps</A>)
                    149:                                        </TD>
                    150:                                </TR>
                    151:                                <TR>
1.120     kristaps  152:                                        <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                    153:                                        <TD VALIGN="top">
                    154:                                                recode multibyte UNIX manuals
                    155:                                                        (<A HREF="preconv.1.txt">text</A> |
                    156:                                                        <A HREF="preconv.1.xhtml">xhtml</A> |
                    157:                                                        <A HREF="preconv.1.pdf">pdf</A> |
1.136     kristaps  158:                                                        <A HREF="preconv.1.ps">ps</A>)
1.120     kristaps  159:                                        </TD>
                    160:                                </TR>
                    161:                                <TR>
1.149     kristaps  162:                                        <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>
                    163:                                        <TD VALIGN="top">
                    164:                                                search the manual page database
                    165:                                                        (<A HREF="whatis.1.txt">text</A> |
                    166:                                                        <A HREF="whatis.1.xhtml">xhtml</A> |
                    167:                                                        <A HREF="whatis.1.pdf">pdf</A> |
                    168:                                                        <A HREF="whatis.1.ps">ps</A>)
                    169:                                        </TD>
                    170:                                </TR>
                    171:                                <TR>
1.112     kristaps  172:                                        <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                    173:                                        <TD VALIGN="top">
                    174:                                                mandoc macro compiler library
                    175:                                                        (<A HREF="mandoc.3.txt">text</A> |
                    176:                                                        <A HREF="mandoc.3.xhtml">xhtml</A> |
                    177:                                                        <A HREF="mandoc.3.pdf">pdf</A> |
1.136     kristaps  178:                                                        <A HREF="mandoc.3.ps">ps</A>)
1.112     kristaps  179:                                        </TD>
                    180:                                </TR>
                    181:                                <TR>
                    182:                                        <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
                    183:                                        <TD VALIGN="top">
                    184:                                                man language reference
                    185:                                                        (<A HREF="man.7.txt">text</A> |
                    186:                                                        <A HREF="man.7.xhtml">xhtml</A> |
                    187:                                                        <A HREF="man.7.pdf">pdf</A> |
1.136     kristaps  188:                                                        <A HREF="man.7.ps">ps</A>)
1.112     kristaps  189:                                        </TD>
                    190:                                </TR>
                    191:                                <TR>
1.150     kristaps  192:                                        <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
                    193:                                        <TD VALIGN="top">
                    194:                                                cgi for manpage query and display
                    195:                                                        (<A HREF="man.cgi.7.txt">text</A> |
                    196:                                                        <A HREF="man.cgi.7.xhtml">xhtml</A> |
                    197:                                                        <A HREF="man.cgi.7.pdf">pdf</A> |
                    198:                                                        <A HREF="man.cgi.7.ps">ps</A>)
                    199:                                        </TD>
                    200:                                </TR>
                    201:                                <TR>
1.112     kristaps  202:                                        <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
                    203:                                        <TD VALIGN="top">
                    204:                                                eqn-mandoc language reference
                    205:                                                        (<A HREF="eqn.7.txt">text</A> |
                    206:                                                        <A HREF="eqn.7.xhtml">xhtml</A> |
                    207:                                                        <A HREF="eqn.7.pdf">pdf</A> |
1.136     kristaps  208:                                                        <A HREF="eqn.7.ps">ps</A>)
1.112     kristaps  209:                                        </TD>
                    210:                                </TR>
                    211:                                <TR>
                    212:                                        <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
                    213:                                        <TD VALIGN="top">
                    214:                                                mandoc special characters
                    215:                                                        (<A HREF="mandoc_char.7.txt">text</A> |
                    216:                                                        <A HREF="mandoc_char.7.xhtml">xhtml</A> |
                    217:                                                        <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136     kristaps  218:                                                        <A HREF="mandoc_char.7.ps">ps</A>)
1.112     kristaps  219:                                        </TD>
                    220:                                </TR>
                    221:                                <TR>
                    222:                                        <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
                    223:                                        <TD VALIGN="top">
                    224:                                                mdoc language reference
                    225:                                                        (<A HREF="mdoc.7.txt">text</A> |
                    226:                                                        <A HREF="mdoc.7.xhtml">xhtml</A> |
                    227:                                                        <A HREF="mdoc.7.pdf">pdf</A> |
1.136     kristaps  228:                                                        <A HREF="mdoc.7.ps">ps</A>)
1.112     kristaps  229:                                        </TD>
                    230:                                </TR>
                    231:                                <TR>
                    232:                                        <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
                    233:                                        <TD VALIGN="top">
                    234:                                                roff-mandoc language reference
                    235:                                                        (<A HREF="roff.7.txt">text</A> |
                    236:                                                        <A HREF="roff.7.xhtml">xhtml</A> |
                    237:                                                        <A HREF="roff.7.pdf">pdf</A> |
1.136     kristaps  238:                                                        <A HREF="roff.7.ps">ps</A>)
1.112     kristaps  239:                                        </TD>
                    240:                                </TR>
                    241:                                <TR>
                    242:                                        <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
                    243:                                        <TD VALIGN="top">
                    244:                                                tbl-mandoc language reference
                    245:                                                        (<A HREF="tbl.7.txt">text</A> |
                    246:                                                        <A HREF="tbl.7.xhtml">xhtml</A> |
                    247:                                                        <A HREF="tbl.7.pdf">pdf</A> |
1.136     kristaps  248:                                                        <A HREF="tbl.7.ps">ps</A>)
1.112     kristaps  249:                                        </TD>
                    250:                                </TR>
1.138     kristaps  251:                                <TR>
1.150     kristaps  252:                                        <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>
                    253:                                        <TD VALIGN="top">
                    254:                                                update a man.cgi manpage cache
                    255:                                                        (<A HREF="catman.8.txt">text</A> |
                    256:                                                        <A HREF="catman.8.xhtml">xhtml</A> |
                    257:                                                        <A HREF="catman.8.pdf">pdf</A> |
                    258:                                                        <A HREF="catman.8.ps">ps</A>)
                    259:                                        </TD>
                    260:                                </TR>
                    261:                                <TR>
1.138     kristaps  262:                                        <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                    263:                                        <TD VALIGN="top">
                    264:                                                index UNIX manuals
                    265:                                                        (<A HREF="mandocdb.8.txt">text</A> |
                    266:                                                        <A HREF="mandocdb.8.xhtml">xhtml</A> |
                    267:                                                        <A HREF="mandocdb.8.pdf">pdf</A> |
                    268:                                                        <A HREF="mandocdb.8.ps">ps</A>)
                    269:                                        </TD>
                    270:                                </TR>
1.112     kristaps  271:                        </TBODY>
                    272:                </TABLE>
                    273:                <H1>
1.118     kristaps  274:                        <A NAME="contact">Contact</A>
1.112     kristaps  275:                </H1>
                    276:                <P>
1.139     kristaps  277:                        Use the mailing lists for bug-reports, patches, questions, etc.  Please check the
1.112     kristaps  278:                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139     kristaps  279:                        before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
                    280:                        contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.149     kristaps  281:                        this e-mail address">kris...</A>@bsd.lv.  Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
1.112     kristaps  282:                </P>
                    283:                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136     kristaps  284:                        <COL WIDTH="175">
1.112     kristaps  285:                        <COL>
                    286:                        <TBODY>
                    287:                                <TR>
                    288:                                        <TD>
                    289:                                                disc<A CLASS="external" TITLE="Reveal this e-mail address"
                    290:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
                    291:                                        </TD>
                    292:                                        <TD>
                    293:                                                bug-reports, general questions, and announcements
                    294:                                        </TD>
                    295:                                </TR>
                    296:                                <TR>
                    297:                                        <TD>
                    298:                                                tec<A CLASS="external" TITLE="Reveal this e-mail address"
                    299:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&amp;c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
                    300:                                        </TD>
                    301:                                        <TD>
                    302:                                                patches and system discussions
                    303:                                        </TD>
                    304:                                </TR>
                    305:                                <TR>
                    306:                                        <TD>
                    307:                                                sou<A CLASS="external" TITLE="Reveal this e-mail address"
                    308:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
                    309:                                        </TD>
                    310:                                        <TD>
                    311:                                                source commit messages
                    312:                                        </TD>
                    313:                                </TR>
                    314:                        </TBODY>
                    315:                </TABLE>
                    316:                <H1>
1.118     kristaps  317:                        <A NAME="news">News</A>
1.112     kristaps  318:                </H1>
1.124     kristaps  319:                <P CLASS="news">
1.152     kristaps  320:                        23-03-2011: version 1.12.1
1.149     kristaps  321:                </P>
                    322:                <P>
                    323:                        Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>.  These tools are
1.152     kristaps  324:                        now much more robust.
                    325:                        A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.
                    326:                        These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility
                    327:                        such as GNU troff.
1.150     kristaps  328:                </P>
                    329:                <P>
                    330:                        The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing.  It interfaces with <A
                    331:                        HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>.  HTML output is generated
                    332:                        on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.
1.149     kristaps  333:                </P>
1.151     kristaps  334:                <P>
1.152     kristaps  335:                        The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"
1.151     kristaps  336:                        HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"
                    337:                        CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"
                    338:                        CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.
                    339:                </P>
1.142     kristaps  340:                <P>
1.152     kristaps  341:                        Lastly, I'm no longer providing binaries, as nobody has asked for them.
1.141     schwarze  342:                </P>
1.112     kristaps  343:                <P>
                    344:                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                    345:                        historical notes.
                    346:                </P>
                    347:                <P CLASS="foot">
1.118     kristaps  348:                        <SMALL>
                    349:                                Copyright &#169; 2008&#8211;2011
                    350:                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.154   ! kristaps  351:                                $Date: 2012/03/24 02:07:32 $
1.118     kristaps  352:                        </SMALL>
1.112     kristaps  353:                </P>
1.40      kristaps  354:        </BODY>
                    355: </HTML>

CVSweb