mdocml – mdoc macro compiler
-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 @@ -21,37 +19,41 @@ HREF="http://www.gnu.org/software/groff/" CLASS="external">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 all of which is GPL. 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, XHTML, - HTML, PostScript, and PDF. It is a BSD.lv project. + HREF="mandoc.1.html">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; and makewhatis, for indexing manuals. + It is a BSD.lv project.
-
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 UNIX system, although makewhatis requires Berkeley Database (this is
- installed by default on all BSD operating systems). The most current version is @VERSION@,
- dated @VDATE@. If your system doesn't come with mdocml (see
- Downstream
), run make to compile and make install to install into /usr/local.
- Note that makewhatis is not yet linked to the build. You must run make
+ installed by default on all BSD operating systems).
+ To compile mdocml, run make, then make install to install into
+ /usr/local.
+ Be aware: if you have an existing groff installation,
+ this may overwrite its preconv binary.
+ The makewhatis utility is not yet linked to the build. You must run make
makewhatis to build it (it does not install).
+ The most current version of mdocml is @VERSION@, dated @VDATE@. +
- 19-05-2011: version 1.11.3 + 26-05-2011: version 1.11.3
Introduce locale-encoding of output with the -Tlocale output option and Unicode escaped-character input. @@ -320,6 +334,11 @@ Locale support can be turned off at compile time by removing -DUSE_WCHAR in the Makefile, in which case -Tlocale is always a synonym for -Tascii.
++ Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into mandoc input by using the newly-added preconv utility. + Note: in the future, this feature may be integrated into mandoc. +
12-05-2011: version 1.11.2
@@ -330,7 +349,9 @@
Initial public release (this utility is very much under development) of makewhatis,
initially named mandoc-db.
This utility produces keyword databases of manual content
- mandoc-cgi, which features semantic querying of manual content.
+ mandoc-cgi,
+ mandoc-tools,
+ which features semantic querying of manual content.
@@ -361,7 +382,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/19 16:02:01 $ + $Date: 2011/06/21 14:51:54 $