- mdocml is a suite of tools that compile “mdoc”, the roff macro - package of the BSD manual pages. The mission of mdocml is to deprecate groff, the GNU roff implementation, for - displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a - considerable encumbrance to BSD operating systems. + mdocml is a suite of tools compiling “-mdoc”, the roff macro + package of choice for BSD manual pages. The mission of mdocml is to deprecate + groff, the GNU roff implementation, + for displaying -mdoc pages.
- 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 - of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the mdoc(3) reference manual. + 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).
- There are three utilities implementing mdoc(3): + 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 mdocterm(1) utility is intended to deprecate usage of groff for displaying BSD manuals to the - terminal, either directly or cached as a “catman” page. + 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. + Please submit patches, bug reports and suggestions! Although a significant + implementation exists, work remains for the backend library and especially the front-end utilities. See + the contact information below for submissions.
@@ -69,16 +63,21 @@- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. + 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@. +
+- CVS sources are checkedout and snapshotted with big updates. These may be found in the /snapshots/ directory.
@@ -92,25 +91,61 @@- The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not - yet available). These may be found in the /ports-openbsd/ directory. - You must have the ports tree installed. + The 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, the NetBSD pkgsrc guide or the FreeBSD ports + guide, first.
+
# pkg_delete mdocml
- # cd /usr/ports/devel/
+ # cd /usr/ports/textproc/
# rm -rf mdocml
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -
# cd mdocml
# make build
- # make regress
# make install
+ # pkg_delete mdocml
+ # cd /usr/pkgsrc/textproc/
+ # rm -rf mdocml
+ # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -
+ # cd mdocml
+ # make build
+ # make install
+
+ # pkg_delete mdocml
+ # cd /usr/ports/textproc/
+ # rm -rf mdocml
+ # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -
+ # cd mdocml
+ # make build
+ # make install
+