X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/63aa9d77e4526a51fbef92b2bfebf5d640087f56..b088e954af8efacd0953fb5fb903d2e434649ebf:/index.sgml diff --git a/index.sgml b/index.sgml index a9d26019..32494e44 100644 --- a/index.sgml +++ b/index.sgml @@ -1,154 +1,441 @@ - - - - - - mdocml.bsd.lv - - - - - - - - - - - - - - - - - - - - - -
-
- 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 system. -

- -

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

- -

- There are three utilities implementing mdoc(3): -

- -
    -
  • mdocterm(1) – formats mdoc input for display on the terminal -
  • mdochtml(1) – formats mdoc input as strict HTML (nascent) -
  • mdoclint(1) – validates mdoc input -
  • mdoctree(1) – prints input abstract syntax tree -
- -

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

- -

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

- -

- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. -

- -

- nightly source -

- -

- CVS sources are checkedout and snapshotted nightly. These may be found in the /snapshots/ directory. -

- -

- % cd /tmp
- % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -
- % cd mdocml
- % make
- % make regress
- % make install -

- -

- nightly port -

- -

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

- -

- If installing for the first time (you must have the ports tree installed): -

- -

- % cd /usr/ports/devel/
- % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -
- % cd mdocml
- % sudo make
- % sudo make install -

- -

- Subsequent installations: -

- -

- % sudo pkg_add -r 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/23 16:01:33 $ -
-
- - + + + + + + mdocml | mdoc macro compiler + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ mdocml – mdoc macro compiler +
+
+ Description | + Sources | + Documentation | + Contact | + News +
+
+

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

+ +

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

+ +

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

+ +

+ Current +

+ + + + + + + + + + + + + + +
Source archive + /snapshots/mdocml.tar.gz + (md5) +
Online source + cvsweb +
+ +

+ Downstream +

+ + + + + + + + + + + + + + + + + + + + + + +
DragonFly BSD + usr.bin/mandoc +
FreeBSD + ports/textproc/mdocml +
NetBSD + src/external/bsd/mdocml +
OpenBSD + src/usr.bin/mandoc +
+ +

+ Historical +

+ + + + + + + + + + +
Source archive + /snapshots/ +
+
+

+ DOCUMENTATION +

+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
man(3) + man macro compiler library + +
man(7) + man language reference + +
mandoc(1) + format and display UNIX manuals + +
mandoc_char(7) + mandoc special characters + +
mdoc(3) + mdoc macro compiler library + +
mdoc(7) + mdoc language reference + +
roff(3) + roff macro compiler library + +
roff(7) + roff-mandoc language reference + +
+ +

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

+
+

+ CONTACT +

+ +

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

+ NEWS +

+
+

+ 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!).
    • +
+
+
+

+ 13-05-2010: + version 1.9.25 +

+

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

+
+
+ Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/07/11 23:07:47 $ +
+
+ +