=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.21 retrieving revision 1.113 diff -u -p -r1.21 -r1.113 --- mandoc/Attic/index.sgml 2009/06/17 19:12:03 1.21 +++ mandoc/Attic/index.sgml 2011/04/30 10:18:24 1.113 @@ -1,237 +1,367 @@ - -
- - - -
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||||||||||||||||
- - DESCRIPTION -+ + + + ++ mdocml – mdoc macro compiler + -- 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. - ++ DESCRIPTION +-- 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). - ++ 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. + -- 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. - - |
- ||||||||||||||||||||||||||||||
- - INSTALLING SOURCES -++ 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). + -- 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@. - ++ mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals, XHTML, + HTML, PostScript, and PDF. It is a BSD.lv project. + -- Snapshot source -+
+ Disambiguation: mdocml is often referred to by its installed binary, - CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots) - may be found in the /snapshots/ directory. A full ChangeLog is written with each new snapshot. - ++ SOURCES +-
- % cd /tmp + mdocml is in plain-old ANSI C and should build and run on any UNIX system. The most current + version is @VERSION@, dated @VDATE@. + -- Snapshot port/pkgsrc -++ Current +-- The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at /ports-openbsd/, /ports-netbsd/ and /ports-freebsd/, respectively. Please read the OpenBSD Ports FAQ, the NetBSD pkgsrc guide or the FreeBSD ports - guide, first. - +
- OpenBSD port -++ Downstream +-- Note: the mdocml utility is part of OpenBSD's base system at usr.bin/mandoc. Please use this - instead of the provided port. - +
- # pkg_delete mdocml + Historical +-- NetBSD pkgsrc -+
- Note: a pkgsrc port is maintained in-tree at textproc/mdocml. Please use this - instead of the provided pkgsrc. - ++ DOCUMENTATION +-
- # pkg_delete mdocml + These manuals are generated automatically and refer to the current snapshot. + -- FreeBSD port -+
- Note: a port is maintained in-tree at textproc/mdocml. Please use - this instead of the provided port. - ++ CONTACT +-
- # pkg_delete -x mdocml |
- ||||||||||||||||||||||||||||||
- - DOCUMENTATION -++ Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + TODO for known issues + before posting. Beyond that, contact Kristaps at kris...@bsd.lv. + -
|
- ||||||||||||||||||||||||||||||
- - CONTACT -+
- For all issues related to mdocml, contact Kristaps, kris...@kth.se. - ++ NEWS +-- If you want to receive a semi-automated mail-out of new versions, then please write with a message - subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”). - - |
- ||||||||||||||||||||||||||||||
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/17 19:12:03 $
-
- |
-
+ 04-04-2011: version 1.11.1 +
++ The earlier libroff, libmdoc, and libman soup have been merged into + a single library, libmandoc, which manages all aspects of + parsing real manuals (from line-handling to tbl parsing). +
++ Beyond this structural change, initial eqn functionality is in + place. For the time being, this is limited to the recognition of equation blocks; + future version of mdocml will expand upon this framework. +
++ As usual, many general fixes and improvements have also occurred. In particular, a great + deal of redundancy and superfluous code has been removed with the merging of the backend + libraries. +
+ ++ 07-01-2011: version 1.10.9 +
++ Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more. +
+
+ Initial tbl functionality (see the TS
, TE
, and
+ T&
macros in the roff manual) has been
+ merged from tbl.bsd.lv. Output is
+ still minimal, especially 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.
+
+ 24-12-2010: version 1.10.8 +
++ Significant improvements merged from OpenBSD downstream, including +
+
+ 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–2011 + Kristaps Dzonsons, + $Date: 2011/04/30 10:18:24 $ +
+ +