- mdocml – mdoc macro compiler -

- DESCRIPTION -

+ 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 UNIX manuals. The mission of mdocml is to - deprecate groff, the GNU troff - implementation, for displaying -mdoc pages whilst providing token support for -man. -

+ DESCRIPTION +

- 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 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. +

- mdocml consists of the libmdoc, libman, and libroff validating compilers; and mandoc, which interfaces with the compiler libraries to format output for UNIX - terminals, XHTML, HTML, and PostScript. mdocml is a BSD.lv project. -

+ 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). +

- Disambiguation: mdocml is often referred to by its installed binary, - mandoc. -

- SOURCES -

+ 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. +

- mdocml is architecture- and system-neutral, written in plain-old C. The most - current version is @VERSION@, dated @VDATE@. A full - ChangeLog (txt) is written with each release. -

+ Disambiguation: mdocml is often referred to by its installed binary, mandoc. +

- Current -

+ SOURCES +

- - - - - - - - - - - - - -

Source archive	- /snapshots/mdocml.tar.gz - (md5) -
Online source	- cvsweb -

+ mdocml is in plain-old ANSI C and should build and run on any UNIX system. The most current + version is @VERSION@, dated @VDATE@. +

- Downstream -

+ Current +

- - - - - - - - - - - - - - - - - - - - - -

DragonFly BSD	- usr.bin/mandoc -
FreeBSD	- ports/textproc/mdocml -
NetBSD	- src/external/bsd/mdocml -
OpenBSD	- src/usr.bin/mandoc -

+ + + + + + + + + + + + + +

Source archive	+ /snapshots/mdocml.tar.gz + (md5) +
Online source	+ cvsweb +

- Historical -

+ Downstream +

- - - - - - - - - -

Source archive

- /snapshots/ -

- DOCUMENTATION -

+ + + + + + + + + + + + + + + + + + + + + +

DragonFly BSD	+ usr.bin/mandoc +
FreeBSD	+ ports/textproc/mdocml +
NetBSD	+ src/external/bsd/mdocml +
OpenBSD	+ src/usr.bin/mandoc +

- These manuals are generated automatically and refer to the current snapshot. -

+ Historical +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

man(3)	- man macro compiler library - - (text \| postscript) - -
man(7)	- man language reference - - (text \| postscript) - -
mandoc(1)	- format and display UNIX manuals - - (text \| postscript) - -
mandoc_char(7)	- mandoc special characters - - (text \| postscript) - -
mdoc(3)	- mdoc macro compiler library - - (text \| postscript) - -
mdoc(7)	- mdoc language reference - - (text \| postscript) - -
roff(3)	- roff macro compiler library - - (text \| postscript) - -
roff(7)	- roff-mandoc language reference - - (text \| postscript) - -

+ + + + + + + + + +

Source archive

+ /snapshots/ +

- See Writing UNIX Manual Pages for a general - introduction to manpages and mdoc. -

- CONTACT -

+ DOCUMENTATION +

- Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact - Kristaps at kris...@bsd.lv. -

+ These manuals are generated automatically and refer to the current snapshot. +

- 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. -

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

mandoc(1)	+ format and display UNIX manuals + + (text \| + xhtml \| + pdf \| + postscript) + +
mandoc(3)	+ mandoc macro compiler library + + (text \| + xhtml \| + pdf \| + postscript) + +
man(7)	+ man language reference + + (text \| + xhtml \| + pdf \| + postscript) + +
eqn(7)	+ eqn-mandoc language reference + + (text \| + xhtml \| + pdf \| + postscript) + +
mandoc_char(7)	+ mandoc special characters + + (text \| + xhtml \| + pdf \| + postscript) + +
mdoc(7)	+ mdoc language reference + + (text \| + xhtml \| + pdf \| + postscript) + +
roff(7)	+ roff-mandoc language reference + + (text \| + xhtml \| + pdf \| + postscript) + +
tbl(7)	+ tbl-mandoc language reference + + (text \| + xhtml \| + pdf \| + postscript) + +

- - - - - - - - - - - - - - - - - -

- 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

- NEWS -

- 12-07-2010: - version 1.10.4 -

- Lots of features developed during both Summer of Code and the - OpenBSD c2k10 hackathon: -

minimal ds roff symbols are supported
Bk mdoc support
beautified SYNOPSIS section output
variable font-width and paper-size support in mandoc - -Tps output
acceptance of scope-block breakage in mdoc
clarify error message status
many minor bug-fixes and formatting issues resolved

- 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 Bl and It macros described in mdoc. Multi-line column support is now fully compatible with - groff, as are implicit list entries for columns. Removed manuals.7 in favour of http://manpages.bsd.lv. The way we - handle the SYNOPSIS section (see the SYNOPSIS documentation in MANUAL STRUCTURE) has also - been considerably simplified compared to groff's method. Furthermore, the -Owidth=width output option has been added to -Tascii (see mandoc). Lastly, initial - PostScript output has been added with the -Tps option to mandoc. It's brutally simple at the moment: fixed-font, with - no font decorations. -

- 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: -

a libroff preprocessor in front of libmdoc and libman stripping out - roff instructions;
end-of-sentence (EOS) detection in free-form and macro lines;
correct handling of tab-separated columnar lists in -mdoc;
improved main calling routines to optionally use mmap() for better - performance;
cleaned up exiting when invoked as -Tlint or over - multiple files with -fign-errors;
error and warning message handling re-written to be unified for libroff, libmdoc, and libman;
handling of badly-nested explicit-scoped macros;
improved free-form text parsing in libman and libmdoc;
significant GNU troff compatibility improvements in -Tascii, largely in terms of spacing;
a regression framework for making sure the many fragilities of GNU troff - aren't trampled in subsequent work;
support for -Tascii breaking at hyphens - encountered in free-form text;
and many more minor fixes and improvements (no really, consult cvsweb and see - for yourself!).

- See cvsweb for - historical notes. -

+ CONTACT +

+ Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + TODO for known issues + before posting. Beyond that, contact Kristaps at kris...@bsd.lv. +

+ NEWS +

+ 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. +

+ Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more. +

+ Initial tbl functionality (see the TS, TE, and + T& macros in the roff manual) has been + merged from tbl.bsd.lv. Output is + still minimal, especially for -Thtml and -Txhtml, but manages to at least display data. This means that mandoc now has built-in support for two troff preprocessors via + ~~libroff~~: soelim and tbl. +

+ Also overhauled the -Thtml and -Txhtml output modes. They now display readable output in arbitrary + browsers, including text-based ones like lynx. See HTML and XHTML manuals in the DOCUMENTATION section for examples. Attention: available style-sheet classes have been considerably + changed! See the example.style.css file for details. + Lastly, ~~libmdoc~~ and ~~libman~~ have been + cleaned up and reduced in size and complexity. +

+ disc...@mdocml.bsd.lv +	+ bug-reports, general questions, and announcements + (archive) +
+ tec...@mdocml.bsd.lv +	+ patches and system discussions + (archive) +
+ sou...@mdocml.bsd.lv +	+ source commit messages + (archive) +