+
+
-
- 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.
-
+
+ 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.
+
-
+
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).
-
+ 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.
-
+
+ mdocml consists of the libmandoc validating
+ compilers and mandoc, which interfaces with the compiler library to format
+ output for UNIX terminals, XHTML, HTML, PostScript, and PDF. It is a BSD.lv project.
+
-
- 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.
-
- |
-
-
+
+
-
- Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
- variously on i386, AMD64, alpha and others.
-
+
+ mdocml is in plain-old ANSI C and should build and run on any UNIX system.
+ The most current version is @VERSION@, dated @VDATE@.
+
-
- The most current version is @VERSION@, dated
- @VDATE@.
-
+
+ Current
+
-
- Snapshot source
-
+
-
- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory.
-
+
+ Downstream
+
-
- % cd /tmp
- % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -
- % cd mdocml
- % make all
- % make regress
- # make install
-
+
-
- Snapshot port/pkgsrc
-
+
+ Historical
+
-
- 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/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
-
+
+ Use the mailing lists for bug-reports, patches, questions, etc. (these require
+ subscription).
+ Please check the
+ TODO for known issues
+ before posting.
+ Beyond that, contact Kristaps at kris...@bsd.lv.
+
-
- FreeBSD port
-
-
-
- # pkg_delete -x mdocml
- # cd /tmp
- # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make
- # make install
-
- |
-
-
-
-
- CONTACT
-
-
-
- Please 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.
-
- |
-
-