=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.163 retrieving revision 1.164 diff -u -p -r1.163 -r1.164 --- mandoc/Attic/index.sgml 2013/10/13 18:34:51 1.163 +++ mandoc/Attic/index.sgml 2013/12/26 14:39:35 1.164 @@ -7,6 +7,7 @@

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

@@ -20,25 +21,33 @@

mdocml is a suite of tools compiling mdoc, the roff macro package of choice for BSD manual pages, and man, the predominant historical package for - UNIX manuals. The mission of mdocml is to deprecate groff, the GNU troff implementation, for displaying mdoc - pages whilst providing token support for man. + UNIX manuals. + It is small, ISO C, ISC-licensed, and quite fast.

- 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, ISC-licensed, fast and regular). + The tool set features mandoc, + based on the libmandoc validating compiler, + to format output for UNIX terminals (with + support for wide-character locales), XHTML, HTML, PostScript, and PDF. + It also includes preconv, for recoding multibyte manuals; + demandoc, for emitting only text parts of manuals; + mandocdb, for indexing manuals; and + apropos, whatis, and + man.cgi (via catman) for semantic search of manual content.

- mdocml consists of the libmandoc validating compiler and mandoc, 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 preconv for recoding multibyte manuals, - demandoc for emitting only text parts of manuals, - mandocdb for indexing manuals, - apropos (includes whatis mode) for indexed manual search, and - man.cgi for indexed manual search online. - It is a BSD.lv project. + mdocml has predominantly been developed on OpenBSD + and is both an OpenBSD + and a BSD.lv project. + We strive to support all interested free operating systems, in particular + DragonFly, + NetBSD, + FreeBSD, + Minix 3, + and GNU/Linux, + as well as all systems running the pkgsrc portable package build system. + All of these projects have helped to make mdocml better, by providing feedback and advice, + bug reports, and patches.

Disambiguation: mdocml is often referred to by its installed binary, mandoc. @@ -59,8 +68,7 @@

Several systems come bundled with mdocml utilities. If your system does not appear below, the maintainers have not contacted me and it should not be considered - official. - Please contact us if you plan on maintaining a downstream version! + official, so please contact us if you plan on maintaining a downstream version!

DragonFly BSD	- contrib/mdocml (1.12.2 sources) + contrib/mdocml (post-1.12.2 sources) lib/libmandoc usr.bin/mandoc (build system)
FreeBSD 9.x, 8.x	- ports/textproc/mdocml (1.12.1 port) + ports/textproc/mdocml (1.12.2 port)
OpenBSD	- src/usr.bin/mandoc (1.12.2 sources and build system) + src/usr.bin/mandoc (post-1.12.2 sources under active development and build system)