mdocml – mdoc macro compiler
|
DESCRIPTIONmdocml is a suite of tools compiling “-mdoc”, the roff macro package for BSD manual pages. The mission of mdocml is to deprecate groff, the GNU roff implementation, for displaying BSD mdoc pages. 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 the libmdoc library, a validating scanner-parser producing intermediate-form output from -mdoc input. libmdoc is a simple, fast library operating on memory buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is mandoc(1), which formats -mdoc manuals for display on the terminal. The mandoc(1) utility is intended to deprecate usage of groff for displaying mdoc manuals on the terminal. Please submit patches! Although a significant implementation exists, work remains for the backend library and especially the front-end utilities. See the contact information below to submit patches and bug reports. |
INSTALLING SOURCESSources 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@. Snapshot sourceCVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory.
% cd /tmp Snapshot port/pkgsrcThe source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at /ports-openbsd/, /ports-netbsd/ and /ports-freebsd/, respectively. Please read the OpenBSD Ports FAQ, NetBSD pkgsrc guide or FreeBSD Ports Guide first. OpenBSD port
# pkg_delete mdocml NetBSD pkgsrc
# pkg_delete mdocml FreeBSD port
# pkg_delete mdocml |
CONTACTPlease contact Kristaps, kris...@kth.se, with questions, bug reports, patches, and so on. If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/03/24 10:28:06 $
|