]> git.cameronkatri.com Git - mandoc.git/blobdiff - index.sgml
git.ckatri.com / mandoc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Add support for 1/2, 1/4, and 3/4 (needed by eqn).
[mandoc.git] / index.sgml
diff --git a/index.sgml b/index.sgml
index d7b2d26c59ac0166a408a9278928100c1a197c28..6c9b9ea6c885c1d66c2b1b37a127890a7e249001 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -9,11 +9,9 @@
                <P CLASS="head">
                        <B>mdocml</B> &#8211; mdoc macro compiler
                </P>
                <P CLASS="head">
                        <B>mdocml</B> &#8211; mdoc macro compiler
                </P>
-
                <H1>
                        <A NAME="description">Description</A>
                </H1>
                <H1>
                        <A NAME="description">Description</A>
                </H1>
-
                <P>
                        <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
                <P>
                        <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
@@ -21,42 +19,44 @@
                        HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
                        pages whilst providing token support for <I>man</I>.
                </P>
                        HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
                        pages whilst providing token support for <I>man</I>.
                </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 slowly, produces
                        uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A
                        CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
                </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 slowly, produces
                        uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A
                        CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
                </P>
-
                <P>
                        <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
                <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, XHTML,
-                       HTML, PostScript, and PDF.  It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
+                       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.  
+                       It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A
+                       HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals.
+                       It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                </P>
                </P>
-
                <P>
                        <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                </P>
                <P>
                        <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                </P>
-
                <H1>
                        <A NAME="sources">Sources</A>
                </H1>
                <H1>
                        <A NAME="sources">Sources</A>
                </H1>
-
                <P>
                        <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A
                <P>
                        <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A
-                       HREF="makewhatis.1.html">makewhatis</A> requires <A CLASS="external"
+                       HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external"
                        HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is
                        HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is
-                       installed by default on all BSD operating systems).  The most current version is <SPAN CLASS="attn">@VERSION@</SPAN>,
-                       dated <SPAN class="attn">@VDATE@</SPAN>.  If your system doesn't come with <SPAN CLASS="nm">mdocml</SPAN> (see
-                       <Q>Downstream</Q>), run <CODE>make</CODE> to compile and <CODE>make install</CODE> to install into <I>/usr/local</I>.
-                       Note that <A HREF="makewhatis.1.html">makewhatis</A> is not yet linked to the build.  You must run <CODE>make
-                       makewhatis</CODE> to build it (it does not install).
+                       installed by default on all BSD operating systems).  
+                       To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into
+                       <I>/usr/local</I>.
+                       Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A> installation,
+                       this may overwrite its <B>preconv</B> binary.
+                       The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build.  You must run <CODE>make
+                       mandocdb</CODE> to build it (it does not install).
+               </P>
+               <P>
+                       The most current version of <SPAN CLASS="nm">mdocml</SPAN> is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN
+                       class="attn">@VDATE@</SPAN>.  
                </P>
                </P>
-
                <H2>
                        Current
                </H2>
                <H2>
                        Current
                </H2>
-
                <TABLE WIDTH="100%" SUMMARY="Current Sources">
                        <COL WIDTH="175">
                        <COL>
                <TABLE WIDTH="100%" SUMMARY="Current Sources">
                        <COL WIDTH="175">
                        <COL>
@@ -65,7 +65,7 @@
                                        <TD>Source archive</TD>
                                        <TD>
                                        <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> 
                                        <TD>Source archive</TD>
                                        <TD>
                                        <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> 
-                                       (<A HREF="/snapshots/mdocml.md5">md5</A>)
+                                       <SMALL>(<A HREF="/snapshots/mdocml.md5">md5</A>)</SMALL>
                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>
@@ -76,11 +76,9 @@
                                </TR>
                        </TBODY>
                </TABLE>
                                </TR>
                        </TBODY>
                </TABLE>
-
                <H2>
                        Downstream
                </H2>
                <H2>
                        Downstream
                </H2>
-
                <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                        <COL WIDTH="175">
                        <COL>
                <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                        <COL WIDTH="175">
                        <COL>
@@ -115,11 +113,9 @@
                                </TR>
                        </TBODY>
                </TABLE>
                                </TR>
                        </TBODY>
                </TABLE>
-
                <H2>
                        Historical
                </H2>
                <H2>
                        Historical
                </H2>
-
                <TABLE WIDTH="100%" SUMMARY="Archived Sources">
                        <COL WIDTH="175">
                        <COL>
                <TABLE WIDTH="100%" SUMMARY="Archived Sources">
                        <COL WIDTH="175">
                        <COL>
@@ -132,11 +128,9 @@
                                </TR>
                        </TBODY>
                </TABLE>
                                </TR>
                        </TBODY>
                </TABLE>
-
                <H1>
                        <A NAME="documentation">Documentation</A>
                </H1>
                <H1>
                        <A NAME="documentation">Documentation</A>
                </H1>
-
                <P>
                        These manuals are generated automatically and refer to the current snapshot.
                </P>
                <P>
                        These manuals are generated automatically and refer to the current snapshot.
                </P>
@@ -158,14 +152,26 @@
                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>
-                                       <TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD>
+                                       <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                                        <TD VALIGN="top">
                                                index UNIX manuals
                                                <SMALL>
                                        <TD VALIGN="top">
                                                index UNIX manuals
                                                <SMALL>
