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                 <META NAME="resource-type" CONTENT="document">
   6                 <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
   7                 <TITLE>mdocml | mdoc macro compiler</TITLE>
   8         </HEAD>
   9         <BODY>
  10         <TABLE CLASS="frame" SUMMARY="[frame]">
  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>
  27                                         <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package
  28                                         of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX
  29                                         manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
  30                                         HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for
  31                                         displaying -mdoc pages whilst providing token support for -man.
  32                                         </P>
  33
  34                                         <P>
  35                                         Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
  36                                         slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
  37                                         this (respectively small, C, ISC-licensed, fast and regular).
  38                                         </P>
  39
  40                                         <P>
  41                                         The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i>
  42                                         validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
  43                                         be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
  44                                         mandoc</i>, which formats manuals for display on the terminal.
  45                                         </P>
  46
  47                                         <P>
  48                                         The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
  49                                         Project</A> member.
  50                                         </P>
  51                                 </TD>
  52                         </TR>
  53                         <TR>
  54                                 <TD>
  55                                         <H1>
  56                                         SOURCES
  57                                         </H1>
  58
  59                                         <P>
  60                                         Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
  61                                         systems, tested variously on i386, AMD64, alpha, and others.  The most current version is <SPAN
  62                                         CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>.  A full <A
  63                                         HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
  64                                         </P>
  65
  66                                         <H2>
  67                                         Current
  68                                         </H2>
  69
  70                                         <TABLE WIDTH="100%" SUMMARY="Current Sources">
  71                                         <COL WIDTH="200">
  72                                         <COL>
  73                                         <TBODY>
  74                                                 <TR>
  75                                                         <TD>Source archive</TD>
  76                                                         <TD>
  77                                                         <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>
  78                                                         (<A HREF="/snapshots/mdocml.md5">md5</A>)
  79                                                         </TD>
  80                                                 </TR>
  81                                                 <TR>
  82                                                         <TD>Online source</TD>
  83                                                         <TD>
  84                                                         <A CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
  85                                                         </TD>
  86                                                 </TR>
  87                                         </TBODY>
  88                                         </TABLE>
  89
  90                                         <H2>
  91                                         Downstream
  92                                         </H2>
  93
  94                                         <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
  95                                         <COL WIDTH="200">
  96                                         <COL>
  97                                         <TBODY>
  98                                                 <TR>
  99                                                         <TD>DragonFly BSD</TD>
 100                                                         <TD>
 101                                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
 102                                                                 CLASS="external">usr.bin/mandoc</A>
 103                                                         </TD>
 104                                                 </TR>
 105                                                 <TR>
 106                                                         <TD>FreeBSD</TD>
 107                                                         <TD>
 108                                                         <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
 109                                                                 CLASS="external">ports/textproc/mdocml</A>
 110                                                         </TD>
 111                                                 </TR>
 112                                                 <TR>
 113                                                         <TD>NetBSD</TD>
 114                                                         <TD>
 115                                                         <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
 116                                                                 CLASS="external">src/external/bsd/mdocml</A>
 117                                                         </TD>
 118                                                 </TR>
 119                                                 <TR>
 120                                                         <TD>OpenBSD</TD>
 121                                                         <TD>
 122                                                         <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
 123                                                                 CLASS="external">src/usr.bin/mandoc</A>
 124                                                         </TD>
 125                                                 </TR>
 126                                         </TBODY>
 127                                         </TABLE>
 128
 129                                         <H2>
 130                                         Historical
 131                                         </H2>
 132
 133                                         <TABLE WIDTH="100%" SUMMARY="Archived Sources">
 134                                         <COL WIDTH="200">
 135                                         <COL>
 136                                         <TBODY>
 137                                                 <TR>
 138                                                         <TD>Source archive</TD>
 139                                                         <TD>
 140                                                         <A HREF="/snapshots/">/snapshots/</A>
 141                                                         </TD>
 142                                                 </TR>
 143                                         </TBODY>
 144                                         </TABLE>
 145                                 </TD>
 146                         </TR>
 147                         <TR>
 148                                 <TD>
 149                                         <H1>
 150                                         DOCUMENTATION
 151                                         </H1>
 152
 153                                         <P>
 154                                         These manuals are generated automatically and refer to the current snapshot.
 155                                         </P>
 156
 157                                         <TABLE WIDTH="100%" SUMMARY="Documentation">
 158                                         <COL WIDTH="200">
 159                                         <COL>
 160                                         <TBODY>
 161                                                 <TR>
 162                                                         <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD>
 163                                                         <TD>format and display UNIX manuals</TD>
 164                                                 </TR>
 165                                                 <TR>
 166                                                         <TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD>
 167                                                         <TD>mandoc special characters</TD>
 168                                                 </TR>
 169                                                 <TR>
 170                                                         <TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD>
 171                                                         <TD>mdoc language reference</TD>
 172                                                 </TR>
 173                                                 <TR>
 174                                                         <TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD>
 175                                                         <TD>man language reference</TD>
 176                                                 </TR>
 177                                                 <TR>
 178                                                         <TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD>
 179                                                         <TD>a guide to writing UNIX manuals</TD>
 180                                                 </TR>
 181                                                 <TR>
 182                                                         <TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD>
 183                                                         <TD>mdoc macro compiler library</TD>
 184                                                 </TR>
 185                                                 <TR>
 186                                                         <TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD>
 187                                                         <TD>man macro compiler library</TD>
 188                                                 </TR>
 189                                         </TBODY>
 190                                         </TABLE>
 191                                 </TD>
 192                         </TR>
 193                         <TR>
 194                                 <TD>
 195                                         <H1>
 196                                         CONTACT
 197                                         </H1>
 198
 199                                         <P>
 200                                         For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
 201                                         CLASS="external"
 202                                         HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q=="
 203                                         TITLE="Reveal this e-mail address">...</A>@bsd.lv.
 204                                         </P>
 205
 206                                         <P>
 207                                         You may also subscribe to several mailing lists (these require subscription, which is moderated).  An
 208                                         archive is not yet available.
 209                                         </P>
 210
 211                                         <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
 212                                                 <COL WIDTH="200">
 213                                                 <COL>
 214                                                 <TBODY>
 215                                                         <TR>
 216                                                                 <TD>
 217                                                                         disc<A CLASS="external" TITLE="Reveal this e-mail address"
 218                                                                         HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</a>@mdocml.bsd.lv
 219                                                                 </TD>
 220                                                                 <TD>discussions and announcements</TD>
 221                                                         </TR>
 222                                                         <TR>
 223                                                                 <TD>
 224                                                                         sou<A CLASS="external" TITLE="Reveal this e-mail address"
 225                                                                         HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</a>@mdocml.bsd.lv
 226                                                                 </TD>
 227                                                                 <TD>source commit messages</TD>
 228                                                         </TR>
 229                                                 </TBODY>
 230                                         </TABLE>
 231                                 </TD>
 232                         </TR>
 233                         <TR>
 234                                 <TD>
 235                                         <H1>
 236                                         NEWS
 237                                         </H1>
 238
 239                                         <TABLE WIDTH="100%" CELLPADDING="2">
 240                                                 <COL CLASS="date">
 241                                                 <TBODY>
 242                                                         <TR>
 243                                                                 <TD VALIGN="top"><SPAN CLASS="date">xx-05-2010</SPAN></TD>
 244                                                                 Day 1 of Rostock hackathon: proper handling of quotations in tab-separated
 245                                                                 column lists, finished patching of SYNOPSIS breaking (1.9.25), fixed pre-comment
 246                                                                 white-space stripping, added end-of-sentence spacing to black partial-implicit
 247                                                                 macros, relaxed column warnings, relaxed acceptence of bad standards arguments,
 248                                                                 significant documentation of lists in <A HREF="mdoc.7.html">mdoc(7)</A>.
 249                                                                 Version: <SPAN CLASS="rev">1.9.26</SPAN>.
 250                                                                 <TD VALIGN="top">
 251                                                         </TR>
 252                                                         <TR>
 253                                                                 <TD VALIGN="top"><SPAN CLASS="date">13-05-2010</SPAN></TD>
 254                                                                 <TD VALIGN="top">
 255                                                                 Fixed handling of <Q>\*(Ba</Q> escape.  Backed out <SPAN
 256                                                                 CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity).  Fixed erroneous
 257                                                                 breaking of literal lines.  Fixed SYNOPSIS breaking lines before non-initial
 258                                                                 macros.  Changed default section ordering.  Most importantly, the framework for
 259                                                                 end-of-sentence double-spacing is in place, now implemented for the
 260                                                                 <Q>end-of-sentence, end-of-line</Q> rule.  This is a stable roll-back point
 261                                                                 before the mandoc hackathon in Rostock!
 262                                                                 Version: <SPAN CLASS="rev">1.9.25</SPAN>.
 263                                                         </TR>
 264                                                         <TR>
 265                                                                 <TD VALIGN="top"><SPAN CLASS="date">09-05-2010</SPAN></TD>
 266                                                                 <TD VALIGN="top">
 267                                                                 Rolled back break-at-hyphen.  <SPAN CLASS="flag">-DUGLY</SPAN> is now the
 268                                                                 default (no feature splits!).  Free-form text is not de-chunked any more: lines
 269                                                                 are passed whole-sale into the front-end, including whitespace.  Added mailing
 270                                                                 lists.  Lastly, <SPAN CLASS="nm">mdocml</SPAN> is the focus of two <A
 271                                                                 CLASS="external" HREF="http://socghop.appspot.com/">Google Summer of Code</A>
 272                                                                 projects this year: <Q><A CLASS="external"
 273                                                                 HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">mandoc -Tps</A></Q>
 274                                                                 (NetBSD) and <Q><A CLASS="external"
 275                                                                 HREF="http://wiki.freebsd.org/SummerOfCode2010Projects">BSD-licensed
 276                                                                 Text-Processing Tools</A></Q> (FreeBSD).
 277                                                                 Version: <SPAN CLASS="rev">1.9.24</SPAN>.
 278                                                                 </TD>
 279                                                         </TR>
 280
 281                                                         <TR>
 282                                                                 <TD VALIGN="top"><SPAN CLASS="date">07-04-2010</SPAN></TD>
 283                                                                 <TD VALIGN="top">
 284                                                                 <SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external"
 285                                                                 HREF="http://www.openbsd.org/faq/current.html#20100403">OpenBSD build</a>.  This
 286                                                                 version incorporates many small changes, mostly from patches by OpenBSD,
 287                                                                 allowing crufty manuals to slip by with warnings instead of erroring-out.  Some
 288                                                                 subtle semantic issues, such as punctuation scope, have also been fixed.
 289                                                                 Lastly, some issues with <SPAN CLASS="flag">-Thtml</SPAN> have been fixed, which
 290                                                                 prompted an update to the <A HREF="mandoc.1.html">online</A> <A
 291                                                                 HREF="mandoc_char.7.html">manual</A> <A HREF="man.7.html">pages</A> style
 292                                                                 layout.  Version: <SPAN CLASS="rev">1.9.23</SPAN>.
 293                                                                 </TD>
 294                                                         </TR>
 295                                                         <TR>
 296                                                                 <TD VALIGN="top"><SPAN CLASS="date">31-03-2010</SPAN></TD>
 297                                                                 <TD VALIGN="top">
 298                                                                 Version <SPAN CLASS="rev">1.9.22</SPAN>: adjusted merge of the significant work
 299                                                                 by Ingo Schwarze in getting <Q>Xo</Q> blocks (block full implicit, e.g.,
 300                                                                 <Q>It</Q> for non-columnar lists) to work properly.  This isn't enabled by
 301                                                                 default: you must specify <SPAN CLASS="flag">-DUGLY</SPAN> as a compiler flag
 302                                                                 (see the Makefile for details).
 303                                                                 </TD>
 304                                                         </TR>
 305                                                         <TR>
 306                                                                 <TD VALIGN="top"><SPAN CLASS="date">30-03-2010</SPAN></TD>
 307                                                                 <TD VALIGN="top">
 308                                                                 Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions
 309                                                                 in -man documents under control.  Note that roff instructions embedded in
 310                                                                 line-scoped, next-line macros (e.g. <Q>B</Q>) are not supported.  Leading
 311                                                                 punctuation for -mdoc macros, such as <Q>Fl ( ( a</Q>, are now correctly
 312                                                                 handled.
 313                                                                 </TD>
 314                                                         </TR>
 315                                                         <TR>
 316                                                                 <TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD>
 317                                                                 <TD VALIGN="top">
 318                                                                 Version <SPAN CLASS="rev">1.9.18</SPAN>: many fixes (largely pertaining to
 319                                                                 scope) and improvements (e.g., handling of apostrophe-control macros, which
 320                                                                 fixes the strange <Q>BR</Q> seen in some macro output) to handling roff
 321                                                                 instructions in -man documents.
 322                                                                 </TD>
 323                                                         </TR>
 324                                                         <TR>
 325                                                                 <TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD>
 326                                                                 <TD VALIGN="top">
 327                                                                 Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A
 328                                                                 HREF="http://perldoc.perl.org/" CLASS="external">perlpod</A> standard preamble.
 329                                                                 Also accept (and discard) <Q>de</Q>, <Q>dei</Q>, <Q>am</Q>, <Q>ami</Q>, and
 330                                                                 <Q>ig</Q> roff macro blocks.
 331                                                                 </TD>
 332                                                         </TR>
 333                                                         <TR>
 334                                                                 <TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD>
 335                                                                 <TD VALIGN="top">
 336                                                                 Version <SPAN CLASS="rev">1.9.16</SPAN> highlights: inspired by patches and bug
 337                                                                 reports by Ingo Schwarze, allowed <SPAN CLASS="flag">-man</SPAN> to accept
 338                                                                 non-printing elements to be nested within next-line scopes, such as <Q>br</Q>
 339                                                                 within <Q>B</Q> or <Q>TH</Q>, which is valid roff.  Longsoon architecture also
 340                                                                 noted and Makefile cleaned up.
 341                                                                 </TD>
 342                                                         </TR>
 343                                                         <TR>
 344                                                                 <TD VALIGN="top"><SPAN CLASS="date">18-02-2010</SPAN></TD>
 345                                                                 <TD VALIGN="top">
 346                                                                 Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home.
 347                                                                 Version <SPAN CLASS="rev">1.9.15</SPAN> highlights: XHTML is now an acceptable
 348                                                                 output mode for <A HREF="mandoc.1.html">mandoc(1)</A>;  <Q>Xr</Q> made more
 349                                                                 compatible with groff; <Q>Vt</Q> fixed when invoked in SYNOPSIS;  <Q>\\</Q>
 350                                                                 escape removed; end-of-line white-space detected for all lines;  subtle bug
 351                                                                 fixed in list display for some modes;  compatibility layer checked in for
 352                                                                 compilation in diverse UNIX systems;  and column lengths handled correctly.
 353                                                                 </TD>
 354                                                         </TR>
 355                                                 </TBODY>
 356                                         </TABLE>
 357                                 </TD>
 358                         </TR>
 359                         <TR>
 360                                 <TD>
 361                                         <DIV CLASS="foot">
 362                                                 Copyright &#169; 2008&#8211;2010 Kristaps Dzonsons, $Date: 2010/05/14 16:02:29 $
 363                                         </DIV>
 364                                 </TD>
 365                         </TR>
 366                 </TBODY>
 367         </TABLE>
 368         </BODY>
 369 </HTML>