- 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. + It is small, ISO C, ISC-licensed, and quite fast. +
++ 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. +
++ 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
.
+
+ 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 make install.
+ Be careful: the preconv, apropos, and whatis binary names are usually taken by existing utilities.
+
+ 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
+ official
, so 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) + | +
| FreeBSD 10.0, -CURRENT | ++ contrib/mdocml (1.12.1 sources) + usr.bin/mandoc (build system) + | +
| 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) + | +
| OpenBSD | ++ src/usr.bin/mandoc (1.12.3 sources under active development and build system) + | +
| pkgsrc | ++ textproc/mdocml (1.12.3 port) + | +
| Minix3 | ++ external/bsd/mdocml (1.10.9 sources and build system) + | +
| Alpine Linux | ++ aports/main/mdocml (1.12.2 port) + | +
+ 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 -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 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 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. -
- -
- Disambiguation: mdocml is often referred to by its installed binary,
- mandoc
.
-
- SOURCES -
- -- 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. -
- -- Current -
- -| Source archive | -- /snapshots/mdocml.tar.gz - (md5) - | -
| Online source | -- cvsweb - | -
- Downstream -
- -| DragonFly BSD | -- usr.bin/mandoc - | -
| FreeBSD | -- ports/textproc/mdocml - | -
| NetBSD | -- src/external/bsd/mdocml - | -
| OpenBSD | -- src/usr.bin/mandoc - | -
- Historical -
- -| Source archive | -- /snapshots/ - | -
- DOCUMENTATION -
- -- These manuals are generated automatically and refer to the current snapshot. -
- -| 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) - - | -
- See Writing UNIX Manual Pages
for a general
- introduction to manpages and mdoc.
-
- CONTACT -
- -- Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact - Kristaps at 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. -
- -| - 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: -
- -- 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. -
-