-                                                       (<A HREF="makewhatis.1.txt">text</A> | 
-                                                       <A HREF="makewhatis.1.xhtml">xhtml</A> |
-                                                       <A HREF="makewhatis.1.pdf">pdf</A> |
-                                                       <A HREF="makewhatis.1.ps">postscript</A>)
+                                                       (<A HREF="mandocdb.8.txt">text</A> | 
+                                                       <A HREF="mandocdb.8.xhtml">xhtml</A> |
+                                                       <A HREF="mandocdb.8.pdf">pdf</A> |
+                                                       <A HREF="mandocdb.8.ps">postscript</A>)
+                                               </SMALL>
+                                       </TD>
+                               </TR>
+                               <TR>
+                                       <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
+                                       <TD VALIGN="top">
+                                               recode multibyte UNIX manuals
+                                               <SMALL>
+                                                       (<A HREF="preconv.1.txt">text</A> | 
+                                                       <A HREF="preconv.1.xhtml">xhtml</A> |
+                                                       <A HREF="preconv.1.pdf">pdf</A> |
+                                                       <A HREF="preconv.1.ps">postscript</A>)
                                                </SMALL>
                                        </TD>
                                </TR>
                                                </SMALL>
                                        </TD>
                                </TR>
@@ -255,11 +261,9 @@
                                </TR>
                        </TBODY>
                </TABLE>
                                </TR>
                        </TBODY>
                </TABLE>
-
                <H1>
                        <A NAME="contact">Contact</A>
                </H1>
                <H1>
                        <A NAME="contact">Contact</A>
                </H1>
-
                <P>
                        Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription).  Please check the
                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
                <P>
                        Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription).  Please check the
                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
@@ -267,7 +271,6 @@
                        HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
                        this e-mail address">kris...</A>@bsd.lv.
                </P>
                        HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
                        this e-mail address">kris...</A>@bsd.lv.
                </P>
-
                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
                        <COL WIDTH="175">
                        <COL>
                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
                        <COL WIDTH="175">
                        <COL>
@@ -304,52 +307,56 @@
                                </TR>
                        </TBODY>
                </TABLE>
                                </TR>
                        </TBODY>
                </TABLE>
-
                <H1>
                        <A NAME="news">News</A>
                </H1>
                <H1>
                        <A NAME="news">News</A>
                </H1>
-
                <P CLASS="news">
                <P CLASS="news">
-                       12-05-2011: version 1.11.2
+                       12-07-2011: version 1.11.4
                </P>
                <P>
                </P>
                <P>
-                       Corrected some installation issues in version 1.11.1.
-                       Further migration to <A HREF="mandoc.3.html">libmandoc</A>.
-                       Initial public release (this utility is very much under development) of <A HREF="makewhatis.1.html">makewhatis</A>,
-                       initially named mandoc-db.
-                       This utility produces keyword databases of manual content
-                       <A HREF="http://mdocml.bsd.lv/mandoc-cgi/index.html">mandoc-cgi</A>, which features semantic querying of manual content.
+                       Bug-fixes and clean-ups across all systems, especially in <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (note: still not
+                       connected to the general build and must be compiled with <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A
+                       HREF="man.7.html">man</A> parser.  This release was significantly assisted by participants in <A CLASS="external"
+                       HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11.  Thanks!
                </P>
                </P>
-
                <P CLASS="news">
                <P CLASS="news">
-                       04-04-2011: version 1.11.1
+                       26-05-2011: version 1.11.3
                </P>
                <P>
                </P>
                <P>
-                       The earlier <I>libroff</I>, <I>libmdoc</I>, and <I>libman</I> soup have been merged into
-                       a single library, <A HREF="mandoc.3.html">libmandoc</A>, which manages all aspects of
-                       parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing).
+                       Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input.
+                       See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details.
+                       This allows for non-ASCII characters (e.g., <I>\[u5000]</I>) to be rendered in the locale's encoding, if said
+                       environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead).
+                       Locale support can be turned off at compile time by removing <I>-DUSE_WCHAR</I> in the <I>Makefile</I>, in which case
+                       <B>-Tlocale</B> is always a synonym for <B>-Tascii</B>.
                </P>
                <P>
                </P>
                <P>
-                       Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in
-                       place.  For the time being, this is limited to the recognition of equation blocks;
-                       future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework.
+                       Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into <A
+                       HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility.
+                       Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>.
+               </P>
+               <P CLASS="news">
+                       12-05-2011: version 1.11.2
                </P>
                <P>
                </P>
                <P>
-                       As usual, many general fixes and improvements have also occurred.  In particular, a great
-                       deal of redundancy and superfluous code has been removed with the merging of the backend
-                       libraries.
+                       Corrected some installation issues in version 1.11.1.
+                       Further migration to <A HREF="mandoc.3.html">libmandoc</A>.
+                       Initial public release (this utility is very much under development) of <INS><A HREF="mandocdb.8.html">mandocdb</A></INS><DEL>makewhatis</DEL>,
+                       initially named mandoc-db.
+                       This utility produces keyword databases of manual content
+                       <DEL>mandoc-cgi</DEL>, 
+                       <A HREF="http://mdocml.bsd.lv/mandoc-tools/index.html">mandoc-tools</A>, 
+                       which features semantic querying of manual content.
                </P>
                </P>
-
                <P>
                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                        historical notes.
                </P>
                <P>
                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                        historical notes.
                </P>
-
                <P CLASS="foot">
                        <SMALL>
                                Copyright &#169; 2008&#8211;2011 
                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
                <P CLASS="foot">
                        <SMALL>
                                Copyright &#169; 2008&#8211;2011 
                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
-                               $Date: 2011/05/14 23:41:50 $
+                               $Date: 2011/07/14 14:36:37 $
                        </SMALL>
                </P>
        </BODY>
                        </SMALL>
                </P>
        </BODY>
A git conversion mirror of mandoc.bsd.lv