Add notes about preconv.1 in the www and change some wording in the

[mandoc.git] / index.sgml

diff --git a/index.sgml b/index.sgml
index c8a4d9c72e87e3d3439481707c0b451bf0b09089..cb48910404aa91ac92397eb882797a6c75d44f0f 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -11,7 +11,7 @@
                </P>
 
                <H1>
                </P>
 
                <H1>

-                       <A NAME="description">DESCRIPTION</A>
+                       <A NAME="description">Description</A>

                </H1>
 
                <P>
                </H1>
 
                <P>


@@ -39,18 +39,18 @@
                </P>
 
                <H1>
                </P>
 
                <H1>

-                       <A NAME="sources">SOURCES</A>
+                       <A NAME="sources">Sources</A>

                </H1>
 
                <P>
                </H1>
 
                <P>

-                       <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system.  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>.
-               </P>
-               <P>
-                       Note that <A HREF="mandoc-db.1.html">mandoc-db</A> is not yet linked to the build.  You must run <CODE>make
-                       mandoc-db</CODE> to build it.
+                       <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="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).

                </P>
 
                <H2>
                </P>
 
                <H2>


@@ -134,7 +134,7 @@
                </TABLE>
 
                <H1>
                </TABLE>
 
                <H1>

-                       <A NAME="documentation">DOCUMENTATION</A>
+                       <A NAME="documentation">Documentation</A>

                </H1>
 
                <P>
                </H1>
 
                <P>


@@ -158,14 +158,26 @@
                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>

-                                       <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc-db(1)</A></TD>
+                                       <TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD>

                                        <TD VALIGN="top">
                                                index UNIX manuals
                                                <SMALL>
                                        <TD VALIGN="top">
                                                index UNIX manuals
                                                <SMALL>

-                                                       (<A HREF="mandoc-db.1.txt">text</A> | 
-                                                       <A HREF="mandoc-db.1.xhtml">xhtml</A> |
-                                                       <A HREF="mandoc-db.1.pdf">pdf</A> |
-                                                       <A HREF="mandoc-db.1.ps">postscript</A>)
+                                                       (<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>)
+                                               </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>


@@ -257,7 +269,7 @@
                </TABLE>
 
                <H1>
                </TABLE>
 
                <H1>

-                       <A NAME="contact">CONTACT</A>
+                       <A NAME="contact">Contact</A>

                </H1>
 
                <P>
                </H1>
 
                <P>


@@ -306,69 +318,54 @@
                </TABLE>
 
                <H1>
                </TABLE>
 
                <H1>

-                       <A NAME="news">NEWS</A>
+                       <A NAME="news">News</A>

                </H1>
 
                <P CLASS="news">
                </H1>
 
                <P CLASS="news">

-                       04-04-2011: version 1.11.1
+                       19-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).
-               </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.
+                       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>

-                       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.
+                       Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as <A
+                       HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility.

                </P>
 
                <P CLASS="news">
                </P>
 
                <P CLASS="news">

-                       07-01-2011: version 1.10.9
-               </P>
-               <P>
-                       Many back-end fixes have been implemented: argument handling (quoting), <A
-                       HREF="man.7.html">man</A> improvements, error/warning classes, and many more.
+                       12-05-2011: version 1.11.2

                </P>
                <P>
                </P>
                <P>

-                       Initial <A HREF="tbl.7.html">tbl</A> functionality (see the <Q>TS</Q>, <Q>TE</Q>, and
-                       <Q>T&amp;</Q> macros in the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been
-                       merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>.  Output is
-                       still minimal, especially for <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN
-                       CLASS="flag">-Txhtml</SPAN>, but manages to at least display data.  This means that <A
-                       HREF="mandoc.1.html">mandoc</A> now has built-in support for two troff preprocessors via
-                       <DEL>libroff</DEL>: soelim and tbl.
+                       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.

                </P>
 
                <P CLASS="news">
                </P>
 
                <P CLASS="news">

-                       24-12-2010: version 1.10.8
+                       04-04-2011: version 1.11.1

                </P>
                <P>
                </P>
                <P>

-                       Significant improvements merged from <A CLASS="external"
-                       HREF="http://www.openbsd.org">OpenBSD</A> downstream, including
+                       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).

                </P>
                </P>

-               <UL>
-                       <LI>many new <A HREF="roff.7.html">roff</A> components,</LI>
-                       <LI>in-line implementation of troff's soelim,</LI>
-                       <LI>broken-block handling,</LI>
-                       <LI>overhauled error classifications, and</LI>
-                       <LI>cleaned up handling of error conditions.</LI>
-               </UL>

                <P>
                <P>

-                       Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN
-                       CLASS="flag">-Txhtml</SPAN> output modes.  They now display readable output in arbitrary
-                       browsers, including text-based ones like <A CLASS="external"
-                       HREF="http://lynx.isc.org">lynx</A>.  See HTML and XHTML manuals in the <A
-                       HREF="#documentation">DOCUMENTATION</A> section for examples.  <SPAN
-                       CLASS="attn">Attention: available style-sheet classes have been considerably
-                       changed!</SPAN> See the <SPAN CLASS="file">example.style.css</SPAN> file for details.
-                       Lastly, <DEL>libmdoc</DEL> and <DEL>libman</DEL> have been
-                       cleaned up and reduced in size and complexity.
+                       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.
+               </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.

                </P>
 
                <P>
                </P>
 
                <P>


@@ -377,9 +374,11 @@
                </P>
 
                <P CLASS="foot">
                </P>
 
                <P CLASS="foot">

-                       Copyright &#169; 2008&#8211;2011 
-                       <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
-                       $Date: 2011/05/04 08:21:17 $
+                       <SMALL>
+                               Copyright &#169; 2008&#8211;2011 
+                               <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
+                               $Date: 2011/05/26 12:14:46 $
+                       </SMALL>

                </P>
        </BODY>
 </HTML>
                </P>
        </BODY>
 </HTML>