mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
-
mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
@@ -21,47 +20,38 @@
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.
+ 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 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; and - apropos, whatis, and - man.cgi (via catman) for semantic search of manual content. + 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 - 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. -
-
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
- mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll
- need libdb to build apropos, whatis, man.cgi, catman, and mandocdb (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 binary names are
- usually 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.
- 05-10-2013: version 1.12.2 + 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. +
++ 01-10-2013: version 1.12.2 +
+
The mdoc(7) to man(7) converter,
to be called as mandoc -Tman, is now fully functional.
- 23-03-2012: version 1.12.1 + 23-03-2011: version 1.12.1
Significant work on apropos and mandocdb. These tools are @@ -371,42 +332,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 21:57:14 $ + $Date: 2013/10/02 06:45:43 $