mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
+
mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
@@ -20,40 +21,47 @@
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). -
-- mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals (with + 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. - 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 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.
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!