=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.6 retrieving revision 1.74 diff -u -p -r1.6 -r1.74 --- mandoc/Attic/index.sgml 2009/02/25 12:32:50 1.6 +++ mandoc/Attic/index.sgml 2010/05/25 23:02:32 1.74 @@ -1,146 +1,363 @@ - -
- - - -
-
- 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 systems. - +
+ 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, 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. + -
+ The mdocml suite 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, 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. + -- 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. - +
- snapshotted source -++ Downstream +-- CVS sources are checkedout and snapshotted with big updates. These may be found in the /snapshots/ directory. - +
- % cd /tmp + Historical +-- nightly port -+
|
+ ||||||||||||||||||
+ + DOCUMENTATION +-- 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. - ++ These manuals are generated automatically and refer to the current snapshot. + -
- # pkg_delete 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/25 12:32:50 $
-
- |
-
+ For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. +
+ ++ 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. +
+ ++ disc...@mdocml.bsd.lv + | +high-level discussions and version announcements | +
+ tec...@mdocml.bsd.lv + | +low-level discussions | +
+ sou...@mdocml.bsd.lv + | +source commit messages | +
xx-05-2010 | +
+ Release consisting of the results from the m2k10 hackathon and up-merge from
+ OpenBSD. This requires a significant note of thanks to Ingo Schwarze (OpenBSD)
+ and Joerg Sonnenberger (NetBSD) for their hard work, and again to Joerg for
+ hosting m2k10. Highlights (mostly cribbed from Ingo's m2k10 report) follow in
+ no particular order:
+
|
+
13-05-2010 | +
+ Fixed handling of \*(Baescape. Backed out -fno-ign-chars (pointless complexity). Fixed erroneous + breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial + macros. Changed default section ordering. Most importantly, the framework for + end-of-sentence double-spacing is in place, now implemented for the + end-of-sentence, end-of-linerule. This is a stable roll-back point + before the mandoc hackathon in Rostock! + Version: 1.9.25. + |
+
09-05-2010 | +
+ Rolled back break-at-hyphen. -DUGLY is now the
+ default (no feature splits!). Free-form text is not de-chunked any more: lines
+ are passed whole-sale into the front-end, including whitespace. Added mailing
+ lists. Lastly, mdocml is the focus of two Google Summer of Code
+ projects this year: mandoc -Tps+ (NetBSD) and BSD-licensed + Text-Processing Tools(FreeBSD). + Version: 1.9.24. + |
+
07-04-2010 | ++ mdocml has been linked to the OpenBSD build. This + version incorporates many small changes, mostly from patches by OpenBSD, + allowing crufty manuals to slip by with warnings instead of erroring-out. Some + subtle semantic issues, such as punctuation scope, have also been fixed. + Lastly, some issues with -Thtml have been fixed, which + prompted an update to the online manual pages style + layout. Version: 1.9.23. + | +
+ | + See + cvsweb + for historical notes. + | +