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.135 and 1.157

version 1.135, 2011/08/16 22:21:04

version 1.157, 2012/06/09 14:11:15

Line 3

<HEAD>

<TITLE>mdocml | mdoc macro compiler</TITLE>

<TITLE>mdocml | UNIX manpage compiler</TITLE>

</HEAD>

<BODY>

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

<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

current version <SPAN CLASS="attn">@VERSION@</SPAN> (<SPAN class="attn">@VDATE@</SPAN>)

</P>

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

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

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

</P>

<H1>

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

</H1>

Line 29

Line 33

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

It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A

It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;

HREF="mandocdb.8.html">mandocdb</A>, for indexing 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="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and

<A HREF="man.cgi.7.html">man.cgi</A> for semantic search of manual content.

It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.

</P>

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

<SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A

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

HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A>, <A

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

HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.

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

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

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

Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.

</P>

<H2>

<COL>

<TBODY>

<TR>

<TD>Current</TD>

<TD>

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

</TD>

</TR>

<TR>

<TD>Archives</TD>

<TD>

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

</TD>

</TR>

<TR>

<TD>Online Repository</TD>

<TD>

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

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

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

</H1>

<P>

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

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

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

64-bit (x86_64) architectures.

</P>

<COL>

<TBODY>

<TR>

<TD>Windows 32-bit</TD>

<TD>

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

</TD>

</TR>

<TR>

<TD>Windows 64-bit</TD>

<TD>

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

</TD>

</TR>

<TR>

<TD>Mac OS X Universal Binary</TD>

<TD>

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

</TD>

</TR>

<TR>

<TD>Archives</TD>

<TD>

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

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

Downstream

</H1>

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

Line 119

Line 63

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

</P>

<COL>

<TBODY>

<TR>

<TD>DragonFly BSD</TD>

<TD>

<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"

<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>

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

<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>

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

<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>

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

<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>

CLASS="external">src/usr.bin/mandoc</A>

</TD>

</TR>

<TR>

<TD>pkgsrc</TD>

<TD>

<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>

</TD>

</TR>

<TR>

<TD>Minix3</TD>

<TD>

<A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

Line 161

Line 113

</P>

<COL>

<TBODY>

<TR>

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

search the manual page database

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

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

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

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

</TD>

</TR>

<TR>

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

emit only text of UNIX manuals

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

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

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

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

</TD>

</TR>

<TR>

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

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

cgi for manpage query and display

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

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

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

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

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

<TR>

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

index UNIX manuals

(<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">ps</A>)

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

<A NAME="contact">Contact</A>

</H1>

<P>

Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the

Use the mailing lists for bug-reports, patches, questions, etc. Please check the

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

before posting. Beyond that, contact Kristaps at <A

before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,

HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal

contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal

this e-mail address">kris...</A>@bsd.lv.

this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.

</P>

<COL>

<TBODY>

<TR>

Line 307

Line 269

</TD>

<TD>

bug-reports, general questions, and announcements

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

</TD>

</TR>

<TR>

Line 317

Line 278

</TD>

<TD>

patches and system discussions

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

</TD>

</TR>

<TR>

Line 327

Line 287

</TD>

<TD>

source commit messages

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

</TD>

</TR>

</TBODY>

Line 336

Line 295

</H1>

16-08-2011: version 1.11.6

xx-xx-2012: version 1.12.4

</P>

<P>

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

<I>Ingo, can you summarise your changes here?</I>

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>

Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input

The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>,

(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A>

<A HREF="apropos.1.html">apropos</A> (absorbing whatis), and

manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies

<A HREF="man.cgi.7.html">man.cgi</A> have been re-written to use

the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second

<A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.

Edition User's Guide</A>.

</P>

<P>

This is also the first release featuring a distributed Windows binary, available at <A

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

</P>

12-07-2011: version 1.11.4

</P>

<P>

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>

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

CVSweb