- What are UNIX manuals? Read manuals(7) for an introduction. -
- -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 are the man(3) and mdoc(3) libraries, validating compilers producing intermediate-form - output from -man or -mdoc input. 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 core of mdocml are 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.
- -- The primary front-end is mandoc(1), which formats manuals for - display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a - limited extent, -man manuals on the terminal. -
- -- 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. + variously on i386, AMD64, alpha and others. The most current version is @VERSION@, dated @VDATE@.
-- The most current version is @VERSION@, dated - @VDATE@. -
-- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. A full ChangeLog is - written with each new snapshot. + CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots) + may be found in the /snapshots/ directory. A full ChangeLog is written with each new snapshot.
@@ -160,28 +139,83 @@
| mandoc(1) | ++ | format and display UNIX manuals | +
| mandoc_char(7) | ++ | mandoc special characters | +
| mdoc(7) | ++ | mdoc language reference | +
| man(7) | ++ | man language reference | +
| manuals(7) | ++ | a guide to writing UNIX manuals | +
| mdoc(3) | ++ | mdoc macro compiler library | +
| man(3) | ++ | man macro compiler library | +
- Please contact Kristaps, krismdocml, contact Kristaps, kris...@kth.se, with questions, bug reports, patches, and so - on. + false;" title="Reveal this e-mail address">...@kth.se.
- +- 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. + If you want to receive a semi-automated mail-out of new versions, then please write with a message + subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”).
+ ++ We don't yet offer anonymous CVS access. If you must have read-only access to the CVS tree (for + down-stream maintenance and so on), then please contact Kristaps directly for a read-only CVS account. + We strongly suggest using snapshots, instead. +