+ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
- mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@)
+
+ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
Sources: current, cvsweb (archives) - | - Binaries: windows 32-bit, windows 64-bit, mac os x - (archives)
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. + UNIX manuals. + It is small, ISO C, ISC-licensed, and quite fast.
- 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 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 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; and mandocdb, for indexing manuals. - 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
.
@@ -50,20 +56,11 @@
Sources
- mdocml is in plain-old ANSI C and should build and run on any modern system.
- To build and install into /usr/local/, just run make install.
- Be aware: if you have an existing groff installation, this may overwrite its preconv binary.
- The mandocdb utility is not yet linked to the build; please contact
- us if you plan to use it.
-
- Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
- Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
- Windows binaries are compiled with MingW for the 32-bit (i686) and
- 64-bit (x86_64) architectures.
+ 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.
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
.
- Please contact us if you plan on maintaining a downstream version!
+ official
, so please contact us if you plan on maintaining a downstream version!
| DragonFly BSD | - usr.bin/mandoc + contrib/mdocml (1.12.3 sources) + lib/libmandoc + usr.bin/mandoc (build system) | |
| FreeBSD | +FreeBSD 10.0, -CURRENT | - ports/textproc/mdocml + 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 + src/external/bsd/mdocml (1.12.1 sources plus patches and build system) | |
| OpenBSD | - src/usr.bin/mandoc + 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) | |
| mandoc(1) | +apropos(1) | - format and display UNIX manuals - (text | - xhtml | - pdf | - ps) + search the manual page database |
| mandocdb(8) | +demandoc(1) | - index UNIX manuals - (text | - xhtml | - pdf | - ps) + emit only text of UNIX manuals + | +
| mandoc(1) | ++ format and display UNIX manuals | |
| preconv(1) | recode multibyte UNIX manuals - (text | - xhtml | - pdf | - ps) | |
| mandoc(3) | mandoc macro compiler library - (text | - xhtml | - pdf | - ps) | |
| man(7) | +tbl(3) | - man language reference - (text | - xhtml | - pdf | - ps) + roff table parser library for mandoc |
| eqn(7) | eqn-mandoc language reference - (text | - xhtml | - pdf | - ps) + | +|
| man(7) | ++ man language reference + | +|
| man.cgi(7) | ++ cgi for manpage query and display | |
| mandoc_char(7) | mandoc special characters - (text | - xhtml | - pdf | - ps) | |
| mdoc(7) | mdoc language reference - (text | - xhtml | - pdf | - ps) | |
| roff(7) | roff-mandoc language reference - (text | - xhtml | - pdf | - ps) | |
| tbl(7) | tbl-mandoc language reference - (text | - xhtml | - pdf | - ps) + | +|
| mandocdb(8) | ++ index UNIX manuals |
- Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + Use the mailing lists for bug-reports, patches, questions, etc. Please check the TODO for known issues - before posting. Beyond that, contact Kristaps at kris...@bsd.lv. + 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.
| bug-reports, general questions, and announcements - (archive) |
| patches and system discussions - (archive) |
| source commit messages - (archive) |