+
+
-
- mdocml 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.
-
+
+ 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 roughly 5,2 MB of source code (OpenBSD 4.2), some 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).
-
+
+ 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
- of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the mdoc(3) reference manual.
-
+
+ The core of mdocml is composed of the libmdoc, libman, and libroff validating compiler libraries. All
+ 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 front-end is mandoc, which formats
+ manuals for display.
+
-
- There are three utilities implementing mdoc(3):
-
+
+ The mdocml suite is a BSD.lv
+ Project member.
+
+ |
+
+
+
+
-
- - mdocterm(1) – formats mdoc input for display on the terminal
-
- mdochtml(1) – formats mdoc input as HTML/CSS (nascent)
-
- mdoclint(1) – validates mdoc input
-
- mdoctree(1) – prints input abstract syntax tree
-
+
+ Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many
+ other 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.
+
-
- 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.
-
+
+ Current
+
-
- 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.
-
- |
-
-
+
+
-
- OpenBSD port
-
+
+ For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv.
+
-
- # pkg_delete mdocml
- # cd /usr/ports/devel/
- # rm -rf mdocml
- # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
-
+
+ You may also subscribe to several mailing lists (these require subscription, which is moderated). An
+ archive is not yet available on-line, although you may request one once subscribed.
+
-
- NetBSD pkgsrc
-
-
-
- # pkg_delete mdocml
- # cd /usr/pkgsrc/devel/
- # rm -rf mdocml
- # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # 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.
-
- |
-
-