mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
-
mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
@@ -21,33 +20,25 @@
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.
- 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. + 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 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 - DragonFly, - NetBSD, - 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. + 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, + apropos (includes whatis mode) for indexed manual search, and + man.cgi for indexed manual search online. + It is a BSD.lv project.
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
@@ -56,12 +47,11 @@
Sources
- 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.
+ 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.
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
, so please contact us if you plan on maintaining a downstream version!
+ official
.
+ Please contact us if you plan on maintaining a downstream version!
| DragonFly BSD | - contrib/mdocml (1.12.3 sources) + contrib/mdocml (1.12.2 sources) lib/libmandoc usr.bin/mandoc (build system) | @@ -93,7 +84,7 @@
| FreeBSD 9.x, 8.x | - ports/textproc/mdocml (1.12.2 port) + ports/textproc/mdocml (1.12.1 port) |
| OpenBSD | - src/usr.bin/mandoc (1.12.3 sources under active development and build system) + src/usr.bin/mandoc (1.12.2 sources and build system) |
| whatis(1) | -- search the manual page database - | -
| mandoc(3) | mandoc macro compiler library @@ -225,12 +210,6 @@ |
| catman(8) | -- update a man.cgi manpage cache - | -
| mandocdb(8) |
index UNIX manuals
@@ -304,55 +283,13 @@
News
- 31-12-2013: version 1.12.3 + xx-xx-2013: version 1.13.0 - In the mdoc(7) SYNOPSIS, line breaks and hanging indentation - now work correctly for .Fo/.Fa/.Fc and .Fn blocks. - Thanks to Franco Fichtner for doing part of the work. + The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database. -- The mdoc(7) .Bk macro got some addititonal bugfixes. - -- In mdoc(7) macro arguments, double quotes can now be quoted - by doubling them, just like in man(7). - Thanks to Tsugutomo ENAMI for the patch. - -- At the end of man(7) macro lines, end-of-sentence spacing - now works. Thanks to Franco Fichtner for the patch. - -- For backward compatibility, the man(7) parser now supports the - man-ext .UR/.UE (uniform resource identifier) block macros. - -- The man(7) parser now handles closing blocks that are not open - more gracefully. - -- The man(7) parser now ignores blank lines right after .SH and .SS. - -- In the man(7) formatter, reset indentation when leaving a block, - not just when entering the next one. - -- The roff(7) .nr request now supports incrementing and decrementing - number registers and stops parsing the number right before the first non-digit character. - -- The roff(7) parser now supports the alternative escape sequence - syntax \C'uXXXX' for Unicode characters. - -- The roff(7) parser now parses and ignores the .fam (font family) - and .hw (hyphenation points) requests and the \d and \u escape sequences. - -- The roff(7) manual got a new ESCAPE SEQUENCE REFERENCE. - 05-10-2013: version 1.12.2 @@ -396,6 +333,30 @@ For mandoc developers, we now provide a tbl(3) library manual andgmdiff,
a very small, very simplistic groff-versus-mandoc output comparison tool.
+ + 23-03-2012: version 1.12.1 + ++ Significant work on apropos and mandocdb. These tools are + now much more robust. + A whatis implementation is now handled as an apropos mode. + These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility + such as GNU troff. + ++ The man.cgi script is also now available for wider testing. It interfaces with mandocdb manuals cached by catman. HTML output is generated + on-the-fly by libmandoc or internal methods to convert pre-formatted pages. + ++ The mailing list archive for the discuss and tech lists are being hosted by Gmane at gmane.comp.tools.mdocml.user and gmane.comp.tools.mdocml.devel, respectively. + ++ Lastly, I'm no longer providing binaries, as nobody has asked for them. + History@@ -431,7 +392,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, © 2013 Ingo Schwarze, - $Date: 2013/12/31 11:23:23 $ + $Date: 2013/10/13 18:34:51 $ |