=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.120 retrieving revision 1.121 diff -u -p -r1.120 -r1.121 --- mandoc/Attic/index.sgml 2011/05/26 12:14:46 1.120 +++ mandoc/Attic/index.sgml 2011/05/26 20:23:01 1.121 @@ -9,11 +9,9 @@
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@. +
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as mandoc input by using the newly-added preconv utility. + Note: in the future, this feature may be integrated into mandoc.
@@ -377,7 +380,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/26 12:14:46 $ + $Date: 2011/05/26 20:23:01 $