+ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
+
- mdocml – mdoc macro compiler
+
+ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
+
+ Sources: current, + cvsweb + (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
.
- mdocml is in plain-old ANSI C and should build and run on any UNIX system, although mandocdb requires Berkeley Database (this is
- installed by default on all BSD operating systems).
- To compile mdocml, run make, then make install to install into
- /usr/local.
- 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. You must run make
- mandocdb to build it (it does not install).
-
- The most current version of mdocml is @VERSION@, dated @VDATE@.
+ 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.
| Source archive | +DragonFly BSD | - /snapshots/mdocml.tar.gz - (md5) + contrib/mdocml (1.12.3 sources) + lib/libmandoc + usr.bin/mandoc (build system) |
| Online source | +FreeBSD 10.0, -CURRENT | - cvsweb + contrib/mdocml (1.12.1 sources) + usr.bin/mandoc (build system) |
| DragonFly BSD | +FreeBSD 9.x, 8.x | - usr.bin/mandoc + ports/textproc/mdocml (1.12.2 port) |
| FreeBSD | +NetBSD | - ports/textproc/mdocml + src/external/bsd/mdocml (1.12.1 sources plus patches and build system) |
| NetBSD | +OpenBSD | - src/external/bsd/mdocml + src/usr.bin/mandoc (1.12.3 sources under active development and build system) |
| OpenBSD | +pkgsrc | - src/usr.bin/mandoc + textproc/mdocml (1.12.3 port) + | +
| Minix3 | ++ external/bsd/mdocml (1.10.9 sources and build system) |
| Source archive | +Alpine Linux | - /snapshots/ + aports/main/mdocml (1.12.2 port) |
| mandoc(1) | +apropos(1) | - format and display UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + search the manual page database |
| mandocdb(8) | +demandoc(1) | - index UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + emit only text of UNIX manuals + | +
| mandoc(1) | ++ format and display UNIX manuals | |
| preconv(1) | recode multibyte UNIX manuals - - (text | - xhtml | - pdf | - postscript) - | |
| mandoc(3) | mandoc macro compiler library - - (text | - xhtml | - pdf | - postscript) - | |
| man(7) | +tbl(3) | - man language reference - - (text | - xhtml | - pdf | - postscript) - + roff table parser library for mandoc |
| eqn(7) | eqn-mandoc language reference - - (text | - xhtml | - pdf | - postscript) - + | +|
| man(7) | ++ man language reference + | +|
| man.cgi(7) | ++ cgi for manpage query and display | |
| 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) - + | +|
| 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) |