mdocml – mdoc macro compiler

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

SOURCES

Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and 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 (with mandoc(1) -Thtml) 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 Džonsons, kris...@kth.se.

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