=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.28 retrieving revision 1.102 diff -u -p -r1.28 -r1.102 --- mandoc/Attic/index.sgml 2009/09/21 13:06:13 1.28 +++ mandoc/Attic/index.sgml 2011/01/04 23:32:39 1.102 @@ -1,205 +1,397 @@ - - - - - - mdocml.bsd.lv - - - - - - - - - - + + + + + + + + +
-
- mdocml – mdoc macro compiler -
-
-

- DESCRIPTION -

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

-
-

- DOWNLOADS -

+

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

-

- 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@. A full ChangeLog is written with each release. -

+

+ Disambiguation: mdocml is often referred to by its installed binary, + mandoc. +

+
+

+ SOURCES +

-

+

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

+ +

Current -

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

+

Downstream -

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

+

Historical -

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

- DOCUMENTATION -

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

+ DOCUMENTATION +

-

- These manuals are generated automatically (with mandoc(1)) and refer to the - current snapshot. -

+

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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
mandoc(1)format and display UNIX manuals
mandoc_char(7)mandoc special characters
mdoc(7)mdoc language reference
man(7)man language reference
manuals(7)a guide to writing UNIX manuals
mdoc(3)mdoc macro compiler library
man(3)man macro compiler library
-
-

- CONTACT -

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

- For all issues related to mdocml, contact Kristaps Džonsons, kris...@kth.se. -

+

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

+
+

+ CONTACT +

-

- If you want to receive a semi-automated mail-out of new releases, then please write with a message - subject of subscribe mdocml (or unsubscribe mdocml). -

-
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/09/21 13:06:13 $ -
-
- - +

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

+ + + + + + + + + + + + + + + + + + +
+ disc...@mdocml.bsd.lv + + bug-reports, general questions, and announcements + (archive) +
+ tec...@mdocml.bsd.lv + + patches and system discussions + (archive) +
+ sou...@mdocml.bsd.lv + + source commit messages + (archive) +
+
+

+ NEWS +

+
+

+ 03-01-2011: + version 1.10.9 +

+

+ tbl functionality (see the TS, TE, and + T& macros in the roff manual) has been + merged from tbl.bsd.lv. Many back-end + fixes have also been implemented, primarily in argument handling (quoting) and man documents. +

+
+
+

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

+
+

+ See cvsweb for + historical notes. +

+
+
+ Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2011/01/04 23:32:39 $ +
+
+ +