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,42 +19,49 @@ 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 mandocdb, 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
- makewhatis to build it (it does not install).
+ mdocml is in plain-old ANSI C and should build and run on any modern system (mandocdb requires Berkeley Database, installed by
+ default on all BSD UNIX 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 mandocdb utility is not yet linked to the build: you must run make mandocdb to
+ build it (it does not install).
+
+ Distributed Win32 binaries are compiled using mingw32. They are + distributed in a ZIP archive consisting of binaries, manuals, and other installable media. +
++ The most current version of mdocml is @VERSION@, dated @VDATE@. +
| Source archive | /snapshots/mdocml.tar.gz - (md5) + (md5) |
| Win32 binary archive | ++ /binaries/mdocml-win32.zip + | +
| Binary archive | ++ /binaries/ + | +
These manuals are generated automatically and refer to the current snapshot.
@@ -158,18 +169,30 @@Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the TODO for known issues @@ -267,7 +288,6 @@ HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal this e-mail address">kris...@bsd.lv.
-- 19-05-2011: version 1.11.3 + 24-07-2011: version 1.11.5
+ Significant eqn improvements. mdocml can now parse arbitrary eqn input + (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the eqn + manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies + the language specified in the Second + Edition User's Guide. +
++ This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip. +
++ 12-07-2011: version 1.11.4 +
+
+ Bug-fixes and clean-ups across all systems, especially in mandocdb makewhatis (note: still not
+ connected to the general build and must be compiled with make mandocdb make makewhatis
+ 26-05-2011: version 1.11.3 +
+Introduce locale-encoding of output with the -Tlocale output option and Unicode escaped-character input. See mandoc and mandoc_char, respectively, for details. This allows for non-ASCII characters (e.g., \[u5000]) to be rendered in the locale's encoding, if said @@ -320,48 +361,33 @@ 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
Corrected some installation issues in version 1.11.1.
Further migration to libmandoc.
- Initial public release (this utility is very much under development) of makewhatis,
+ Initial public release (this utility is very much under development) of mandocdbmakewhatis,
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.
- 04-04-2011: version 1.11.1 -
- The earlier libroff, libmdoc, and libman soup have been merged into - a single library, libmandoc, which manages all aspects of - parsing real manuals (from line-handling to tbl parsing). -
-- Beyond this structural change, initial eqn functionality is in - place. For the time being, this is limited to the recognition of equation blocks; - future version of mdocml will expand upon this framework. -
-- As usual, many general fixes and improvements have also occurred. In particular, a great - deal of redundancy and superfluous code has been removed with the merging of the backend - libraries. -
- -See cvsweb for historical notes.
-Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/19 16:02:01 $ + $Date: 2011/07/24 19:08:09 $