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

Annotation of mandoc/index.sgml, Revision 1.139

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.47      kristaps    6:                <TITLE>mdocml | mdoc macro compiler</TITLE>
1.40      kristaps    7:        </HEAD>
                      8:        <BODY>
1.112     kristaps    9:                <P CLASS="head">
1.136     kristaps   10:                        <B>mdocml</B> &#8211; mdoc macro compiler, current version @VERSION@ (@VDATE@)
                     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>)
                     16:                        |
                     17:                        Binaries: <A
                     18:                        HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A
                     19:                        HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A
                     20:                        HREF="/binaries/mdocml-macosx.zip">mac os x</A>
                     21:                        (<A HREF="/binaries/">archives</A>)
1.112     kristaps   22:                </P>
                     23:                <H1>
1.118     kristaps   24:                        <A NAME="description">Description</A>
1.112     kristaps   25:                </H1>
                     26:                <P>
                     27:                        <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
                     28:                        package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
                     29:                        UNIX 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 troff implementation, for displaying <I>mdoc</I>
                     31:                        pages whilst providing token support for <I>man</I>.
                     32:                </P>
                     33:                <P>
                     34:                        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
                     35:                        uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A
                     36:                        CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
                     37:                </P>
                     38:                <P>
                     39:                        <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
1.121     kristaps   40:                        HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
                     41:                        support for wide-character locales), XHTML, HTML, PostScript, and PDF.
1.138     kristaps   42:                        It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
                     43:                        <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
                     44:                        and <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals.
1.121     kristaps   45:                        It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
1.112     kristaps   46:                </P>
                     47:                <P>
                     48:                        <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                     49:                </P>
1.137     kristaps   50:                <H2>
1.118     kristaps   51:                        <A NAME="sources">Sources</A>
1.137     kristaps   52:                </H2>
1.112     kristaps   53:                <P>
1.135     kristaps   54:                        <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.
                     55:                        To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
                     56:                        Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.
                     57:                        The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact
                     58:                        us</A> if you plan to use it.
1.132     kristaps   59:                </P>
1.137     kristaps   60:                <H2>
1.135     kristaps   61:                        <A NAME="binaries">Binaries</A>
1.137     kristaps   62:                </H2>
1.132     kristaps   63:                <P>
1.135     kristaps   64:                        Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
                     65:                        Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
                     66:                        Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
                     67:                        64-bit (x86_64) architectures.
1.121     kristaps   68:                </P>
1.137     kristaps   69:                <H2>
1.112     kristaps   70:                        Downstream
1.137     kristaps   71:                </H2>
1.135     kristaps   72:                <P>
                     73:                        Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
                     74:                        If your system does not appear below, the maintainers have not contacted me and it should not be considered
                     75:                        <Q>official</Q>.
                     76:                        Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
                     77:                </P>
1.112     kristaps   78:                <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
1.136     kristaps   79:                        <COL WIDTH="175">
1.112     kristaps   80:                        <COL>
                     81:                        <TBODY>
                     82:                                <TR>
                     83:                                        <TD>DragonFly BSD</TD>
                     84:                                        <TD>
                     85:                                        <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
                     86:                                                CLASS="external">usr.bin/mandoc</A>
                     87:                                        </TD>
                     88:                                </TR>
                     89:                                <TR>
                     90:                                        <TD>FreeBSD</TD>
                     91:                                        <TD>
                     92:                                        <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
                     93:                                                CLASS="external">ports/textproc/mdocml</A>
                     94:                                        </TD>
                     95:                                </TR>
                     96:                                <TR>
                     97:                                        <TD>NetBSD</TD>
                     98:                                        <TD>
                     99:                                        <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
                    100:                                                CLASS="external">src/external/bsd/mdocml</A>
                    101:                                        </TD>
                    102:                                </TR>
                    103:                                <TR>
                    104:                                        <TD>OpenBSD</TD>
                    105:                                        <TD>
                    106:                                        <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
                    107:                                                CLASS="external">src/usr.bin/mandoc</A>
                    108:                                        </TD>
                    109:                                </TR>
                    110:                        </TBODY>
                    111:                </TABLE>
                    112:                <H1>
1.118     kristaps  113:                        <A NAME="documentation">Documentation</A>
1.112     kristaps  114:                </H1>
                    115:                <P>
1.135     kristaps  116:                        These manuals are generated automatically and refer to the current release.
                    117:                        They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
1.112     kristaps  118:                </P>
                    119:
                    120:                <TABLE WIDTH="100%" SUMMARY="Documentation">
1.136     kristaps  121:                        <COL WIDTH="175">
1.112     kristaps  122:                        <COL>
                    123:                        <TBODY>
                    124:                                <TR>
                    125:                                        <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
                    126:                                        <TD VALIGN="top">
                    127:                                                format and display UNIX manuals
                    128:                                                        (<A HREF="mandoc.1.txt">text</A> |
                    129:                                                        <A HREF="mandoc.1.xhtml">xhtml</A> |
                    130:                                                        <A HREF="mandoc.1.pdf">pdf</A> |
1.136     kristaps  131:                                                        <A HREF="mandoc.1.ps">ps</A>)
1.112     kristaps  132:                                        </TD>
                    133:                                </TR>
                    134:                                <TR>
