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

Diff for /mandoc/Attic/index.sgml between version 1.154.2.9 and 1.164

version 1.154.2.9, 2013/10/06 17:31:37 version 1.164, 2013/12/26 14:39:35
Line 7 
Line 7 
         </HEAD>          </HEAD>
         <BODY>          <BODY>
                 <P CLASS="head">                  <P CLASS="head">
                           <A HREF="http://www.openbsd.org/"><IMG SRC="puffy.gif" ALT="Puffy" WIDTH="100" HEIGHT="91" STYLE="float: right"></A>
                         <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)                          <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)
                 </P>                  </P>
                 <P CLASS="subhead">                  <P CLASS="subhead">
Line 20 
Line 21 
                 <P>                  <P>
                         <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro                          <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
                         package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for                          package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
                         UNIX manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A                          UNIX manuals.
                         HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>                          It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast.
                         pages whilst providing token support for <I>man</I>.  
                 </P>                  </P>
                 <P>                  <P>
                         Why?  groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3.  It runs slowly, produces                          The tool set features <A HREF="mandoc.1.html">mandoc</A>,
                         uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A                          based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler,
                         CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).                          to format output for UNIX terminals (with
                 </P>  
                 <P>  
                         <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A  
                         HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with  
                         support for wide-character locales), XHTML, HTML, PostScript, and PDF.                          support for wide-character locales), XHTML, HTML, PostScript, and PDF.
                         It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;                          It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
                         <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;                          <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
                         <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and                          <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
                         <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and                          <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
                         <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.                          <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
                         It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                 </P>                  </P>
                 <P>                  <P>
                           <SPAN CLASS="nm">mdocml</SPAN> has predominantly been developed on OpenBSD
                           and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A>
                           and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
                           We strive to support all interested free operating systems, in particular
                           <A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>,
                           <A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>,
                           <A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>,
                           <A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>,
                           and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux,
                           as well as all systems running the <A CLASS="external" HREF="http://www.pkgsrc.org/">pkgsrc</A> portable package build system.
                           All of these projects have helped to make <SPAN CLASS="nm">mdocml</SPAN> better, by providing feedback and advice,
                           bug reports, and patches.
                   </P>
                   <P>
                         <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.                          <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                 </P>                  </P>
                 <H2>                  <H2>
                         <A NAME="sources">Sources</A>                          <A NAME="sources">Sources</A>
                 </H2>                  </H2>
                 <P>                  <P>
                         <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll                          <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
                         need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A                          HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
                         HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A                          <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
                         HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX                          To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
                         systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just                          Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
                         run <CODE>make install</CODE>.  Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are  
                         usually taken by existing utilities.  
                 </P>                  </P>
                 <H2>                  <H2>
                         Downstream                          Downstream
Line 61 
Line 68 
                 <P>                  <P>
                         Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.                          Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
                         If your system does not appear below, the maintainers have not contacted me and it should not be considered                          If your system does not appear below, the maintainers have not contacted me and it should not be considered
                         <Q>official</Q>.                          <Q>official</Q>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
                         Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!  
                 </P>                  </P>
                 <TABLE WIDTH="100%" SUMMARY="Downstream Sources">                  <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                         <COL WIDTH="175">                          <COL WIDTH="175">
Line 71 
Line 77 
                                 <TR>                                  <TR>
                                         <TD>DragonFly BSD</TD>                                          <TD>DragonFly BSD</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.2 sources)                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (post-1.12.2 sources)
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)
                                         </TD>                                          </TD>
Line 86 
Line 92 
                                 <TR>                                  <TR>
                                         <TD>FreeBSD 9.x, 8.x</TD>                                          <TD>FreeBSD 9.x, 8.x</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port)                                          <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.2 port)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
Line 98 
Line 104 
                                 <TR>                                  <TR>
                                         <TD>OpenBSD</TD>                                          <TD>OpenBSD</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (1.12.2 sources and build system)                                          <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (post-1.12.2 sources under active development and build system)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
Line 116 
Line 122 
                                 <TR>                                  <TR>
                                         <TD>Alpine Linux</TD>                                          <TD>Alpine Linux</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.1 port)                                          <A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                         </TBODY>                          </TBODY>
