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.146 and 1.158

version 1.146, 2011/10/08 12:21:57

version 1.158, 2012/06/09 14:19:55

Line 3

<HEAD>

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

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

</HEAD>

<BODY>

mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@)

mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

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

<H1>

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

Line 39

Line 33

mdocml 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;

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,

<A HREF="apropos.1.html">apropos</A>, for semantic search of manual content.

<A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and

<A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online.

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

Line 52

Line 47

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

</H2>

mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll

mdocml 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> and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX

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

systems — see the Makefile if you're running Linux). To build and install into /usr/local/, just

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

run <CODE>make install</CODE>. Be careful: the preconv and apropos binary names are usually taken by

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

existing utilities.

<H2>

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

</H2>

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.

<H2>

Downstream

</H2>

Line 84

Line 69

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

Line 120

<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

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

</TD>

</TR>

<TR>

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

recode multibyte UNIX manuals

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

</TD>

</TR>

<TR>

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

mandoc macro compiler library

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

</TD>

</TR>

<TR>

man language reference

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

</TD>

</TR>

<TR>

cgi for manpage query and display

</TD>

</TR>

<TR>

eqn-mandoc language reference

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

</TD>

</TR>

<TR>

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

mandoc special characters

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

</TD>

</TR>

<TR>

mdoc language reference

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

</TD>

</TR>

<TR>

roff-mandoc language reference

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

</TD>

</TR>

<TR>

tbl-mandoc language reference

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

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

Line 253

Line 204

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

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

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

Line 266

Line 217

</TD>

<TD>

bug-reports, general questions, and announcements

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

</TD>

</TR>

<TR>

Line 276

Line 226

</TD>

<TD>

patches and system discussions

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

</TD>

</TR>

<TR>

Line 286

Line 235

</TD>

<TD>

source commit messages

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

</TD>

</TR>

</TBODY>

Line 295

Line 243

</H1>

08-10-2011: version 1.12.0

xx-xx-2012: version 1.12.4

This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -Tman. This mode

Ingo, can you summarise your changes here?

allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively

support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.

The -Ofragment option was added to <A HREF="mandoc.1.html">mandoc</A>'s -Thtml and -Txhtml modes.

While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.

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

This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content. <A

HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to

HREF="apropos.1.html">apropos</A> is different from the traditional apropos primarily in allowing keyword search

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

(such as for functions, utilities, etc.) and regular expressions.

In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made

considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE

SYNTAX to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical MACRO SYNTAX sections

down to the bottom of the page.

Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -Tascii mode horizontal spacing of tables was rewritten

completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both

with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and

several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now

nicer for very long titles.

02-09-2011: version 1.11.7

Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the

historical <CODE>deroff</CODE> utility. Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.

16-08-2011: version 1.11.6

Handling of tr 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>.

24-07-2011: version 1.11.5

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

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

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

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

Edition User's Guide</A>.

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

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

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

CVSweb