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

Diff for /mandoc/Attic/index.sgml between version 1.17 and 1.47

version 1.17, 2009/06/11 13:34:14 version 1.47, 2010/03/29 10:10:35
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 <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a                                          displaying -mdoc pages whilst providing token support for -man.
                                         href="man.7.txt" class="man">man(7)</a>.                                          </P>
                                         </p>  
   
                                         <p>                                          <P>
                                         What are UNIX manuals?  Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.  
                                         </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> are the <a href="man.3.txt" class="man">man(3)</a> and <a                                          The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i>
                                         href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form                                          validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
                                         output from -man or -mdoc input.  Both are simple, fast libraries operating on memory buffers, so they                                          be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
                                         may be used for a variety of front-ends (terminal-based, CGI and so on).                                          mandoc</i>, which formats manuals for display on the terminal.
                                         </p>                                          </P>
   
                                         <p>  
                                         The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for  
                                         display on the terminal.  Its purpose is to deprecate usage of groff for displaying -mdoc and, to a  
                                         limited extent, -man manuals on the terminal.  
                                         </p>  
   
                                         <p>                                          <P>
                                         <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant                                          The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
                                         implementation exists, work remains for the backend library and especially the front-end utilities.  See                                          Project</A> member.
                                         the <a href="#contact">contact</a> information below for submissions.                                          </P>
                                         </p>                                  </TD>
                                 </td>                          </TR>
                         </tr>                          <TR>
                         <tr>                                  <TD>
                                 <td>                                          <H1>
                                         <h1>                                          SOURCES
                                         INSTALLING SOURCES                                          </H1>
                                         </h1>  
   
                                         <p>                                          <P>
                                         Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested                                          Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
                                         variously on i386, AMD64, alpha and others.                                          systems, tested variously on i386, AMD64, alpha, and others.  The most current version is <SPAN
                                         </p>                                          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>
                                         The most current version is <span class="attn">@VERSION@</span>, dated                                          Current
                                         <span class="attn">@VDATE@</span>.                                          </H2>
                                         </p>  
   
                                         <h2>                                          <TABLE WIDTH="100%" SUMMARY="Current Sources">
                                         Snapshot source                                          <COL WIDTH="200">
                                         </h2>                                          <COL>
                                           <TBODY>
                                                   <TR>
                                                           <TD>Source archive</TD>
                                                           <TD>
                                                           <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>
   
                                         <p>                                          <H2>
                                         CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a                                          Downstream
                                         href="/snapshots/">/snapshots/</a> directory.  A full <a href="/snapshots/ChangeLog">ChangeLog</a> is                                          </H2>
                                         written with each new snapshot.  
                                         </p>  
   
                                         <p class="boxed">                                          <TABLE WIDTH="100%" SUMMARY="Downstream 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>DragonFly BSD</TD>
                                         # make install                                                          <TD>
                                         </p>                                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
                                                                   CLASS="external">usr.bin/mandoc</A>
                                                           </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>
   
                                         <h2>                                          <H2>
                                         Snapshot port/pkgsrc                                          Historical
                                         </h2>                                          </H2>
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Archived 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>Source archive</TD>
                                         class="external"                                                          <TD>
                                         href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports                                                          <A HREF="/snapshots/">/snapshots/</A>
                                         guide</a>, first.                                                          </TD>
                                         </p>                                                  </TR>
                                           </TBODY>
                                           </TABLE>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           DOCUMENTATION
                                           </H1>
   
                                         <h3>                                          <P>
                                         OpenBSD port                                          These manuals are generated automatically and refer to the current snapshot.
                                         </h3>                                          </P>
   
                                         <p class="boxed">                                          <TABLE WIDTH="100%" SUMMARY="Documentation">
                                         # pkg_delete mdocml<br>                                          <COL WIDTH="200">
                                         # cd /usr/ports/textproc/<br>                                          <COL>
                                         # rm -rf mdocml<br>                                          <TBODY>
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">                                                  <TR>
                                         http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>                                                          <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD>
                                         # cd mdocml<br>                                                          <TD>format and display UNIX manuals</TD>
                                         # make build<br>                                                  </TR>
                                         # make install                                                  <TR>
                                         </p>                                                          <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>
   
                                         <h3>                                          <P>
                                         NetBSD pkgsrc                                          For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
                                         </h3>                                          CLASS="external"
                                           HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q=="
                                           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>
                                         <p class="boxed">                                                                  <TD VALIGN="top"><SPAN CLASS="date">29-03-2010</SPAN></TD>
                                         # pkg_delete -x mdocml<br>                                                                  <TD VALIGN="top">
                                         # cd /tmp<br>                                                                  Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">                                                                  in -man documents under control.  This seems to be working for all manuals I can
                                         http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>                                                                  find.  Please let me know if you find ill-formatted -man manuals.  Note that
                                         # cd mdocml<br>                                                                  roff instructions embedded in line-scoped, next-line macros (e.g. <Q>B</Q>) are
                                         # make<br>                                                                  not supported.
                                         # make install                                                                  </TD>
                                         </p>                                                          </TR>
                                 </td>                                                          <TR>
                         </tr>                                                                  <TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD>
                         <tr>                                                                  <TD VALIGN="top">
                                 <td>                                                                  Version <SPAN CLASS="rev">1.9.18</SPAN>: many fixes (largely pertaining to
                                         <h1>                                                                  scope) and improvements (e.g., handling of apostrophe-control macros, which
                                         CONTACT                                                                  fixes the strange <Q>BR</Q> seen in some macro output) to handling roff
                                         </h1>                                                                  instructions in -man documents.
                                                                   </TD>
                                         <p>                                                          </TR>
                                         Please contact Kristaps, kris<a class="external"                                                          <TR>
                                         href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="                                                                  <TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD>
                                         onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',                                                                  <TD VALIGN="top">
                                         '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return                                                                  Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A
                                         false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so                                                                  HREF="http://perldoc.perl.org/" CLASS="external">perlpod</A> standard preamble.
                                         on.                                                                  Also accept (and discard) <Q>de</Q>, <Q>dei</Q>, <Q>am</Q>, <Q>ami</Q>, and
                                         </p>                                                                  <Q>ig</Q> roff macro blocks.
                                                                   </TD>
                                         <p>                                                          </TR>
                                         If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not                                                          <TR>
                                         checked in.  If making a bug report, please make sure it's repeatable on the most current snapshot.                                                                  <TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD>
                                         </p>                                                                  <TD VALIGN="top">
                                 </td>                                                                  Version <SPAN CLASS="rev">1.9.16</SPAN> highlights: inspired by patches and bug
                         </tr>                                                                  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>
                                 <td>                                                                  within <Q>B</Q> or <Q>TH</Q>, which is valid roff.  Longsoon architecture also
                                         <div class="foot">                                                                  noted and Makefile cleaned up.
                                                 Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date$                                                                  </TD>
                                         </div>                                                          </TR>
                                 </td>                                                          <TR>
                         </tr>                                                                  <TD VALIGN="top"><SPAN CLASS="date">18-02-2010</SPAN></TD>
                 </tbody>                                                                  <TD VALIGN="top">
         </table>                                                                  Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home.
         </body>                                                                  Version <SPAN CLASS="rev">1.9.15</SPAN> highlights: XHTML is now an acceptable
 </html>                                                                  output mode for <A HREF="mandoc.1.html">mandoc(1)</A>;  <Q>Xr</Q> made more
                                                                   compatible with groff; <Q>Vt</Q> fixed when invoked in SYNOPSIS;  <Q>\\</Q>
                                                                   escape removed; end-of-line white-space detected for all lines;  subtle bug
                                                                   fixed in list display for some modes;  compatibility layer checked in for
                                                                   compilation in diverse UNIX systems;  and column lengths handled correctly.
                                                                   </TD>
                                                           </TR>
                                                   </TBODY>
                                           </TABLE>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <DIV CLASS="foot">
                                                   Copyright &#169; 2008&#8211;2010 Kristaps Dzonsons, $Date$
                                           </DIV>
                                   </TD>
                           </TR>
                   </TBODY>
           </TABLE>
           </BODY>
   </HTML>
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.47
CVSweb