=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.93 retrieving revision 1.156 diff -u -p -r1.93 -r1.156 --- mandoc/Attic/index.sgml 2010/08/19 20:49:34 1.93 +++ mandoc/Attic/index.sgml 2012/06/09 11:30:08 1.156 @@ -2,448 +2,342 @@
- -
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||
- - DESCRIPTION -++ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@) + ++ Sources: current, + cvsweb + (archives) + ++ 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 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). + ++ mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals (with + support for wide-character locales), XHTML, HTML, PostScript, and PDF. + It also includes preconv, for recoding multibyte manuals; + demandoc, for emitting only text parts of manuals; + mandocdb, for indexing manuals; and + apropos, whatis, and + man.cgi for semantic search of manual content. + It is a BSD.lv project. + +
+ Disambiguation: mdocml is often referred to by its installed binary, + Sources ++
+ mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos, whatis, man.cgi, and mandocdb.
+ To build and install into /usr/local/, just run + Downstream ++
+ Several systems come bundled with mdocml utilities.
+ If your system does not appear below, the maintainers have not contacted me and it should not be considered
+
+ Documentation +++ These manuals are generated automatically and refer to the current release. + They are the authoritative documentation for the mdocml system. + -
- mdocml is a suite of tools compiling - 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 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. - - -
- Disambiguation: mdocml is often referred to by its installed binary,
- |
- ||||||||||||||||
- - 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 -- -
- Downstream -- -
- Historical -- -
|
- ||||||||||||||||
- - DOCUMENTATION -- -- These manuals are generated automatically and refer to the current snapshot. - - -
- See |
- ||||||||||||||||
- - CONTACT -- -- 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). - - -
|
- ||||||||||||||||
- - NEWS --
-
- - 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
-
- - 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/08/19 20:49:34 $
-
- |
-
apropos(1) | ++ search the manual page database + (text | + xhtml | + pdf | + ps) + | +
demandoc(1) | ++ emit only text of UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
mandoc(1) | ++ format and display UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
preconv(1) | ++ recode multibyte UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
whatis(1) | ++ search the manual page database + (text | + xhtml | + pdf | + ps) + | +
mandoc(3) | ++ mandoc macro compiler library + (text | + xhtml | + pdf | + ps) + | +
man(7) | ++ man language reference + (text | + xhtml | + pdf | + ps) + | +
man.cgi(7) | ++ cgi for manpage query and display + (text | + xhtml | + pdf | + ps) + | +
eqn(7) | ++ eqn-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
mandoc_char(7) | ++ mandoc special characters + (text | + xhtml | + pdf | + ps) + | +
mdoc(7) | ++ mdoc language reference + (text | + xhtml | + pdf | + ps) + | +
roff(7) | ++ roff-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
tbl(7) | ++ tbl-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
mandocdb(8) | ++ index UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
+ Use the mailing lists for bug-reports, patches, questions, etc. Please check the + TODO for known issues + before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, + contact Kristaps at kris...@bsd.lv. Archives are available at Gmane. +
++ disc...@mdocml.bsd.lv + | ++ bug-reports, general questions, and announcements + | +
+ tec...@mdocml.bsd.lv + | ++ patches and system discussions + | +
+ sou...@mdocml.bsd.lv + | ++ source commit messages + | +
+ 23-03-2011: version 1.12.1 +
++ Significant work on apropos and mandocdb. These tools are + now much more robust. + A whatis implementation is now handled as an apropos mode. + These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility + such as GNU troff. +
+
+ The man.cgi script is also now available for wider testing. It interfaces with mandocdb manuals cached by catman. HTML output is generated
+ on-the-fly by libmandoc or internal methods to convert pre-formatted pages.
+
+ The mailing list archive for the discuss and tech lists are being hosted by Gmane at gmane.comp.tools.mdocml.user and gmane.comp.tools.mdocml.devel, respectively. +
++ Lastly, I'm no longer providing binaries, as nobody has asked for them. +
++ See cvsweb for + historical notes. +
++ + Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2012/06/09 11:30:08 $ + +