mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
-
mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
@@ -21,33 +20,25 @@
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. - It is small, ISO C, ISC-licensed, and quite fast. + UNIX manuals. The mission of mdocml is to deprecate groff, the GNU troff implementation, for displaying mdoc + pages whilst providing token support for man.
- 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. + 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).
- 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 - NetBSD, - DragonFly, - 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. + 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.
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
@@ -56,12 +47,11 @@
Sources
- mdocml should build and run on any modern system with
- libdb
- (this is installed by default on BSD UNIX systems — see the Makefile if you're running Linux).
- To build and install into /usr/local/, just run make install.
- Be careful: the preconv, apropos, and whatis installed binary names
- may be taken by existing utilities.
+ mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos (links to whatis),
+ man.cgi, and mandocdb.
+ To build and install into /usr/local/, just run make install.
+ Be careful: the preconv, apropos, and whatis binary names are usually taken by existing utilities.
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
, so please contact us if you plan on maintaining a downstream version!
+ official
.
+ Please contact us if you plan on maintaining a downstream version!
| Alpine Linux | - aports/main/mdocml (1.12.2 port) + aports/main/mdocml (1.12.1 port) |
| whatis(1) | -- search the manual page database - | -
| mandoc(3) | mandoc macro compiler library @@ -225,12 +210,6 @@ |
| catman(8) | -- update a man.cgi manpage cache - | -
| mandocdb(8) | index UNIX manuals @@ -238,25 +217,6 @@ |
+ xx-xx-2013: version 1.13.0 +
++ The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database. +
+05-10-2013: version 1.12.2
@@ -346,6 +314,9 @@
For mandoc developers, we now provide a tbl(3) library manual and gmdiff,
a very small, very simplistic groff-versus-mandoc output comparison tool.
+ See NEWS for historical notes. +
23-03-2012: version 1.12.1
@@ -370,42 +341,16 @@Lastly, I'm no longer providing binaries, as nobody has asked for them.
-+ See cvsweb for + historical notes. +
Copyright © 2008–2011 Kristaps Dzonsons, © 2013 Ingo Schwarze, - $Date: 2013/11/07 22:09:54 $ + $Date: 2013/10/06 17:34:30 $