|
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-
+
+
+
+
+
+ |
+
|
+
+ mdocml – mdoc macro compiler
+
+ |
+ |||||||||||||||||||||
+ DESCRIPTION -+ -- 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 +
+ mdocml is a suite of tools compiling + 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 composed of the libmdoc and libman + + 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. - - |
- |||||||||||||||||||||
- - INSTALLING SOURCES -- -- Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested - variously on i386, AMD64, alpha and others. The most current version is @VERSION@, dated @VDATE@. - - -- Snapshot source -- -- 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. - - -
- % cd /tmp - Snapshot port/pkgsrc -- -- 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. - - -- OpenBSD port -- -- Note: the mdocml utility is part of OpenBSD's base system at usr.bin/mandoc. Please use this - instead of the provided port. - - -
- # pkg_delete mdocml - NetBSD pkgsrc -- -- Note: a pkgsrc port is maintained in-tree at textproc/mdocml. Please use this - instead of the provided pkgsrc. - - -
- # pkg_delete mdocml - FreeBSD port -- -- Note: a port is maintained in-tree at textproc/mdocml. Please use - this instead of the provided port. - - -
- # pkg_delete -x mdocml |
- |||||||||||||||||||||
- + + ++ The mdocml utility is a BSD.lv + Project member. + + |
+ |||||||||||||||||||||
+ + SOURCES ++ ++ 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. + + ++ Current ++ +
+ Downstream ++ +
+ Historical ++ +
|
+ |||||||||||||||||||||
+ DOCUMENTATION -- -
|
- |||||||||||||||||||||
- ++ ++ These manuals are generated automatically and refer to the current snapshot. + + +
|
+ |||||||||||||||||||||
+ CONTACT -- -- For all issues related to mdocml, contact Kristaps, kris...@kth.se. - - -- 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 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. - - |
- |||||||||||||||||||||
|
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/15 11:24:16 $
-
- |
-
+ 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. +
+ +| + disc...@mdocml.bsd.lv + | +discussions and announcements | +
| + sou...@mdocml.bsd.lv + | +source commit messages | +
| xx-05-2010 | + Day 1 of Rostock hackathon: proper handling of quotations in tab-separated + column lists, finished patching of SYNOPSIS breaking (1.9.25), fixed pre-comment + white-space stripping, added end-of-sentence spacing to black partial-implicit + macros, relaxed column warnings, relaxed acceptence of bad standards arguments, + significant documentation of lists in mdoc(7). + Version: 1.9.26. ++ |
| 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. + | +
| 31-03-2010 | +
+ Version 1.9.22: adjusted merge of the significant work
+ by Ingo Schwarze in getting Xoblocks (block full implicit, e.g., + Itfor non-columnar lists) to work properly. This isn't enabled by + default: you must specify -DUGLY as a compiler flag + (see the Makefile for details). + |
+
| 30-03-2010 | +
+ Version 1.9.20: more efforts to get roff instructions
+ in -man documents under control. Note that roff instructions embedded in
+ line-scoped, next-line macros (e.g. B) are not supported. Leading + punctuation for -mdoc macros, such as Fl ( ( a, are now correctly + handled. + |
+
| 27-03-2010 | +
+ Version 1.9.18: many fixes (largely pertaining to
+ scope) and improvements (e.g., handling of apostrophe-control macros, which
+ fixes the strange BRseen in some macro output) to handling roff + instructions in -man documents. + |
+
| 25-03-2010 | +
+ Version 1.9.17 highlights: accept perlpod standard preamble.
+ Also accept (and discard) de, dei, am, ami, and + igroff macro blocks. + |
+
| 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. + |
+