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

Diff for /mandoc/Attic/index.sgml between version 1.12 and 1.40

version 1.12, 2009/03/23 21:46:04 version 1.40, 2010/02/17 19:31:00
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.bsd.lv</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                                          <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package
                                         package for BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate <a                                          of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for                                          manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
                                         displaying BSD mdoc pages.                                          HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for
                                         </p>                                          displaying -mdoc pages whilst providing token support for -man.
                                           </P>
   
                                         <p>                                          <P>
                                         Why?  groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some of which is C++ and all of                                          Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
                                         which is GPL.  It runs slowly, produces uncertain output, and varies in operation from system                                          slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
                                         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 the libmdoc library, a validating scanner-parser producing                                          The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i>
                                         intermediate-form output from mdoc input.  libmdoc is a simple, fast library operating on memory buffers                                          validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
                                         of mdoc input.  Its intermediate output, an abstract syntax tree, is fully documented in the <span                                          be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
                                         class="man">mdoc(3)</span> reference manual.                                          mandoc</i>, which formats manuals for display on the terminal.
                                         </p>                                          </P>
   
                                         <p>                                          <P>
                                         There are three utilities implementing <span class="man">mdoc(3)</span>:                                          The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
                                         </p>                                          Project</A> member.
                                           </P>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           SOURCES
                                           </H1>
   
                                         <ul>                                          <P>
                                         <li><span class="man">mdocterm(1)</span> &#8211; formats mdoc input for display on the terminal                                          Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
                                         <li><span class="man">mdochtml(1)</span> &#8211; formats mdoc input as HTML/CSS (nascent)                                          systems, tested variously on i386, AMD64, alpha, and others.  The most current version is <SPAN
                                         <li><span class="man">mdoclint(1)</span> &#8211; validates mdoc input                                          CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>.  A full <A
                                         <li><span class="man">mdoctree(1)</span> &#8211; prints input abstract syntax tree                                          HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
                                         </ul>                                          </P>
   
                                         <p>                                          <H2>
                                         The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a                                          Current
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the                                          </H2>
                                         terminal, either directly or cached as a &#8220;catman&#8221; page.  
                                         </p>  
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Current Sources">
                                         <span class="attn">Please submit patches!</span> Although a significant implementation exists, work                                          <COL WIDTH="200">
                                         remains for the backend library and especially the front-end utilities.  See the <a                                          <COL>
                                         href="#contact">contact</a> information below to submit patches and bug reports.                                          <TBODY>
                                         </p>                                                  <TR>
                                 </td>                                                          <TD>Source archive</TD>
                         </tr>                                                          <TD>
                         <tr>                                                          <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>
                                 <td>                                                          (<A HREF="/snapshots/mdocml.md5">md5</A>)
                                         <h1>                                                          </TD>
                                         INSTALLING SOURCES                                                  </TR>
                                         </h1>                                                  <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>
                                         Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on                                          Downstream
                                         i386, AMD64 and Alpha.                                          </H2>
                                         </p>  
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                                         The most current version is <span class="attn">@VERSION@</span>, dated                                          <COL WIDTH="200">
                                         <span class="attn">@VDATE@</span>.                                          <COL>
                                         </p>                                          <TBODY>
                                                   <TR>
                                                           <TD>DragonFly BSD</TD>
                                                           <TD>
                                                           <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 source                                          Historical
                                         </h2>                                          </H2>
   
                                         <p>                                          <TABLE WIDTH="100%" SUMMARY="Archived Sources">
                                         CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a                                          <COL WIDTH="200">
                                         href="/snapshots/">/snapshots/</a> directory.                                          <COL>
                                         </p>                                          <TBODY>
                                                   <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>
                                         % cd /tmp<br>                                          These manuals are generated automatically and refer to the current snapshot.
                                         % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>                                          </P>
                                         % cd mdocml<br>  
                                         % make all<br>  
                                         % make regress<br>  
                                         # make install  
                                         </p>  
   
                                         <h2>                                          <TABLE WIDTH="100%" SUMMARY="Documentation">
                                         Snapshot port/pkgsrc                                          <COL WIDTH="200">
                                         </h2>                                          <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>
                                         The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a                                          For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
                                         href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a                                          CLASS="external"
                                         href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a                                          HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q=="
                                         href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, <a                                          TITLE="Reveal this e-mail address">...</A>@bsd.lv.
                                         href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or <a                                          </P>
                                         href="http://www.freebsd.org/ports/">FreeBSD Ports Guide</a> first.  
                                         </p>  
   
                                         <h3>                                          <P>
                                         OpenBSD port                                          If you want to receive a semi-automated mail-out of new releases, then please write with a message
                                         </h3>                                          subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>).
                                           </P>
                                   </TD>
                           </TR>
                           <TR>
                                   <TD>
                                           <H1>
                                           NEWS
                                           </H1>
   
                                         <p class="boxed">                                          <TABLE WIDTH="100%" CELLPADDING="2">
                                         # pkg_delete mdocml<br>                                                  <COL STYLE="width: 8em;">
                                         # cd /usr/ports/textproc/<br>                                                  <TBODY>
                                         # rm -rf mdocml<br>                                                          <TR>
                                         # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>                                                                  <TD VALIGN="top"><SPAN CLASS="date">15-02-2010</SPAN></TD>
                                         # cd mdocml<br>                                                                  <TD VALIGN="top">
                                         # make build<br>                                                                  Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home.
                                         # make install                                                                  Version <SPAN CLASS="rev">1.9.15</SPAN>.
                                         </p>                                                                  </TD>
                                                           </TR>
                                         <h3>                                                  </TBODY>
                                         NetBSD pkgsrc                                          </TABLE>
                                         </h3>                                  </TD>
                           </TR>
                                         <p class="boxed">                          <TR>
                                         # pkg_delete mdocml<br>                                  <TD>
                                         # cd /usr/pkgsrc/textproc/<br>                                          <DIV CLASS="foot">
                                         # rm -rf mdocml<br>                                                  Copyright &#169; 2008&#8211;2010 Kristaps Dzonsons, $Date$
                                         # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br>                                          </DIV>
                                         # cd mdocml<br>                                  </TD>
                                         # make build<br>                          </TR>
                                         # make install                  </TBODY>
                                         </p>          </TABLE>
           </BODY>
                                         <h3>  </HTML>
                                         FreeBSD port  
                                         </h3>  
   
                                         <p class="boxed">  
                                         # pkg_delete mdocml<br>  
                                         # cd /usr/ports/textproc/<br>  
                                         # rm -rf mdocml<br>  
                                         # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>  
                                         # cd mdocml<br>  
                                         # make build<br>  
                                         # make install  
                                         </p>  
                                 </td>  
                         </tr>  
                         <tr>  
                                 <td>  
                                         <h1>  
                                         CONTACT  
                                         </h1>  
   
                                         <p>  
                                         Please contact Kristaps, kris<a class="external"  
                                         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, with questions, bug reports, patches, and so on.  
                                         </p>  
   
                                         <p>  
                                         If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not  
                                         checked in.  If making a bug report, please make sure it's repeatable on the most current snapshot.  
                                         </p>  
                                 </td>  
                         </tr>  
                         <tr>  
                                 <td>  
                                         <div class="foot">  
                                                 Copyright &#169; 2009 Kristaps D&#382;onsons, $Date$  
                                         </div>  
                                 </td>  
                         </tr>  
                 </tbody>  
         </table>  
         </body>  
 </html>  
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.40
CVSweb