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.151 and 1.161

version 1.151, 2011/12/14 23:17:12

version 1.161, 2013/10/06 17:34:30

Line 13

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 31

Line 25

pages whilst providing token support for man.

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

Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. 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).

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>, <A HREF="whatis.1.html">whatis</A>, and

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

<A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.

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

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>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A

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

HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX

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

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

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

run <CODE>make install</CODE>. Be careful: the preconv, apropos, and whatis binary names are

usually taken by 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 86

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:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.2 sources)

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

<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>

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

</TD>

</TR>

<TR>

<TD>FreeBSD</TD>

<TD>FreeBSD 10.0, -CURRENT</TD>

<TD>

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

<A HREF="http://svnweb.freebsd.org/base/head/contrib/mdocml/" CLASS="external">contrib/mdocml</A> (1.12.1 sources)

CLASS="external">ports/textproc/mdocml</A>

<A HREF="http://svnweb.freebsd.org/base/head/usr.bin/mandoc/" CLASS="external">usr.bin/mandoc</A> (build system)

</TD>

</TR>

<TR>

<TD>FreeBSD 9.x, 8.x</TD>

<TD>

<A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port)

</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> (1.12.1 sources plus patches and build system)

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> (1.12.2 sources and build system)

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>

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

</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> (1.10.9 sources and build system)

</TD>

</TR>

<TR>

<TD>Alpine Linux</TD>

<TD>

<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.1 port)

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

Line 135

<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="whatis.1.html">whatis(1)</A></TD>

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

search the manual page database

mandoc macro compiler library

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

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

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

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

</TD>

</TR>

<TR>

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

mandoc macro compiler library

roff table parser library for mandoc

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

eqn-mandoc language reference

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

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

(<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="catman.8.html">catman(8)</A></TD>

update a man.cgi manpage cache

(<A HREF="catman.8.txt">text</A> |

<A HREF="catman.8.xhtml">xhtml</A> |

<A HREF="catman.8.pdf">pdf</A> |

<A HREF="catman.8.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 330

Line 264

</H1>

xx-xx-2011: version 1.12.1

xx-xx-2013: version 1.13.0

Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are

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

now much more robust and in line with other manpage systems. A <A HREF="whatis.1.html">whatis</A> implementation is now

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

handled as an <A HREF="apropos.1.html">apropos</A> mode. These tools are also able to minimally handle pre-formatted

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

pages, that is, those already formatted by another utility such as GNU troff.

05-10-2013: version 1.12.2

The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A

The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter,

HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated

to be called as <CODE>mandoc -Tman</CODE>, is now fully functional.

on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.

Lastly, the mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"

The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system)

HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"

input option, and the <CODE>-Tutf8</CODE> output mode now actually works.

CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"

CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.

The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones,

but only replaces them when the build actually succeeds.

The <A HREF="man.7.html">man(7)</A> parser now supports the PD macro (paragraph distance),

and (for GNU man-ext compatibility only) EX (example block) and EE (example end).

Plus several bugfixes regarding indentation, line breaks, and vertical spacing,

and regarding RS following TP.

The <A HREF="roff.7.html">roff(7)</A> parser now supports the \f(BI (bold+italic) font escape,

the \z (zero cursor advance) escape and the cc (change control character)

and it (input line trap) requests.

Plus bugfixes regarding the \t (tab) escape, nested escape sequences, and conditional requests.

In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures,

delimiter handling, list indentation and horizontal and vertical spacing,

formatting of the Lk, %U, and %C macros,

plus some bugfixes related to the handling of syntax errors like badly nested font blocks,

stray Ta macros outside column lists, unterminated It Xo blocks,

and non-text children of Nm blocks.

In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected,

and in <A HREF="man.7.html">man(7)</A> files, a crash was fixed that was triggered by some particular unclosed T{ macros.

For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,

a very small, very simplistic groff-versus-mandoc output comparison tool.

See <A HREF="NEWS">NEWS</A> for historical notes.

08-10-2011: version 1.12.0

23-03-2012: version 1.12.1

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

Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are

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

now much more robust.

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

A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.

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

These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility

such as GNU troff.

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

The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A

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

HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated

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

on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.

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

Note that the calling syntax for apropos is likely to change as it settles down.

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

The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"

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

HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"

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

CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"

down to the bottom of the page.

CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.

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

Lastly, I'm no longer providing binaries, as nobody has asked for them.

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.

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

Line 386

Line 349

<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,

$Date$

CVSweb