=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.82 retrieving revision 1.103 diff -u -p -r1.82 -r1.103 --- mandoc/Attic/index.sgml 2010/06/19 20:43:35 1.82 +++ mandoc/Attic/index.sgml 2011/01/06 13:45:28 1.103 @@ -15,13 +15,6 @@
- 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, 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. + 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. It is a BSD.lv project.
- The mdocml suite 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, 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. + 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.
man(3) |
man macro compiler library
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
man(7) |
man language reference
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
mandoc(1) |
format and display UNIX manuals
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
mandoc_char(7) |
mandoc special characters
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
mdoc(3) |
mdoc macro compiler library
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
mdoc(7) |
mdoc language reference
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
roff(3) |
roff macro compiler library
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
roff(7) |
roff-mandoc language reference
-
- text | postscript
-
+
+ (text |
+ xhtml |
+ pdf |
+ postscript)
+
|
tbl(7) | ++ tbl-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + + | +
- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. + Please use the mailing lists for bug-reports, patches, questions, etc. (these require + subscription). 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 on-line, although you may request one once subscribed. -
-high-level discussions and version announcements | ++ bug-reports, general questions, and announcements + (archive) + | |
tec...@mdocml.bsd.lv | -low-level discussions | ++ patches and system discussions + (archive) + |
sou...@mdocml.bsd.lv | -source commit messages | ++ source commit messages + (archive) + |
- 19-06-2010: - version 1.10.2 + 03-01-2011: + version 1.10.9
- Small release featuring text-decoration in -Tps output, a few - minor relaxations of errors, and some optimisations. + Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more.
-
- 07-06-2010:
- version 1.10.1
+ tbl functionality (see the TS
, TE
, and
+ T&
macros in the roff manual) has been
+ merged from tbl.bsd.lv. Output is
+ still minimal for -Thtml and -Txhtml, but manages to at least display data. This means that mandoc now has built-in support for two troff preprocessors via
+ libroff: soelim and tbl.
- 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 + 24-12-2010: + version 1.10.8
- 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: + Significant improvements merged from OpenBSD downstream, including
- 13-05-2010: - version 1.9.25 + 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.
-
- 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!
-
- 09-05-2010: - version 1.9.24 -
-
- 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).
-
See cvsweb for historical notes. @@ -410,7 +388,7 @@