1.138     kristaps  135:                                        <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
1.114     kristaps  136:                                        <TD VALIGN="top">
1.138     kristaps  137:                                                emit only text of UNIX manuals
                    138:                                                        (<A HREF="demandoc.1.txt">text</A> |
                    139:                                                        <A HREF="demandoc.1.xhtml">xhtml</A> |
                    140:                                                        <A HREF="demandoc.1.pdf">pdf</A> |
                    141:                                                        <A HREF="demandoc.1.ps">ps</A>)
1.114     kristaps  142:                                        </TD>
                    143:                                </TR>
                    144:                                <TR>
1.120     kristaps  145:                                        <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                    146:                                        <TD VALIGN="top">
                    147:                                                recode multibyte UNIX manuals
                    148:                                                        (<A HREF="preconv.1.txt">text</A> |
                    149:                                                        <A HREF="preconv.1.xhtml">xhtml</A> |
                    150:                                                        <A HREF="preconv.1.pdf">pdf</A> |
1.136     kristaps  151:                                                        <A HREF="preconv.1.ps">ps</A>)
1.120     kristaps  152:                                        </TD>
                    153:                                </TR>
                    154:                                <TR>
1.112     kristaps  155:                                        <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                    156:                                        <TD VALIGN="top">
                    157:                                                mandoc macro compiler library
                    158:                                                        (<A HREF="mandoc.3.txt">text</A> |
                    159:                                                        <A HREF="mandoc.3.xhtml">xhtml</A> |
                    160:                                                        <A HREF="mandoc.3.pdf">pdf</A> |
1.136     kristaps  161:                                                        <A HREF="mandoc.3.ps">ps</A>)
1.112     kristaps  162:                                        </TD>
                    163:                                </TR>
                    164:                                <TR>
                    165:                                        <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
                    166:                                        <TD VALIGN="top">
                    167:                                                man language reference
                    168:                                                        (<A HREF="man.7.txt">text</A> |
                    169:                                                        <A HREF="man.7.xhtml">xhtml</A> |
                    170:                                                        <A HREF="man.7.pdf">pdf</A> |
1.136     kristaps  171:                                                        <A HREF="man.7.ps">ps</A>)
1.112     kristaps  172:                                        </TD>
                    173:                                </TR>
                    174:                                <TR>
                    175:                                        <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
                    176:                                        <TD VALIGN="top">
                    177:                                                eqn-mandoc language reference
                    178:                                                        (<A HREF="eqn.7.txt">text</A> |
                    179:                                                        <A HREF="eqn.7.xhtml">xhtml</A> |
                    180:                                                        <A HREF="eqn.7.pdf">pdf</A> |
1.136     kristaps  181:                                                        <A HREF="eqn.7.ps">ps</A>)
1.112     kristaps  182:                                        </TD>
                    183:                                </TR>
                    184:                                <TR>
                    185:                                        <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
                    186:                                        <TD VALIGN="top">
                    187:                                                mandoc special characters
                    188:                                                        (<A HREF="mandoc_char.7.txt">text</A> |
                    189:                                                        <A HREF="mandoc_char.7.xhtml">xhtml</A> |
                    190:                                                        <A HREF="mandoc_char.7.pdf">pdf</A> |
1.136     kristaps  191:                                                        <A HREF="mandoc_char.7.ps">ps</A>)
1.112     kristaps  192:                                        </TD>
                    193:                                </TR>
                    194:                                <TR>
                    195:                                        <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
                    196:                                        <TD VALIGN="top">
                    197:                                                mdoc language reference
                    198:                                                        (<A HREF="mdoc.7.txt">text</A> |
                    199:                                                        <A HREF="mdoc.7.xhtml">xhtml</A> |
                    200:                                                        <A HREF="mdoc.7.pdf">pdf</A> |
1.136     kristaps  201:                                                        <A HREF="mdoc.7.ps">ps</A>)
1.112     kristaps  202:                                        </TD>
                    203:                                </TR>
                    204:                                <TR>
                    205:                                        <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
                    206:                                        <TD VALIGN="top">
                    207:                                                roff-mandoc language reference
                    208:                                                        (<A HREF="roff.7.txt">text</A> |
                    209:                                                        <A HREF="roff.7.xhtml">xhtml</A> |
                    210:                                                        <A HREF="roff.7.pdf">pdf</A> |
1.136     kristaps  211:                                                        <A HREF="roff.7.ps">ps</A>)
1.112     kristaps  212:                                        </TD>
                    213:                                </TR>
                    214:                                <TR>
                    215:                                        <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
                    216:                                        <TD VALIGN="top">
                    217:                                                tbl-mandoc language reference
                    218:                                                        (<A HREF="tbl.7.txt">text</A> |
                    219:                                                        <A HREF="tbl.7.xhtml">xhtml</A> |
                    220:                                                        <A HREF="tbl.7.pdf">pdf</A> |
1.136     kristaps  221:                                                        <A HREF="tbl.7.ps">ps</A>)
1.112     kristaps  222:                                        </TD>
                    223:                                </TR>
