X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/37f8917aeef19cb63f549c0618b20c10b72b103b..1a3bd1cb27795956ca71c666968330b81362d013:/index.sgml?ds=sidebyside diff --git a/index.sgml b/index.sgml index 4eda45c4..08826271 100644 --- a/index.sgml +++ b/index.sgml @@ -20,48 +20,48 @@

- DESCRIPTION + 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 - 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, and PostScript. mdocml 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 + SOURCES

- 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.

@@ -148,11 +148,11 @@

- DOCUMENTATION + DOCUMENTATION

- These manuals are generated automatically and refer to the current snapshot. + These manuals are generated automatically and refer to the current snapshot.

@@ -160,61 +160,118 @@ - - - - - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
man(3) (text)man macro compiler library
man(7) (text)man language referenceman(3) + man macro compiler library + + (text | + pdf | + postscript) + +
mandoc(1) (text)format and display UNIX manualsman(7) + man language reference + + (text | + pdf | + postscript) + +
mandoc_char(7) (text)mandoc special charactersmandoc(1) + format and display UNIX manuals + + (text | + pdf | + postscript) + +
manuals(7) (text)a guide to writing UNIX manualsmandoc_char(7) + mandoc special characters + + (text | + pdf | + postscript) + +
mdoc(3) (text)mdoc macro compiler librarymdoc(3) + mdoc macro compiler library + + (text | + pdf | + postscript) + +
mdoc(7) (text)mdoc language referencemdoc(7) + mdoc language reference + + (text | + pdf | + postscript) + +
roff(3) (text)roff macro compiler libraryroff(3) + roff macro compiler library + + (text | + pdf | + postscript) + +
roff(7) (text)roff-mandoc language referenceroff(7) + roff-mandoc language reference + + (text | + pdf | + postscript) + +
+ +

+ See Writing UNIX Manual Pages for a general + introduction to manpages and mdoc. +

- CONTACT + CONTACT

- 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 on-line, although you may request one once subscribed. + You may also subscribe to several mailing lists (these require subscription, which is + moderated).

@@ -224,23 +281,32 @@ + - + - + -
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) high-level discussions and version announcements
tec...@mdocml.bsd.lv + HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...@mdocml.bsd.lv + + patches and system discussions + (archive) low-level discussions
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
@@ -249,111 +315,131 @@

- NEWS + NEWS

- - - - - - - - - - - - - - - - - - - - - - - - - - -
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: -
    -
  • 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!).
    • -
- Version: 1.10.0. -
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. -
- See - cvsweb - for historical notes. -
+
+

+ 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: +

+ +
+
+

+ 12-07-2010: + version 1.10.4 +

+

+ Lots of features developed during both Summer of Code and the + OpenBSD c2k10 hackathon: +

+ +
+
+

+ 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: +

+ +
+

+ See cvsweb for + historical notes. +

- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/05/25 23:02:32 $ + Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/08/19 20:49:34 $