- 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 roff 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). -
- -- The core of mdocml is composed of the libmdoc and libman - validating compiler libraries. Both 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 primary front-end is - mandoc, which formats manuals for display on the terminal. -
- -- The mdocml utility is a BSD.lv - Project member. -
-- SOURCES -
- -- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux 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 -
- -| 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. -
- -| mandoc(1) (text) | -format and display UNIX manuals | -
| mandoc_char(7) (text) | -mandoc special characters | -
| mdoc(7) (text) | -mdoc language reference | -
| man(7) (text) | -man language reference | -
| manuals(7) (text) | -a guide to writing UNIX manuals | -
| mdoc(3) (text) | -mdoc macro compiler library | -
| man(3) (text) | -man macro compiler library | -
- CONTACT -
- -- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. -
- -- If you want to receive a semi-automated mail-out of new releases, then please write with a message - subject of subscribe mdocml (or unsubscribe mdocml). -
-- NEWS -
- -| 18-02-2010 | -
- Moved to our new BSD.lv home.
- Version 1.9.15 highlights: XHTML is now an acceptable
- output mode for mandoc(1); Xrmade more - compatible with groff; Vtfixed when invoked in SYNOPSIS; \\- escape removed; end-of-line white-space detected for all lines; subtle bug - fixed in list display for some modes; compatibility layer checked in for - compilation in diverse UNIX systems; and column lengths handled correctly. - |
-