1.138     kristaps  224:                                <TR>
                    225:                                        <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                    226:                                        <TD VALIGN="top">
                    227:                                                index UNIX manuals
                    228:                                                        (<A HREF="mandocdb.8.txt">text</A> |
                    229:                                                        <A HREF="mandocdb.8.xhtml">xhtml</A> |
                    230:                                                        <A HREF="mandocdb.8.pdf">pdf</A> |
                    231:                                                        <A HREF="mandocdb.8.ps">ps</A>)
                    232:                                        </TD>
                    233:                                </TR>
1.112     kristaps  234:                        </TBODY>
                    235:                </TABLE>
                    236:                <H1>
1.118     kristaps  237:                        <A NAME="contact">Contact</A>
1.112     kristaps  238:                </H1>
                    239:                <P>
1.139   ! kristaps  240:                        Use the mailing lists for bug-reports, patches, questions, etc.  Please check the
1.112     kristaps  241:                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
1.139   ! kristaps  242:                        before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
        !           243:                        contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
1.112     kristaps  244:                        this e-mail address">kris...</A>@bsd.lv.
                    245:                </P>
                    246:                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
1.136     kristaps  247:                        <COL WIDTH="175">
1.112     kristaps  248:                        <COL>
                    249:                        <TBODY>
                    250:                                <TR>
                    251:                                        <TD>
                    252:                                                disc<A CLASS="external" TITLE="Reveal this e-mail address"
                    253:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
                    254:                                        </TD>
                    255:                                        <TD>
                    256:                                                bug-reports, general questions, and announcements
1.136     kristaps  257:                                                (<A HREF="/archives/discuss/summary.html">archive</A>)
1.112     kristaps  258:                                        </TD>
                    259:                                </TR>
                    260:                                <TR>
                    261:                                        <TD>
                    262:                                                tec<A CLASS="external" TITLE="Reveal this e-mail address"
                    263:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&amp;c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
                    264:                                        </TD>
                    265:                                        <TD>
                    266:                                                patches and system discussions
1.136     kristaps  267:                                                (<A HREF="/archives/tech/summary.html">archive</A>)
1.112     kristaps  268:                                        </TD>
                    269:                                </TR>
                    270:                                <TR>
                    271:                                        <TD>
                    272:                                                sou<A CLASS="external" TITLE="Reveal this e-mail address"
                    273:                                                HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
                    274:                                        </TD>
                    275:                                        <TD>
                    276:                                                source commit messages
1.136     kristaps  277:                                                (<A HREF="/archives/source/summary.html">archive</A>)
1.112     kristaps  278:                                        </TD>
                    279:                                </TR>
                    280:                        </TBODY>
                    281:                </TABLE>
                    282:                <H1>
1.118     kristaps  283:                        <A NAME="news">News</A>
1.112     kristaps  284:                </H1>
1.124     kristaps  285:                <P CLASS="news">
1.139   ! kristaps  286:                        02-09-2011: version 1.11.7
1.138     kristaps  287:                </P>
                    288:                <P>
                    289:                        Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes.  This replaces the
1.139   ! kristaps  290:                        historical <CODE>deroff</CODE> utility.  Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.
1.138     kristaps  291:                </P>
                    292:                <P CLASS="news">
1.134     kristaps  293:                        16-08-2011: version 1.11.6
                    294:                </P>
                    295:                <P>
                    296:                        Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented.  This makes Perl documentation much more
                    297:                        readable.  Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents.  Many other general
1.135     kristaps  298:                        improvements have been implemented.  Furthermore, a 64-bit Windows binary is now available at <A
                    299:                        HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
                    300:                        HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
1.134     kristaps  301:                </P>
                    302:                <P CLASS="news">
1.131     kristaps  303:                        24-07-2011: version 1.11.5
1.129     kristaps  304:                </P>
                    305:                <P>
1.130     kristaps  306:                        Significant <A HREF="eqn.7.html">eqn</A> improvements.  <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
                    307:                        (although few GNU extensions are accepted, nor is mixing low-level roff with eqn).  See the <A HREF="eqn.7.html">eqn</A>
                    308:                        manual for details.  For the time being, equations are rendered as simple in-line text.  The equation parser satisfies
                    309:                        the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
1.131     kristaps  310:                        Edition User's Guide</A>.
1.129     kristaps  311:                </P>
1.132     kristaps  312:                <P>
                    313:                        This is also the first release featuring a distributed Windows binary, available at <A
                    314:                        HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
                    315:                </P>
1.112     kristaps  316:                <P>
                    317:                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                    318:                        historical notes.
                    319:                </P>
                    320:                <P CLASS="foot">
1.118     kristaps  321:                        <SMALL>
                    322:                                Copyright &#169; 2008&#8211;2011
                    323:                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
1.139   ! kristaps  324:                                $Date: 2011/09/01 10:46:28 $
1.118     kristaps  325:                        </SMALL>
1.112     kristaps  326:                </P>
1.40      kristaps  327:        </BODY>
                    328: </HTML>

CVSweb