|
- 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.
+ 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 troff
+ implementation, for displaying -mdoc pages whilst providing token support for -man.
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).
+ this (respectively small, C, ISC-licensed, fast and regular).
- 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.
+ mdocml consists of the libmdoc, libman, and libroff validating compilers; and mandoc, which interfaces with the compiler libraries to format output for UNIX
+ terminals, XHTML, HTML, PostScript, and PDF. mdocml is a BSD.lv project.
- The mdocml utility is a BSD.lv
- Project member.
+ Disambiguation: mdocml is often referred to by its installed binary,
+ mandoc .
|
|
- 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.
+ mdocml is architecture- and system-neutral, written in plain-old C. The most
+ current version is @VERSION@, dated @VDATE@. A full
+ ChangeLog (txt) is written with each release.
@@ -68,7 +69,7 @@
-
+
@@ -81,7 +82,7 @@
| Online source |
- cvsweb
+ cvsweb
|
@@ -92,7 +93,7 @@
-
+
@@ -131,7 +132,7 @@
-
+
@@ -147,88 +148,173 @@
|
- These manuals are generated automatically and refer to the current snapshot.
+ These manuals are generated automatically and refer to the current snapshot.
+
+
+ See Writing UNIX Manual Pages for a general
+ introduction to manpages and mdoc.
+
|
|
- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv.
+ Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact
+ Kristaps at kris...@bsd.lv.
- You may also subscribe to several mailing lists (these require subscription, which is moderated). An
- archive is not yet available.
+ You may also subscribe to several mailing lists (these require subscription, which is
+ moderated).
-
+
|
disc...@mdocml.bsd.lv
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...@mdocml.bsd.lv
+ |
+
+ bug-reports, general questions, and announcements
+ (archive)
+ |
+
+
+ |
+ tec...@mdocml.bsd.lv
+ |
+
+ patches and system discussions
+ (archive)
|
- discussions and announcements |
|
sou...@mdocml.bsd.lv
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...@mdocml.bsd.lv
+ |
+
+ source commit messages
+ (archive)
|
- source commit messages |
@@ -237,133 +323,174 @@
|
- NEWS
+ NEWS
-
-
-
-
-
- | 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 \*(Ba escape. 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-line rule. 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 Xo blocks (block full implicit, e.g.,
- It for 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 BR seen 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
- ig roff 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 B or 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); Xr made more
- compatible with groff; Vt fixed 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.
- |
-
-
-
+
+
+ 24-12-2010:
+ version 1.10.8
+
+
+ Significant improvements merged from OpenBSD downstream, including
+
+
+ - many new roff components,
+ - in-line implementation of troff's soelim,
+ - broken-block handling,
+ - overhauled error classifications, and
+ - cleaned up handling of error conditions.
+
+
+ Also overhauled the -Thtml and -Txhtml output modes. They now display readable output in arbitrary
+ browsers, including text-based ones like lynx. See HTML and XHTML manuals in the DOCUMENTATION section for examples. Attention: available style-sheet classes have been considerably
+ changed! See the example.style.css file for details.
+ Lastly, libmdoc and libman have been
+ cleaned up and reduced in size and complexity.
+
+
+
+ 27-09-2010:
+ version 1.10.6
+
+
+ Calling conventions for mandoc have changed: -W improved and -f deprecated. Non-ASCII
+ characters are also now uniformly discarded. Lots of documentation improvements. Many
+ incremental fixes accomodating for groff's more interesting productions. Lastly, pod2man preambles are
+ now fully accepted after some considerable roff and special
+ character support.
+
+
+
+ 27-07-2010:
+ version 1.10.5
+
+
+ Primarily a bug-fix and polish release, but including -Tpdf
+ support in mandoc by way of Summer of Code.
+ Highlights:
+
+
+ - fix
Sm and Bd handling
+ - fix end-of-sentence handling for embedded sentences
+ - polish man documentation
+ - document all mdoc macros
+ - polish mandoc -Tps output
+ - lots of internal clean-ups in character escapes
+ - un-break literal contexts in man documents
+ - improve -Thtml output for -man
+ - add mandoc -Tpdf support
+
+
+
+ 12-07-2010:
+ version 1.10.4
+
+
+ Lots of features developed during both Summer of Code and the
+ OpenBSD c2k10 hackathon:
+
+
+ - minimal
ds roff symbols are supported
+ Bk mdoc support- beautified SYNOPSIS section output
+ - variable font-width and paper-size support in mandoc
+ -Tps output
+ - acceptance of scope-block breakage in mdoc
+ - clarify error message status
+ - many minor bug-fixes and formatting issues resolved
+
+
+
+ 19-06-2010:
+ version 1.10.2
+
+
+ Small release featuring text-decoration in -Tps output, a few
+ minor relaxations of errors, and some optimisations.
+
+
+
+ 07-06-2010:
+ version 1.10.1
+
+
+ This primarily focusses on the Bl and It macros described in mdoc. Multi-line column support is now fully compatible with
+ groff, as are implicit list entries for columns. Removed manuals.7 in favour of http://manpages.bsd.lv. The way we
+ handle the SYNOPSIS section (see the SYNOPSIS documentation in MANUAL STRUCTURE) has also
+ been considerably simplified compared to groff's method. Furthermore, the -Owidth=width output option has been added to -Tascii (see mandoc). Lastly, initial
+ PostScript output has been added with the -Tps option to mandoc. It's brutally simple at the moment: fixed-font, with
+ no font decorations.
+
+
+
+ 29-05-2010:
+ version 1.10.0
+
+
+ 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:
+
+
+ - a libroff preprocessor in front of libmdoc and libman stripping out
+ roff instructions;
+ - end-of-sentence (EOS) detection in free-form and macro lines;
+ - correct handling of tab-separated columnar lists in -mdoc;
+ - improved main calling routines to optionally use mmap() for better
+ performance;
+ - cleaned up exiting when invoked as -Tlint or over
+ multiple files with -fign-errors;
+ - error and warning message handling re-written to be unified for libroff, libmdoc, and libman;
+ - handling of badly-nested explicit-scoped macros;
+ - improved free-form text parsing in libman and libmdoc;
+ - significant GNU troff compatibility improvements in -Tascii, largely in terms of spacing;
+ - a regression framework for making sure the many fragilities of GNU troff
+ aren't trampled in subsequent work;
+ - support for -Tascii breaking at hyphens
+ encountered in free-form text;
+ - and many more minor fixes and improvements (no really, consult cvsweb and see
+ for yourself!).
+
+
+ See cvsweb for
+ historical notes.
+
|
|
|
|