=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.159 retrieving revision 1.164 diff -u -p -r1.159 -r1.164 --- mandoc/Attic/index.sgml 2013/10/02 06:45:43 1.159 +++ mandoc/Attic/index.sgml 2013/12/26 14:39:35 1.164 @@ -7,6 +7,7 @@

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

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

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. + UNIX manuals. + It is small, ISO C, ISC-licensed, and quite fast.

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

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

Disambiguation: mdocml is often referred to by its installed binary, mandoc. @@ -59,8 +68,7 @@

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

@@ -69,7 +77,7 @@ @@ -84,7 +92,7 @@ @@ -96,13 +104,13 @@ @@ -111,6 +119,12 @@ external/bsd/mdocml (1.10.9 sources and build system) + + + +

DragonFly BSD	- contrib/mdocml (1.12.1 sources) + contrib/mdocml (post-1.12.2 sources) lib/libmandoc usr.bin/mandoc (build system)
FreeBSD 9.x, 8.x	- ports/textproc/mdocml (1.12.1 port) + ports/textproc/mdocml (1.12.2 port)
OpenBSD	- src/usr.bin/mandoc (1.12.2 sources and build system) + src/usr.bin/mandoc (post-1.12.2 sources under active development and build system)
pkgsrc	- textproc/mdocml (1.12.0 port) + textproc/mdocml (1.12.2 port)
Alpine Linux	+ aports/main/mdocml (1.12.2 port) +

@@ -211,6 +225,25 @@ +

+ Supplementary Information +

+ Practical UNIX Manuals: mdoc tutorial by Kristaps Dzonsons +
+ OpenBSD porting guide + chapter regarding manual pages +
+ Publications and media coverage + concerning mdocml and mandoc +
+ History of UNIX Manpages: a comprehensive overview by Kristaps Dzonsons +

Contact

@@ -266,7 +299,7 @@ use sqlite3 as a database.

- 01-10-2013: version 1.12.2 + 05-10-2013: version 1.12.2

The mdoc(7) to man(7) converter, @@ -309,7 +342,7 @@ a very small, very simplistic groff-versus-mandoc output comparison tool.

- 23-03-2011: version 1.12.1 + 23-03-2012: version 1.12.1

Significant work on apropos and mandocdb. These tools are @@ -332,16 +365,42 @@

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

- See cvsweb for - historical notes. -

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