=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.154.2.14 retrieving revision 1.162 diff -u -p -r1.154.2.14 -r1.162 --- mandoc/Attic/index.sgml 2013/12/26 14:30:10 1.154.2.14 +++ mandoc/Attic/index.sgml 2013/10/10 05:20:30 1.162 @@ -7,7 +7,6 @@

- Puffy mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

@@ -21,33 +20,25 @@

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. - It is small, ISO C, ISC-licensed, and quite fast. + 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 tool set features mandoc, - based on the libmandoc validating compiler, - 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 (via catman) for semantic search of manual content. + Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. 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 has predominantly been developed on OpenBSD - and is both an OpenBSD - and a BSD.lv project. - We strive to support all interested free operating systems, in particular - DragonFly, - NetBSD, - FreeBSD, - Minix 3, - and GNU/Linux, - as well as all systems running the pkgsrc portable package build system. - All of these projects have helped to make mdocml better, by providing feedback and advice, - bug reports, and patches. + 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, + apropos (includes whatis mode) for indexed manual search, and + man.cgi for indexed manual search online. + It is a BSD.lv project.

Disambiguation: mdocml is often referred to by its installed binary, mandoc. @@ -56,12 +47,11 @@ Sources

- mdocml should build and run on any modern system with - libdb - (this is installed by default on BSD UNIX systems — see the Makefile if you're running Linux). - To build and install into /usr/local/, just run make install. - Be careful: the preconv, apropos, and whatis installed binary names - may be taken by existing utilities. + mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos (links to whatis), + man.cgi, and mandocdb. + To build and install into /usr/local/, just run make install. + Be careful: the preconv, apropos, and whatis binary names are usually taken by existing utilities.

Downstream @@ -69,7 +59,8 @@

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 - official, so please contact us if you plan on maintaining a downstream version! + official. + Please contact us if you plan on maintaining a downstream version!

@@ -78,7 +69,7 @@ @@ -93,7 +84,7 @@ @@ -105,7 +96,7 @@ @@ -165,12 +156,6 @@ - - - - - - - -
DragonFly BSD - contrib/mdocml (post-1.12.2 sources) + contrib/mdocml (1.12.2 sources) lib/libmandoc usr.bin/mandoc (build system)
FreeBSD 9.x, 8.x - ports/textproc/mdocml (1.12.2 port) + ports/textproc/mdocml (1.12.1 port)
OpenBSD - src/usr.bin/mandoc (post-1.12.2 sources under active development and build system) + src/usr.bin/mandoc (1.12.2 sources and build system)
whatis(1) - search the manual page database -
mandoc(3) mandoc macro compiler library @@ -225,12 +210,6 @@
catman(8) - update a man.cgi manpage cache -
mandocdb(8) index UNIX manuals @@ -304,6 +283,14 @@ News

+ xx-xx-2013: version 1.13.0 +

+

+ The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database. +

+

05-10-2013: version 1.12.2

@@ -346,6 +333,9 @@ For mandoc developers, we now provide a tbl(3) library manual and gmdiff, a very small, very simplistic groff-versus-mandoc output comparison tool.

+

+ See NEWS for historical notes. +

23-03-2012: version 1.12.1

@@ -370,42 +360,12 @@

Lastly, I'm no longer providing binaries, as nobody has asked for them.

-

- History -

-
    -
  • - Release notes going back to release 1.9.15, February 18, 2010. - Briefly explaining the most important changes in each release in relatively easy terms. - Very many changes are not mentioned here. -
    • -
  • - Development history going back to the beginning of the project, November 22, 2008. - One-line entries for important commits, releases, merges, hackathons and talks. - Makes it easy to find out who did what, and when, and when it became available where. - However, this is still incomplete, mentioning only a small fraction of all commits, - and to keep the size down, the individual entries are extremely terse and technical. - Feel free to look up more details and longer explanations about individual entries - in the ChangeLog or in CVS. -
    • -
  • - CVS ChangeLog going back to the beginning of the project. - Very technical information of varying quality, strictly chronological. - All commits are mentioned, but some messages neglect to mention some changes. - Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - - more than 25,000 lines, more than 700 kB. -
    • -
  • - CVS web interface, going back to the beginning of the project. - Source code, diffs and commit messages for each source file. The real thing. -
    • -

Copyright © 2008–2011 Kristaps Dzonsons, © 2013 Ingo Schwarze, - $Date: 2013/12/26 14:30:10 $ + $Date: 2013/10/10 05:20:30 $