=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.140 retrieving revision 1.151 diff -u -p -r1.140 -r1.151 --- mandoc/Attic/index.sgml 2011/09/02 14:00:09 1.140 +++ mandoc/Attic/index.sgml 2011/12/14 23:17:12 1.151 @@ -3,11 +3,11 @@ - 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, @@ -41,7 +41,9 @@ 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; - and mandocdb, for indexing 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.

@@ -51,11 +53,13 @@ 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 @@ -107,6 +111,12 @@ CLASS="external">src/usr.bin/mandoc + + pkgsrc + + textproc/mdocml + +

@@ -122,13 +132,13 @@ - mandoc(1) + apropos(1) - format and display UNIX manuals - (text | - xhtml | - pdf | - ps) + search the manual page database + (text | + xhtml | + pdf | + ps) @@ -142,6 +152,16 @@ + mandoc(1) + + format and display UNIX manuals + (text | + xhtml | + pdf | + ps) + + + preconv(1) recode multibyte UNIX manuals @@ -152,6 +172,16 @@ + whatis(1) + + search the manual page database + (text | + xhtml | + pdf | + ps) + + + mandoc(3) mandoc macro compiler library @@ -172,6 +202,16 @@ + man.cgi(7) + + cgi for manpage query and display + (text | + xhtml | + pdf | + ps) + + + eqn(7) eqn-mandoc language reference @@ -222,6 +262,16 @@ + catman(8) + + update a man.cgi manpage cache + (text | + xhtml | + pdf | + ps) + + + mandocdb(8) index UNIX manuals @@ -241,7 +291,7 @@ 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. + this e-mail address">kris...@bsd.lv. Archives are available at Gmane.

@@ -254,7 +304,6 @@ @@ -264,7 +313,6 @@ @@ -274,7 +322,6 @@ @@ -283,37 +330,55 @@ News

- 02-09-2011: version 1.11.7 + xx-xx-2011: version 1.12.1

- Added demandoc utility for stripping away macros and escapes. This replaces the - historical deroff utility. Also improved the mdoc and man manuals. + Significant work on apropos and mandocdb. These tools are + now much more robust and in line with other manpage systems. 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.

-

- 16-08-2011: version 1.11.6 +

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

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

- 24-07-2011: version 1.11.5 + 08-10-2011: version 1.12.0

- 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. + This version features a new, work-in-progress mandoc output mode: -Tman. This mode + allows a system maintainer to distribute man media for older systems that may not natively + support mdoc, such as old Solaris systems. + The -Ofragment option was added to mandoc's -Thtml and -Txhtml modes.

- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip. + While adding features, an apropos utility has been merged from the mandoc-tools sandbox. + This interfaces with mandocdb for semantic search of manual content. apropos is different from the traditional apropos primarily in allowing keyword search + (such as for functions, utilities, etc.) and regular expressions. + Note that the calling syntax for apropos is likely to change as it settles down.

+ In documentation news, the mdoc and man manuals have been made + considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE + SYNTAX to the roff manual, and by moving the very technical MACRO SYNTAX sections + down to the bottom of the page. +

+

+ Furthermore, for tbl, the -Tascii mode horizontal spacing of tables was rewritten + completely. It is now compatible with groff, both + with and without frames and rulers. Nesting of indented blocks is now supported in man, and + several bugs were fixed regarding indentation and alignment. The page headers in mdoc are now + nicer for very long titles. +

+

See cvsweb for historical notes.

@@ -321,7 +386,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/09/02 14:00:09 $ + $Date: 2011/12/14 23:17:12 $

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