|
-
- mdocml – mdoc macro compiler
-
- |
- |||||||||||||||||||||||||||||||||||||||||||
-
+
+
+
+
+
+ |
+
|
+
+ mdocml – mdoc macro compiler
+
+ |
+ ||||||||||||||
+ DESCRIPTION -+ -- 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 system. - +
+ mdocml is a suite of tools compiling - 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 composed of 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 mdocml utility is a BSD.lv + Project member. + + |
+ ||||||||||||||
+ + SOURCES +-- 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. - ++ Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux 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. + -- 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 SOURCES -++ Current +-- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. - +
- nightly source -++ Downstream +-- CVS sources are checkedout and snapshotted nightly. These may be found in the /snapshots/ directory. - +
- % cd /tmp + Historical +-- nightly port -+
|
+ ||||||||||||||
+ + DOCUMENTATION +-- The nightly 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. - ++ These manuals are generated automatically and refer to the current snapshot. + -- If installing for the first time: - +
|
+ ||||||||||||||
+ + CONTACT +-
- % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf - + For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. + -- Subsequent installations: - ++ If you want to receive a semi-automated mail-out of new releases, then please write with a message + subject of subscribe mdocml (or unsubscribe mdocml). + + |
+ ||||||||||||||
+ + NEWS +-- % sudo pkg_add -r mdocml - - |
- ||||||||||||||
- - 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. - - |
- ||||||||||||||
|
-
- Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/23 15:38:20 $
-
- |
-
| xx-03-2010 | ++ Version 1.9.17 highlights: accept perlpod macros. + | +
| 22-03-2010 | +
+ Version 1.9.16 highlights: inspired by patches and bug
+ reports by Ingo Schwarze, allowed -man to accept
+ non-printing elements to be nested within next-line scopes, such as br+ within Bor TH, which is valid roff. Longsoon architecture also + noted and Makefile cleaned up. + |
+
| 18-02-2010 | +
+ Moved to our new BSD.lv home.
+ Version 1.9.15 highlights: XHTML is now an acceptable
+ output mode for mandoc(1); Xrmade more + compatible with groff; Vtfixed when invoked in SYNOPSIS; \\+ escape removed; end-of-line white-space detected for all lines; subtle bug + fixed in list display for some modes; compatibility layer checked in for + compilation in diverse UNIX systems; and column lengths handled correctly. + |
+