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

Diff for /mandoc/Attic/index.sgml between version 1.21 and 1.52

version 1.21, 2009/06/17 19:12:03 version 1.52, 2010/04/07 11:40:05
Line 1 
Line 1 
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>  <HTML>
         <head>          <HEAD>
                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">                  <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
                 <meta name="resource-type" content="document">                  <META NAME="resource-type" CONTENT="document">
                 <link rel="stylesheet" href="style.css" type="text/css" media="all">                  <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
                 <title>mdocml.bsd.lv</title>                  <TITLE>mdocml | mdoc macro compiler</TITLE>
         </head>          </HEAD>
         <body>          <BODY>
         <table width="600">          <TABLE CLASS="frame" SUMMARY="[frame]">
                 <col width="100%">                  <COL WIDTH="100%">
                 <tbody>                  <TBODY>
                         <tr>                          <TR>
                                 <td>                                  <TD>
                                         <div class="head">                                          <DIV CLASS="head">
                                                 <b>mdocml</b> &#8211; mdoc macro compiler                                                  <B>mdocml</B> &#8211; mdoc macro compiler
                                         </div>                                          </DIV>
                                 </td>                                  </TD>
                         </tr>                          </TR>
                         <tr>                          <TR>
                                 <td valign="top">                                  <TD VALIGN="top">
                                         <h1>                                          <H1>
                                         DESCRIPTION                                          DESCRIPTION
                                         </h1>                                          </H1>
   
                                         <p>                                          <P>
                                         <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro package                                          <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package
                                         of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX                                          of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX
                                         manuals.  The mission of <span class="nm">mdocml</span> is to deprecate <a                                          manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for                                          HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for
                                         displaying -mdoc pages whilst providing token support for -man.                                          displaying -mdoc pages whilst providing token support for -man.
                                         </p>                                          </P>
   
                                         <p>                                          <P>
                                         Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs                                          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 uncertain output, and varies in operation from system to system.  mdocml strives to fix                                          slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
                                         this (respectively small, C, ISC-licensed, fast and regular).                                          this (respectively small, C, ISC-licensed, fast and regular).
                                         </p>                                          </P>
   
                                         <p>                                          <P>
                                         The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>                                          The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i>
                                         validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may                                          validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
                                         be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>                                          be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
                                         mandoc</i>, which formats manuals for display on the terminal.                                          mandoc</i>, which formats manuals for display on the terminal.
                                         </p>                                          </P>
                                 </td>  
                         </tr>  
                         <tr>  
                                 <td>  
                                         <h1>  
                                         INSTALLING SOURCES  
                                         </h1>  
   
                                         <p>                                          <P>
                                         Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested                                          The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
                                         variously on i386, AMD64, alpha and others.  The most current version is <span                                          Project</A> member.
                                         class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>.                                          </P>
                                         </p>                                  </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           SOURCES
                                           </H1>
   
                                         <h2>                                          <P>
                                         Snapshot source                                          Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
                                         </h2>                                          systems, tested variously on i386, AMD64, alpha, and others.  The most current version is <SPAN
                                           CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>.  A full <A
                                           HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
                                           </P>
   
                                         <p>                                          <H2>
                                         CVS sources are checkedout and snapshotted with version updates.  These (and all historical snapshots)                                          Current
                                         may be found in the <a href="/snapshots/">/snapshots/</a> directory.  A full <a                                          </H2>
                                         href="/snapshots/ChangeLog">ChangeLog</a> is written with each new snapshot.  
                                         </p>  
   
                                         <p class="boxed">                                          <TABLE WIDTH="100%" SUMMARY="Current Sources">
                                         % cd /tmp<br>                                          <COL WIDTH="200">
                                         % ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">                                          <COL>
                                         http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br>                                          <TBODY>
                                         % cd mdocml<br>                                                  <TR>
                                         % make all<br>                                                          <TD>Source archive</TD>
                                         # make install                                                          <TD>
                                         </p>                                                          <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>
                                                           (<A HREF="/snapshots/mdocml.md5">md5</A>)
                                                           </TD>
                                                   </TR>
                                                   <TR>
                                                           <TD>Online source</TD>
                                                           <TD>
                                                           <A CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
                                                           </TD>
                                                   </TR>
                                           </TBODY>
                                           </TABLE>
   
                                         <h2>                                          <H2>
                                         Snapshot port/pkgsrc                                          Downstream
                                         </h2>                                          </H2>
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                                         The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a                                          <COL WIDTH="200">
                                         href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a                                          <COL>
                                         href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a class="external"                                          <TBODY>
                                         href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"                                                  <TR>
                                         href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a                                                          <TD>DragonFly BSD</TD>
                                         class="external"                                                          <TD>
                                         href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports                                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
                                         guide</a>, first.                                                                  CLASS="external">usr.bin/mandoc</A>
                                         </p>                                                          </TD>
                                                   </TR>
                                                   <TR>
                                                           <TD>FreeBSD</TD>
                                                           <TD>
                                                           <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
                                                                   CLASS="external">ports/textproc/mdocml</A>
                                                           </TD>
                                                   </TR>
                                                   <TR>
                                                           <TD>NetBSD</TD>
                                                           <TD>
                                                           <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
                                                                   CLASS="external">src/external/bsd/mdocml</A>
                                                           </TD>
                                                   </TR>
                                                   <TR>
                                                           <TD>OpenBSD</TD>
                                                           <TD>
                                                           <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
                                                                   CLASS="external">src/usr.bin/mandoc</A>
                                                           </TD>
                                                   </TR>
                                           </TBODY>
                                           </TABLE>
   
                                         <h3>                                          <H2>
                                         OpenBSD port                                          Historical
                                         </h3>                                          </H2>
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Archived Sources">
                                         Note: the <span class="nm">mdocml</span> utility is part of OpenBSD's base system at <a                                          <COL WIDTH="200">
                                         href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/">usr.bin/mandoc</a>.  Please use this                                          <COL>
                                         instead of the provided port.                                          <TBODY>
                                         </p>                                                  <TR>
                                                           <TD>Source archive</TD>
                                                           <TD>
                                                           <A HREF="/snapshots/">/snapshots/</A>
                                                           </TD>
                                                   </TR>
                                           </TBODY>
                                           </TABLE>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           DOCUMENTATION
                                           </H1>
   
                                         <p class="boxed">                                          <P>
                                         # pkg_delete mdocml<br>                                          These manuals are generated automatically and refer to the current snapshot.
                                         # cd /usr/ports/textproc/<br>                                          </P>
                                         # rm -rf mdocml<br>  
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">  
                                         http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>  
                                         # cd mdocml<br>  
                                         # make build<br>  
                                         # make install  
                                         </p>  
   
                                         <h3>                                          <TABLE WIDTH="100%" SUMMARY="Documentation">
                                         NetBSD pkgsrc                                          <COL WIDTH="200">
                                         </h3>                                          <COL>
                                           <TBODY>
                                                   <TR>
                                                           <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD>
                                                           <TD>format and display UNIX manuals</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD>
                                                           <TD>mandoc special characters</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD>
                                                           <TD>mdoc language reference</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD>
                                                           <TD>man language reference</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD>
                                                           <TD>a guide to writing UNIX manuals</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD>
                                                           <TD>mdoc macro compiler library</TD>
                                                   </TR>
                                                   <TR>
                                                           <TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD>
                                                           <TD>man macro compiler library</TD>
                                                   </TR>
                                           </TBODY>
                                           </TABLE>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           CONTACT
                                           </H1>
   
                                         <p>                                          <P>
                                         Note: a pkgsrc port is maintained in-tree at <a                                          For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
                                         href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/">textproc/mdocml</a>.  Please use this                                          CLASS="external"
                                         instead of the provided pkgsrc.                                          HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q=="
                                         </p>                                          TITLE="Reveal this e-mail address">...</A>@bsd.lv.
                                           </P>
   
                                         <p class="boxed">                                          <P>
                                         # pkg_delete mdocml<br>                                          If you want to receive a semi-automated mail-out of new releases, then please write with a message
                                         # cd /usr/pkgsrc/textproc/<br>                                          subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>).
                                         # rm -rf mdocml<br>                                          </P>
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">                                  </TD>
                                         http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br>                          </TR>
                                         # cd mdocml<br>                          <TR>
                                         # make build<br>                                  <TD>
                                         # make install                                          <H1>
                                         </p>                                          NEWS
                                           </H1>
   
                                         <h3>                                          <TABLE WIDTH="100%" CELLPADDING="2">
                                         FreeBSD port                                                  <COL CLASS="date">
                                         </h3>                                                  <TBODY>
                                                           <TR>
                                                                   <TD VALIGN="top"><SPAN CLASS="date">07-04-2010</SPAN></TD>
                                                                   <TD VALIGN="top">
                                                                   <SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external"
                                                                   HREF="http://www.openbsd.org/faq/current.html#20100403">OpenBSD build</a>.  This
                                                                   version incorporates many small changes, mostly from patches by OpenBSD,
                                                                   allowing crufty manuals to slip by with warnings instead of erroring-out.  Some
                                                                   subtle semantic issues, such as punctuation scope, have also been fixed.
                                                                   Lastly, some issues with <SPAN CLASS="flag">-Thtml</SPAN> have been fixed, which
                                                                   prompted an update to the <A HREF="mandoc.1.html">online</A> <A
                                                                   HREF="mandoc_char.7.html">manual</A> <A HREF="man.7.html">pages</A> style
                                                                   layout.  Version: <SPAN CLASS="rev">1.9.23</SPAN>.
                                                                   </TD>
                                                           </TR>
   
                                         <p>                                                          <TR>
                                         Note: a port is maintained in-tree at <a                                                                  <TD VALIGN="top"><SPAN CLASS="date">31-03-2010</SPAN></TD>
                                         href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/">textproc/mdocml</a>.  Please use                                                                  <TD VALIGN="top">
                                         this instead of the provided port.                                                                  Version <SPAN CLASS="rev">1.9.22</SPAN>: adjusted merge of the significant work
                                         </p>                                                                  by Ingo Schwarze in getting <Q>Xo</Q> blocks (block full implicit, e.g.,
                                                                   <Q>It</Q> for non-columnar lists) to work properly.  This isn't enabled by
                                         <p class="boxed">                                                                  default: you must specify <SPAN CLASS="flag">-DUGLY</SPAN> as a compiler flag
                                         # pkg_delete -x mdocml<br>                                                                  (see the Makefile for details).
                                         # cd /tmp<br>                                                                  </TD>
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">                                                          </TR>
                                         http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>                                                          <TR>
                                         # cd mdocml<br>                                                                  <TD VALIGN="top"><SPAN CLASS="date">30-03-2010</SPAN></TD>
                                         # make<br>                                                                  <TD VALIGN="top">
                                         # make install                                                                  Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions
                                         </p>                                                                  in -man documents under control.  Note that roff instructions embedded in
                                 </td>                                                                  line-scoped, next-line macros (e.g. <Q>B</Q>) are not supported.  Leading
                         </tr>                                                                  punctuation for -mdoc macros, such as <Q>Fl ( ( a</Q>, are now correctly
                         <tr>                                                                  handled.
                                 <td>                                                                  </TD>
                                         <h1>                                                          </TR>
                                         DOCUMENTATION                                                          <TR>
                                         </h1>                                                                  <TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD>
                                                                   <TD VALIGN="top">
                                         <table width="100%">                                                                  Version <SPAN CLASS="rev">1.9.18</SPAN>: many fixes (largely pertaining to
                                                 <colgroup>                                                                  scope) and improvements (e.g., handling of apostrophe-control macros, which
                                                         <col>                                                                  fixes the strange <Q>BR</Q> seen in some macro output) to handling roff
                                                         <col width="5">                                                                  instructions in -man documents.
                                                         <col width="100%">                                                                  </TD>
                                                 </colgroup>                                                          </TR>
                                                 <tr>                                                          <TR>
                                                         <td><a href="mandoc.1.txt">mandoc(1)</a></td>                                                                  <TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD>
                                                         <td></td>                                                                  <TD VALIGN="top">
                                                         <td>format and display UNIX manuals</td>                                                                  Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A
                                                 </tr>                                                                  HREF="http://perldoc.perl.org/" CLASS="external">perlpod</A> standard preamble.
                                                 <tr>                                                                  Also accept (and discard) <Q>de</Q>, <Q>dei</Q>, <Q>am</Q>, <Q>ami</Q>, and
                                                         <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>                                                                  <Q>ig</Q> roff macro blocks.
                                                         <td></td>                                                                  </TD>
                                                         <td>mandoc special characters</td>                                                          </TR>
                                                 </tr>                                                          <TR>
                                                 <tr>                                                                  <TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD>
                                                         <td><a href="mdoc.7.txt">mdoc(7)</a></td>                                                                  <TD VALIGN="top">
                                                         <td></td>                                                                  Version <SPAN CLASS="rev">1.9.16</SPAN> highlights: inspired by patches and bug
                                                         <td>mdoc language reference</td>                                                                  reports by Ingo Schwarze, allowed <SPAN CLASS="flag">-man</SPAN> to accept
                                                 </tr>                                                                  non-printing elements to be nested within next-line scopes, such as <Q>br</Q>
                                                 <tr>                                                                  within <Q>B</Q> or <Q>TH</Q>, which is valid roff.  Longsoon architecture also
                                                         <td><a href="man.7.txt">man(7)</a></td>                                                                  noted and Makefile cleaned up.
                                                         <td></td>                                                                  </TD>
                                                         <td>man language reference</td>                                                          </TR>
                                                 </tr>                                                          <TR>
                                                 <tr>                                                                  <TD VALIGN="top"><SPAN CLASS="date">18-02-2010</SPAN></TD>
                                                         <td><a href="manuals.7.txt">manuals(7)</a></td>                                                                  <TD VALIGN="top">
                                                         <td></td>                                                                  Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home.
                                                         <td>a guide to writing UNIX manuals</td>                                                                  Version <SPAN CLASS="rev">1.9.15</SPAN> highlights: XHTML is now an acceptable
                                                 </tr>                                                                  output mode for <A HREF="mandoc.1.html">mandoc(1)</A>;  <Q>Xr</Q> made more
                                                 <tr>                                                                  compatible with groff; <Q>Vt</Q> fixed when invoked in SYNOPSIS;  <Q>\\</Q>
                                                         <td><a href="mdoc.3.txt">mdoc(3)</a></td>                                                                  escape removed; end-of-line white-space detected for all lines;  subtle bug
                                                         <td></td>                                                                  fixed in list display for some modes;  compatibility layer checked in for
                                                         <td>mdoc macro compiler library</td>                                                                  compilation in diverse UNIX systems;  and column lengths handled correctly.
                                                 </tr>                                                                  </TD>
                                                 <tr>                                                          </TR>
                                                         <td><a href="man.3.txt">man(3)</a></td>                                                  </TBODY>
                                                         <td></td>                                          </TABLE>
                                                         <td>man macro compiler library</td>                                  </TD>
                                                 </tr>                          </TR>
                                         </table>                          <TR>
                                 </td>                                  <TD>
                         </tr>                                          <DIV CLASS="foot">
                         <tr>                                                  Copyright &#169; 2008&#8211;2010 Kristaps Dzonsons, $Date$
                                 <td>                                          </DIV>
                                         <h1>                                  </TD>
                                         CONTACT                          </TR>
                                         </h1>                  </TBODY>
           </TABLE>
                                         <p>          </BODY>
                                         For all issues related to <span class="nm">mdocml</span>, contact Kristaps, kris<a class="external"  </HTML>
                                         href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="  
                                         onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',  
                                         '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return  
                                         false;" title="Reveal this e-mail address">...</a>@kth.se.  
                                         </p>  
   
                                         <p>  
                                         If you want to receive a semi-automated mail-out of new versions, then please write with a message  
                                         subject of &#8220;subscribe mdocml&#8221; (or, symmetrically, &#8220;unsubscribe mdocml&#8221;).  
                                         </p>  
                                 </td>  
                         </tr>  
                         <tr>  
                                 <td>  
                                         <div class="foot">  
                                                 Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date$  
                                         </div>  
                                 </td>  
                         </tr>  
                 </tbody>  
         </table>  
         </body>  
 </html>  
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.52
CVSweb