mandoc/index.sgml - diff

Return to index.sgml CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/index.sgml between version 1.133 and 1.137

version 1.133, 2011/07/24 19:08:09

version 1.137, 2011/08/18 09:02:57

Line 7

</HEAD>

<BODY>

<B>mdocml</B> – mdoc macro compiler

<B>mdocml</B> – mdoc macro compiler, current version @VERSION@ (@VDATE@)

</P>

Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,

<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>

(<A HREF="/snapshots/">archives</A>)

Binaries: <A

HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A

HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A

HREF="/binaries/mdocml-macosx.zip">mac os x</A>

(<A HREF="/binaries/">archives</A>)

</P>

<H1>

<A NAME="description">Description</A>

</H1>

Line 35

Line 46

<P>

<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.

</P>

<H1>

<H2>

<A NAME="sources">Sources</A>

</H1>

</H2>

<P>

<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system (<A

<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.

HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external"

To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.

HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A>, installed by

Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.

default on all BSD UNIX operating systems).

The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact

us</A> if you plan to use it.

</P>

<H2>

<A NAME="binaries">Binaries</A>

</H2>

<P>

To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into

Binary archives consist of pre-compiled binaries, manuals, and other necessary files.

<I>/usr/local</I>. Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/"

Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.

CLASS="external">groff</A> installation, this may overwrite its <B>preconv</B> binary. The <A

Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and

HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build: you must run <CODE>make mandocdb</CODE> to

64-bit (x86_64) architectures.

build it (it does not install).

</P>

<P>

Distributed Win32 binaries are compiled using <A CLASS="external" HREF="http://www.mingw.org/">mingw32</A>. They are

distributed in a ZIP archive consisting of binaries, manuals, and other installable media.

</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>

<H2>

Current

</H2>

<COL>

<TBODY>

<TR>

<TD>Source archive</TD>

<TD>

<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>

</TD>

</TR>

<TR>

<TD>Online source</TD>

<TD>

<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>

</TD>

</TR>

<TR>

<TD>Win32 binary archive</TD>

<TD>

<A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>

</TD>

</TR>

</TBODY>

</TABLE>

<H2>

Downstream

</H2>

<P>

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

<Q>official</Q>.

Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!

</P>

<COL>

Line 124

Line 108

</TR>

</TBODY>

</TABLE>

<H2>

Historical

</H2>

<COL>

<TBODY>

<TR>

<TD>Source archive</TD>

<TD>

<A HREF="/snapshots/">/snapshots/</A>

</TD>

</TR>

<TR>

<TD>Binary archive</TD>

<TD>

<A HREF="/binaries/">/binaries/</A>

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

<A NAME="documentation">Documentation</A>

</H1>

<P>

These manuals are generated automatically and refer to the current snapshot.

These manuals are generated automatically and refer to the current release.

They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.

</P>

Line 160

Line 124

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

format and display UNIX manuals

<SMALL>

(<A HREF="mandoc.1.txt">text</A> |

<A HREF="mandoc.1.xhtml">xhtml</A> |

<A HREF="mandoc.1.pdf">pdf</A> |

<A HREF="mandoc.1.ps">postscript</A>)

<A HREF="mandoc.1.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>

index UNIX manuals

<SMALL>

(<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>)

<A HREF="mandocdb.8.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>

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>)

<A HREF="preconv.1.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>

mandoc macro compiler library

<SMALL>

(<A HREF="mandoc.3.txt">text</A> |

<A HREF="mandoc.3.xhtml">xhtml</A> |

<A HREF="mandoc.3.pdf">pdf</A> |

<A HREF="mandoc.3.ps">postscript</A>)

<A HREF="mandoc.3.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

man language reference

<SMALL>

(<A HREF="man.7.txt">text</A> |

<A HREF="man.7.xhtml">xhtml</A> |

<A HREF="man.7.pdf">pdf</A> |

<A HREF="man.7.ps">postscript</A>)

<A HREF="man.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

eqn-mandoc language reference

<SMALL>

(<A HREF="eqn.7.txt">text</A> |

<A HREF="eqn.7.xhtml">xhtml</A> |

<A HREF="eqn.7.pdf">pdf</A> |

<A HREF="eqn.7.ps">postscript</A>)

<A HREF="eqn.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>

mandoc special characters

<SMALL>

(<A HREF="mandoc_char.7.txt">text</A> |

<A HREF="mandoc_char.7.xhtml">xhtml</A> |

<A HREF="mandoc_char.7.pdf">pdf</A> |

<A HREF="mandoc_char.7.ps">postscript</A>)

<A HREF="mandoc_char.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

mdoc language reference

<SMALL>

(<A HREF="mdoc.7.txt">text</A> |

<A HREF="mdoc.7.xhtml">xhtml</A> |

<A HREF="mdoc.7.pdf">pdf</A> |

<A HREF="mdoc.7.ps">postscript</A>)

<A HREF="mdoc.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

roff-mandoc language reference

<SMALL>

(<A HREF="roff.7.txt">text</A> |

<A HREF="roff.7.xhtml">xhtml</A> |

<A HREF="roff.7.pdf">pdf</A> |

<A HREF="roff.7.ps">postscript</A>)

<A HREF="roff.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

<TR>

tbl-mandoc language reference

<SMALL>

(<A HREF="tbl.7.txt">text</A> |

<A HREF="tbl.7.xhtml">xhtml</A> |

<A HREF="tbl.7.pdf">pdf</A> |

<A HREF="tbl.7.ps">postscript</A>)

<A HREF="tbl.7.ps">ps</A>)

</SMALL>

</TD>

</TR>

</TBODY>

Line 299

Line 243

</TD>

<TD>

bug-reports, general questions, and announcements

<SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>

(<A HREF="/archives/discuss/summary.html">archive</A>)

</TD>

</TR>

<TR>

Line 309

Line 253

</TD>

<TD>

patches and system discussions

<SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>

(<A HREF="/archives/tech/summary.html">archive</A>)

</TD>

</TR>

<TR>

Line 319

Line 263

</TD>

<TD>

source commit messages

<SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>

(<A HREF="/archives/source/summary.html">archive</A>)

</TD>

</TR>

</TBODY>

Line 328

Line 272

</H1>

16-08-2011: version 1.11.6

</P>

<P>

Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more

readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general

improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A

HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A

HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.

</P>

24-07-2011: version 1.11.5

</P>

<P>

Line 349

Line 303

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>

26-05-2011: version 1.11.3

</P>

<P>

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>

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>

12-05-2011: version 1.11.2

</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 <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>

See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for

CVSweb