index.sgml

   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                 <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
   6                 <TITLE>mdocml | mdoc macro compiler</TITLE>
   7         </HEAD>
   8         <BODY>
   9                 <P CLASS="head">
  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>)
  22                 </P>
  23                 <H1>
  24                         <A NAME="description">Description</A>
  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
  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.
  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                         <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
  45                         <A HREF="apropos.1.html">apropos</A>, for semantic search of manual content (both <B>mandocdb</B> and <B>apropos</B> are
  46                         still experimental).
  47                         It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
  48                 </P>
  49                 <P>
  50                         <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
  51                 </P>
  52                 <H2>
  53                         <A NAME="sources">Sources</A>
  54                 </H2>
  55                 <P>
  56                         <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
  57                         need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
  58                         HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
  59                         systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just
  60                         run <CODE>make install</CODE>.  Be careful: the <B>preconv</B> and <B>apropos</B> binary names are usually taken by
  61                         existing utilities.
  62                 </P>
  63                 <H2>
  64                         <A NAME="binaries">Binaries</A>
  65                 </H2>
  66                 <P>
  67                         Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
  68                         Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
  69                         Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
  70                         64-bit (x86_64) architectures.
  71                 </P>
  72                 <H2>
  73                         Downstream
  74                 </H2>
  75                 <P>
  76                         Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
  77                         If your system does not appear below, the maintainers have not contacted me and it should not be considered
  78                         <Q>official</Q>.
  79                         Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
  80                 </P>
  81                 <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
  82                         <COL WIDTH="175">
  83                         <COL>
  84                         <TBODY>
  85                                 <TR>
  86                                         <TD>DragonFly BSD</TD>
  87                                         <TD>
  88                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
  89                                                 CLASS="external">usr.bin/mandoc</A>
  90                                         </TD>
  91                                 </TR>
  92                                 <TR>
  93                                         <TD>FreeBSD</TD>
  94                                         <TD>
  95                                         <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
  96                                                 CLASS="external">ports/textproc/mdocml</A>
  97                                         </TD>
  98                                 </TR>
  99                                 <TR>
 100                                         <TD>NetBSD</TD>
 101                                         <TD>
 102                                         <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
 103                                                 CLASS="external">src/external/bsd/mdocml</A>
 104                                         </TD>
 105                                 </TR>
 106                                 <TR>
 107                                         <TD>OpenBSD</TD>
 108                                         <TD>
 109                                         <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
 110                                                 CLASS="external">src/usr.bin/mandoc</A>
 111                                         </TD>
 112                                 </TR>
 113                         </TBODY>
 114                 </TABLE>
 115                 <H1>
 116                         <A NAME="documentation">Documentation</A>
 117                 </H1>
 118                 <P>
 119                         These manuals are generated automatically and refer to the current release.
 120                         They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
 121                 </P>
 122
 123                 <TABLE WIDTH="100%" SUMMARY="Documentation">
 124                         <COL WIDTH="175">
 125                         <COL>
 126                         <TBODY>
 127                                 <TR>
 128                                         <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
 129                                         <TD VALIGN="top">
 130                                                 search the manual page database
 131                                                         (<A HREF="apropos.1.txt">text</A> |
 132                                                         <A HREF="apropos.1.xhtml">xhtml</A> |
 133                                                         <A HREF="apropos.1.pdf">pdf</A> |
 134                                                         <A HREF="apropos.1.ps">ps</A>)
 135                                         </TD>
 136                                 </TR>
 137                                 <TR>
 138                                         <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
 139                                         <TD VALIGN="top">
 140                                                 emit only text of UNIX manuals
 141                                                         (<A HREF="demandoc.1.txt">text</A> |
 142                                                         <A HREF="demandoc.1.xhtml">xhtml</A> |
 143                                                         <A HREF="demandoc.1.pdf">pdf</A> |
 144                                                         <A HREF="demandoc.1.ps">ps</A>)
 145                                         </TD>
 146                                 </TR>
 147                                 <TR>
 148                                         <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
 149                                         <TD VALIGN="top">
 150                                                 format and display UNIX manuals
 151                                                         (<A HREF="mandoc.1.txt">text</A> |
 152                                                         <A HREF="mandoc.1.xhtml">xhtml</A> |
 153                                                         <A HREF="mandoc.1.pdf">pdf</A> |
 154                                                         <A HREF="mandoc.1.ps">ps</A>)
 155                                         </TD>
 156                                 </TR>
 157                                 <TR>
 158                                         <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
 159                                         <TD VALIGN="top">
 160                                                 recode multibyte UNIX manuals
 161                                                         (<A HREF="preconv.1.txt">text</A> |
 162                                                         <A HREF="preconv.1.xhtml">xhtml</A> |
 163                                                         <A HREF="preconv.1.pdf">pdf</A> |
 164                                                         <A HREF="preconv.1.ps">ps</A>)
 165                                         </TD>
 166                                 </TR>
 167                                 <TR>
 168                                         <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
 169                                         <TD VALIGN="top">
 170                                                 mandoc macro compiler library
 171                                                         (<A HREF="mandoc.3.txt">text</A> |
 172                                                         <A HREF="mandoc.3.xhtml">xhtml</A> |
 173                                                         <A HREF="mandoc.3.pdf">pdf</A> |
 174                                                         <A HREF="mandoc.3.ps">ps</A>)
 175                                         </TD>
 176                                 </TR>
 177                                 <TR>
 178                                         <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
 179                                         <TD VALIGN="top">
 180                                                 man language reference
 181                                                         (<A HREF="man.7.txt">text</A> |
 182                                                         <A HREF="man.7.xhtml">xhtml</A> |
 183                                                         <A HREF="man.7.pdf">pdf</A> |
 184                                                         <A HREF="man.7.ps">ps</A>)
 185                                         </TD>
 186                                 </TR>
 187                                 <TR>
 188                                         <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
 189                                         <TD VALIGN="top">
 190                                                 eqn-mandoc language reference
 191                                                         (<A HREF="eqn.7.txt">text</A> |
 192                                                         <A HREF="eqn.7.xhtml">xhtml</A> |
 193                                                         <A HREF="eqn.7.pdf">pdf</A> |
 194                                                         <A HREF="eqn.7.ps">ps</A>)
 195                                         </TD>
 196                                 </TR>
 197                                 <TR>
 198                                         <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
 199                                         <TD VALIGN="top">
 200                                                 mandoc special characters
 201                                                         (<A HREF="mandoc_char.7.txt">text</A> |
 202                                                         <A HREF="mandoc_char.7.xhtml">xhtml</A> |
 203                                                         <A HREF="mandoc_char.7.pdf">pdf</A> |
 204                                                         <A HREF="mandoc_char.7.ps">ps</A>)
 205                                         </TD>
 206                                 </TR>
 207                                 <TR>
 208                                         <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
 209                                         <TD VALIGN="top">
 210                                                 mdoc language reference
 211                                                         (<A HREF="mdoc.7.txt">text</A> |
 212                                                         <A HREF="mdoc.7.xhtml">xhtml</A> |
 213                                                         <A HREF="mdoc.7.pdf">pdf</A> |
 214                                                         <A HREF="mdoc.7.ps">ps</A>)
 215                                         </TD>
 216                                 </TR>
 217                                 <TR>
 218                                         <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
 219                                         <TD VALIGN="top">
 220                                                 roff-mandoc language reference
 221                                                         (<A HREF="roff.7.txt">text</A> |
 222                                                         <A HREF="roff.7.xhtml">xhtml</A> |
 223                                                         <A HREF="roff.7.pdf">pdf</A> |
 224                                                         <A HREF="roff.7.ps">ps</A>)
 225                                         </TD>
 226                                 </TR>
 227                                 <TR>
 228                                         <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
 229                                         <TD VALIGN="top">
 230                                                 tbl-mandoc language reference
 231                                                         (<A HREF="tbl.7.txt">text</A> |
 232                                                         <A HREF="tbl.7.xhtml">xhtml</A> |
 233                                                         <A HREF="tbl.7.pdf">pdf</A> |
 234                                                         <A HREF="tbl.7.ps">ps</A>)
 235                                         </TD>
 236                                 </TR>
 237                                 <TR>
 238                                         <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
 239                                         <TD VALIGN="top">
 240                                                 index UNIX manuals
 241                                                         (<A HREF="mandocdb.8.txt">text</A> |
 242                                                         <A HREF="mandocdb.8.xhtml">xhtml</A> |
 243                                                         <A HREF="mandocdb.8.pdf">pdf</A> |
 244                                                         <A HREF="mandocdb.8.ps">ps</A>)
 245                                         </TD>
 246                                 </TR>
 247                         </TBODY>
 248                 </TABLE>
 249                 <H1>
 250                         <A NAME="contact">Contact</A>
 251                 </H1>
 252                 <P>
 253                         Use the mailing lists for bug-reports, patches, questions, etc.  Please check the
 254                         <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
 255                         before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
 256                         contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
 257                         this e-mail address">kris...</A>@bsd.lv.
 258                 </P>
 259                 <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
 260                         <COL WIDTH="175">
 261                         <COL>
 262                         <TBODY>
 263                                 <TR>
 264                                         <TD>
 265                                                 disc<A CLASS="external" TITLE="Reveal this e-mail address"
 266                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
 267                                         </TD>
 268                                         <TD>
 269                                                 bug-reports, general questions, and announcements
 270                                                 (<A HREF="/archives/discuss/">archive</A>)
 271                                         </TD>
 272                                 </TR>
 273                                 <TR>
 274                                         <TD>
 275                                                 tec<A CLASS="external" TITLE="Reveal this e-mail address"
 276                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&amp;c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
 277                                         </TD>
 278                                         <TD>
 279                                                 patches and system discussions
 280                                                 (<A HREF="/archives/tech/">archive</A>)
 281                                         </TD>
 282                                 </TR>
 283                                 <TR>
 284                                         <TD>
 285                                                 sou<A CLASS="external" TITLE="Reveal this e-mail address"
 286                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
 287                                         </TD>
 288                                         <TD>
 289                                                 source commit messages
 290                                                 (<A HREF="/archives/source/">archive</A>)
 291                                         </TD>
 292                                 </TR>
 293                         </TBODY>
 294                 </TABLE>
 295                 <H1>
 296                         <A NAME="news">News</A>
 297                 </H1>
 298                 <P CLASS="news">
 299                         08-10-2011: version 1.12.0
 300                 </P>
 301                 <P>
 302                         This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>.  This mode
 303                         allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively
 304                         support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.
 305                         The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes.
 306                 </P>
 307                 <P>
 308                         While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.
 309                         This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content.  <A
 310                         HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search
 311                         (such as for functions, utilities, etc.) and regular expressions.
 312                         Note that the calling syntax for <B>apropos</B> is likely to change as it settles down.
 313                 </P>
 314                 <P>
 315                         In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made
 316                         considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE
 317                         SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections
 318                         down to the bottom of the page.
 319                 </P>
 320                 <P>
 321                         Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
 322                         completely.  It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both
 323                         with and without frames and rulers.  Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and
 324                         several bugs were fixed regarding indentation and alignment.  The page headers in <A HREF="mdoc.7.html">mdoc</A> are now
 325                         nicer for very long titles.
 326                 </P>
 327                 <P CLASS="news">
 328                         02-09-2011: version 1.11.7
 329                 </P>
 330                 <P>
 331                         Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes.  This replaces the
 332                         historical <CODE>deroff</CODE> utility.  Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.
 333                 </P>
 334                 <P CLASS="news">
 335                         16-08-2011: version 1.11.6
 336                 </P>
 337                 <P>
 338                         Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented.  This makes Perl documentation much more
 339                         readable.  Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents.  Many other general
 340                         improvements have been implemented.  Furthermore, a 64-bit Windows binary is now available at <A
 341                         HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
 342                         HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
 343                 </P>
 344                 <P>
 345                         See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
 346                         historical notes.
 347                 </P>
 348                 <P CLASS="foot">
 349                         <SMALL>
 350                                 Copyright &#169; 2008&#8211;2011
 351                                 <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
 352                                 $Date: 2011/10/08 13:01:44 $
 353                         </SMALL>
 354                 </P>
 355         </BODY>
 356 </HTML>