Line 158 
Line 164 
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
                                         <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>  
                                         <TD VALIGN="top">  
                                                 search the manual page database  
                                         </TD>  
                                 </TR>  
                                 <TR>  
                                         <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>                                          <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                                         <TD VALIGN="top">                                          <TD VALIGN="top">
                                                 mandoc macro compiler library                                                  mandoc macro compiler library
Line 218 
Line 218 
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
                                         <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>  
                                         <TD VALIGN="top">  
                                                 update a man.cgi manpage cache  
                                         </TD>  
                                 </TR>  
                                 <TR>  
                                         <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>                                          <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                                         <TD VALIGN="top">                                          <TD VALIGN="top">
                                                 index UNIX manuals                                                  index UNIX manuals
Line 231 
Line 225 
                                 </TR>                                  </TR>
                         </TBODY>                          </TBODY>
                 </TABLE>                  </TABLE>
                   <H2>
                           <A NAME="links">Supplementary Information</A>
                   </H2>
                   <UL>
                           <LI>
                                   <A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons
                           </LI>
                           <LI>
                                   <A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A>
                                   chapter regarding manual pages
                           </LI>
                           <LI>
                                   <A HREF="press.html">Publications and media coverage</A>
                                   concerning mdocml and mandoc
                           </LI>
                           <LI>
                                   <A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons
                           </LI>
                   </UL>
                 <H1>                  <H1>
                         <A NAME="contact">Contact</A>                          <A NAME="contact">Contact</A>
                 </H1>                  </H1>
Line 278 
Line 291 
                         <A NAME="news">News</A>                          <A NAME="news">News</A>
                 </H1>                  </H1>
                 <P CLASS="news">                  <P CLASS="news">
                           xx-xx-2013: version 1.13.0
                   </P>
                   <P>
                            The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
                           HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
                           use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
                   </P>
                   <P CLASS="news">
                         05-10-2013: version 1.12.2                          05-10-2013: version 1.12.2
                 </P>                  </P>
                 <P>                  <P>
Line 320 
Line 341 
                         For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,                          For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,
                         a very small, very simplistic groff-versus-mandoc output comparison tool.                          a very small, very simplistic groff-versus-mandoc output comparison tool.
                 </P>                  </P>
                 <P>  
                         See <A HREF="NEWS">NEWS</A> for historical notes.  
                 </P>  
                 <P CLASS="news">                  <P CLASS="news">
                         23-03-2012: version 1.12.1                          23-03-2012: version 1.12.1
                 </P>                  </P>
Line 347 
Line 365 
                 <P>                  <P>
                         Lastly, I'm no longer providing binaries, as nobody has asked for them.                          Lastly, I'm no longer providing binaries, as nobody has asked for them.
                 </P>                  </P>
                 <P>                  <H2>
                         See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for                          <A>History</A>
                         historical notes.                  </H2>
                 </P>                  <UL>
                           <LI>
                                   <A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010.
                                   Briefly explaining the most important changes in each release in relatively easy terms.
                                   Very many changes are not mentioned here.
                           </LI>
                           <LI>
                                   <A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008.
                                   One-line entries for important commits, releases, merges, hackathons and talks.
                                   Makes it easy to find out who did what, and when, and when it became available where.
                                   However, this is still incomplete, mentioning only a small fraction of all commits,
                                   and to keep the size down, the individual entries are extremely terse and technical.
                                   Feel free to look up more details and longer explanations about individual entries
                                   in the ChangeLog or in CVS.
                           </LI>
                           <LI>
                                   <A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project.
                                   Very technical information of varying quality, strictly chronological.
                                   All commits are mentioned, but some messages neglect to mention some changes.
                                   Partly terse, partly detailed and verbose.  In any case, the ChangeLog is very long -
                                   more than 25,000 lines, more than 700 kB.
                           </LI>
                           <LI>
                                   <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project.
                                   Source code, diffs and commit messages for each source file.  The real thing.
                           </LI>
                   </UL>
                 <P CLASS="foot">                  <P CLASS="foot">
                         <SMALL>                          <SMALL>
                                 Copyright &#169; 2008&#8211;2011                                  Copyright &#169; 2008&#8211;2011
Legend:
Removed from v.1.154.2.9  
changed lines
  Added in v.1.164
CVSweb