|
-
- mdocml – mdoc macro compiler
-
-
- |
- ||||||||||||||||
- - DESCRIPTION -++ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@) + ++ Sources: current, + cvsweb + (archives) + ++ Description +++ 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. The mission of mdocml is to deprecate 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 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 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, + Sources ++
+ 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 + Downstream ++
+ 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
+
+ Documentation +++ These manuals are generated automatically and refer to the current release. + They are the authoritative documentation for the mdocml system. + -
- mdocml is a suite of tools compiling - 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). - - -- The core of mdocml is composed of the libmdoc, libman, and libroff validating compiler libraries. All - are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends - (terminal-based, CGI and so on). The front-end is mandoc, which formats - manuals for display. - - -- The mdocml suite is a BSD.lv - Project member. - - |
- ||||||||||||||||
- - SOURCES -- -- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many - other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version - is @VERSION@, dated @VDATE@. A full ChangeLog (txt) is written with each release. - - -- Current -- -
- Downstream -- -
- Historical -- -
|
- ||||||||||||||||
- - DOCUMENTATION -- -- These manuals are generated automatically and refer to the current snapshot. - - -
- See |
- ||||||||||||||||
- - CONTACT -- -- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. - - -- You may also subscribe to several mailing lists (these require subscription, which is moderated). An - archive is not yet available on-line, although you may request one once subscribed. - - -
|
- ||||||||||||||||
- - NEWS --
-
- - 12-07-2010: - version 1.10.4 - -- Lots of features developed during both Summer of Code and the - OpenBSD c2k10 hackathon: - - -
-
- - 19-06-2010: - version 1.10.2 - -- Small release featuring text-decoration in -Tps output, a few - minor relaxations of errors, and some optimisations. - -
-
- - 07-06-2010: - version 1.10.1 - -
- This primarily focusses on the
-
- - 29-05-2010: - version 1.10.0 - -- Release consisting of the results from the m2k10 hackathon and up-merge from OpenBSD. - This requires a significant note of thanks to Ingo Schwarze (OpenBSD) and Joerg - Sonnenberger (NetBSD) for their hard work, and again to Joerg for hosting m2k10. - Highlights (mostly cribbed from Ingo's m2k10 report) follow in no particular order: - -
-
- - 13-05-2010: - version 1.9.25 - -
- Fixed handling of
-
- - 09-05-2010: - version 1.9.24 - -
- Rolled back break-at-hyphen. -DUGLY is now the
- default (no feature splits!). Free-form text is not de-chunked any more: lines
- are passed whole-sale into the front-end, including whitespace. Added mailing
- lists. Lastly, mdocml is the focus of two Google Summer of Code
- projects this year: - See cvsweb for - historical notes. - - |
- ||||||||||||||||
|
-
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/07/11 23:07:47 $
-
- |
-
| apropos(1) | ++ search the manual page database + | +
| demandoc(1) | ++ emit only text of UNIX manuals + | +
| mandoc(1) | ++ format and display UNIX manuals + | +
| preconv(1) | ++ recode multibyte UNIX manuals + | +
| mandoc(3) | ++ mandoc macro compiler library + | +
| tbl(3) | ++ roff table parser library for mandoc + | +
| eqn(7) | ++ eqn-mandoc language reference + | +
| man(7) | ++ man language reference + | +
| man.cgi(7) | ++ cgi for manpage query and display + | +
| mandoc_char(7) | ++ mandoc special characters + | +
| mdoc(7) | ++ mdoc language reference + | +
| roff(7) | ++ roff-mandoc language reference + | +
| tbl(7) | ++ tbl-mandoc language reference + | +
| mandocdb(8) | ++ index UNIX manuals + | +
+ Use the mailing lists for bug-reports, patches, questions, etc. Please check the + TODO for known issues + before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, + contact Kristaps at kris...@bsd.lv. Archives are available at Gmane. +
+| + disc...@mdocml.bsd.lv + | ++ bug-reports, general questions, and announcements + | +
| + tec...@mdocml.bsd.lv + | ++ patches and system discussions + | +
| + sou...@mdocml.bsd.lv + | ++ source commit messages + | +
+ xx-xx-2013: version 1.13.0 +
++ The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database. +
++ 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.
+
+ See NEWS for historical notes. +
++ 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. +
++ See cvsweb for + historical notes. +
++ + Copyright © 2008–2011 + Kristaps Dzonsons, + © 2013 Ingo Schwarze, + $Date: 2013/10/05 20:09:24 $ + +