mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
-
mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
@@ -21,47 +20,40 @@
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 + 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 (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. + man.cgi 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 - 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. -
-
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
- 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 plain-old ANSI C and should build and run on any modern system; however, you'll
+ need libdb to build apropos, whatis, man.cgi,
+ 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.
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) - lib/libmandoc - usr.bin/mandoc (build system) + usr.bin/mandoc | |
| FreeBSD 10.0, -CURRENT | +FreeBSD | - contrib/mdocml (1.12.1 sources) - usr.bin/mandoc (build system) + ports/textproc/mdocml |
| FreeBSD 9.x, 8.x | -- ports/textproc/mdocml (1.12.2 port) - | -|
| NetBSD | - src/external/bsd/mdocml (1.12.1 sources plus patches and build system) + src/external/bsd/mdocml | |
| OpenBSD | - src/usr.bin/mandoc (1.12.3 sources under active development and build system) + src/usr.bin/mandoc | |
| pkgsrc | - textproc/mdocml (1.12.2 port) + textproc/mdocml | |
| Minix3 | - external/bsd/mdocml (1.10.9 sources and build system) + external/bsd/mdocml | |
| Alpine Linux | -- aports/main/mdocml (1.12.2 port) - | -
- 31-12-2013: version 1.12.3 + 23-03-2011: version 1.12.1
- 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. + 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 mdoc(7) .Bk macro got some addititonal bugfixes.
+ 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.
- 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. + 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.
- At the end of man(7) macro lines, end-of-sentence spacing - now works. Thanks to Franco Fichtner for the patch. + Lastly, I'm no longer providing binaries, as nobody has asked for them.
- For backward compatibility, the man(7) parser now supports the - man-ext .UR/.UE (uniform resource identifier) block macros. + See cvsweb for + historical notes.
-- 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 -
-
- The mdoc(7) to man(7) converter,
- to be called as mandoc -Tman, is now fully functional.
-
- The mandoc(1) utility now supports the -Ios (default operating system)
- input option, and the -Tutf8 output mode now actually works.
-
- The mandocdb(8) utility no longer truncates existing databases when starting to build new ones, - but only replaces them when the build actually succeeds. -
-- The man(7) parser now supports the PD macro (paragraph distance), - and (for GNU man-ext compatibility only) EX (example block) and EE (example end). - Plus several bugfixes regarding indentation, line breaks, and vertical spacing, - and regarding RS following TP. -
-- The roff(7) parser now supports the \f(BI (bold+italic) font escape, - the \z (zero cursor advance) escape and the cc (change control character) - and it (input line trap) requests. - Plus bugfixes regarding the \t (tab) escape, nested escape sequences, and conditional requests. -
-- In mdoc(7), several bugs were fixed related to UTF-8 output of quoting enclosures, - delimiter handling, list indentation and horizontal and vertical spacing, - formatting of the Lk, %U, and %C macros, - plus some bugfixes related to the handling of syntax errors like badly nested font blocks, - stray Ta macros outside column lists, unterminated It Xo blocks, - and non-text children of Nm blocks. -
-- In tbl(7), the width of horizontal spans and the vertical spacing around tables was corrected, - and in man(7) files, a crash was fixed that was triggered by some particular unclosed T{ macros. -
-
- For mandoc developers, we now provide a tbl(3) library manual and gmdiff,
- a very small, very simplistic groff-versus-mandoc output comparison tool.
-
Copyright © 2008–2011 Kristaps Dzonsons, - © 2013 Ingo Schwarze, - $Date: 2013/12/31 11:23:23 $ + $Date: 2012/06/09 11:27:38 $