=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.137 retrieving revision 1.154 diff -u -p -r1.137 -r1.154 --- mandoc/Attic/index.sgml 2011/08/18 09:02:57 1.137 +++ mandoc/Attic/index.sgml 2012/03/25 00:48:47 1.154 @@ -3,22 +3,16 @@ - mdocml | mdoc macro compiler + mdocml | UNIX manpage compiler

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

Sources: current, cvsweb (archives) - | - Binaries: windows 32-bit, windows 64-bit, mac os x - (archives)

Description @@ -39,8 +33,11 @@ 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; and mandocdb, for indexing manuals. + 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. It is a BSD.lv project.

@@ -50,22 +47,15 @@ Sources

- mdocml is in plain-old ANSI C and should build and run on any modern system. - To build and install into /usr/local/, just run make install. - Be aware: if you have an existing groff installation, this may overwrite its preconv binary. - The mandocdb utility is not yet linked to the build; please contact - us if you plan to use it. + mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll + need libdb to build apropos, whatis, man.cgi, catman, and mandocdb (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 binary names are + usually taken by existing utilities.

- Binaries -

-

- Binary archives consist of pre-compiled binaries, manuals, and other necessary files. - Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures. - Windows binaries are compiled with MingW for the 32-bit (i686) and - 64-bit (x86_64) architectures. -

-

Downstream

@@ -81,31 +71,39 @@ DragonFly BSD - usr.bin/mandoc + usr.bin/mandoc FreeBSD - ports/textproc/mdocml + ports/textproc/mdocml NetBSD - src/external/bsd/mdocml + src/external/bsd/mdocml OpenBSD - src/usr.bin/mandoc + src/usr.bin/mandoc + + pkgsrc + + textproc/mdocml + + + + Minix3 + + external/bsd/mdocml + +

@@ -121,6 +119,26 @@ + 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 @@ -131,16 +149,6 @@ - mandocdb(8) - - index UNIX manuals - (text | - xhtml | - pdf | - ps) - - - preconv(1) recode multibyte UNIX manuals @@ -151,6 +159,16 @@ + whatis(1) + + search the manual page database + (text | + xhtml | + pdf | + ps) + + + mandoc(3) mandoc macro compiler library @@ -171,6 +189,16 @@ + man.cgi(7) + + cgi for manpage query and display + (text | + xhtml | + pdf | + ps) + + + eqn(7) eqn-mandoc language reference @@ -220,17 +248,37 @@ ps) + + catman(8) + + update a man.cgi manpage cache + (text | + xhtml | + pdf | + ps) + + + + mandocdb(8) + + index UNIX manuals + (text | + xhtml | + pdf | + ps) + +

Contact

- Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + Use the mailing lists for bug-reports, patches, questions, etc. Please check the TODO for known issues - before posting. Beyond that, contact Kristaps at kris...@bsd.lv. + 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.

@@ -243,7 +291,6 @@ @@ -253,7 +300,6 @@ @@ -263,7 +309,6 @@ @@ -272,37 +317,28 @@ News

- 16-08-2011: version 1.11.6 + 23-03-2011: version 1.12.1

- Handling of tr macro in roff implemented. This makes Perl documentation much more - readable. Hyphenation is also now enabled in man format documents. Many other general - improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at mdocml-win64.zip and a Mac OS X universal binary is available at mdocml-macosx.zip. + 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.

-

- 24-07-2011: version 1.11.5 -

- Significant eqn improvements. mdocml can now parse arbitrary eqn input - (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the eqn - manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies - the language specified in the Second - Edition User's Guide. + 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.

- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip. + 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.

-

- 12-07-2011: version 1.11.4 -

- Bug-fixes and clean-ups across all systems, especially in mandocdb makewhatis (note: still not - connected to the general build and must be compiled with make mandocdb make makewhatis) and the man parser. This release was significantly assisted by participants in OpenBSD's c2k11. Thanks! + Lastly, I'm no longer providing binaries, as nobody has asked for them.

See cvsweb for @@ -312,7 +348,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/08/18 09:02:57 $ + $Date: 2012/03/25 00:48:47 $

bug-reports, general questions, and announcements - (archive)
patches and system discussions - (archive)
source commit messages - (archive)