=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.134 retrieving revision 1.151 diff -u -p -r1.134 -r1.151 --- mandoc/Attic/index.sgml 2011/08/16 12:13:27 1.134 +++ mandoc/Attic/index.sgml 2011/12/14 23:17:12 1.151 @@ -3,12 +3,23 @@ - mdocml | mdoc macro compiler + mdocml | UNIX manpage compiler

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

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

Description

@@ -28,72 +39,48 @@ 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.

Disambiguation: mdocml is often referred to by its installed binary, mandoc.

+

Sources -

- mdocml is in plain-old ANSI C and should build and run on any modern system (mandocdb requires Berkeley Database, installed by - default on all BSD UNIX operating systems). + 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 +

- To compile mdocml, run make, then make install to install into - /usr/local. 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: you must run make mandocdb to - build it (it does not install). + 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.

- The most current version of mdocml is @VERSION@, dated @VDATE@. -

- Current -

- - - - - - - - - - - - - - - - - - - - - -

Source archive	- /snapshots/mdocml.tar.gz - (md5) -
Online source	- cvsweb -
Win32 (i686) binary archive	- /binaries/mdocml-win32.zip -
Win64 (x86_64) binary archive	- /binaries/mdocml-win64.zip -

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

- + @@ -124,174 +111,190 @@ CLASS="external">src/usr.bin/mandoc - -

- Historical -

- - - - - + - - - -

Source archive	pkgsrc	- /snapshots/ + textproc/mdocml
Binary archive	- /binaries/ -

Documentation

- These manuals are generated automatically and refer to the current snapshot. + These manuals are generated automatically and refer to the current release. + They are the authoritative documentation for the mdocml system.

- + + + + + + + + + - - - - + + + + + + + + + + + + + + + +

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 \| - postscript) - + ps)
mandocdb(8)	- index UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) - -
preconv(1)	recode multibyte UNIX manuals - (text \| xhtml \| pdf \| - postscript) - + ps)
whatis(1)	+ search the manual page database + (text \| + xhtml \| + pdf \| + ps) +
mandoc(3)	mandoc macro compiler library - (text \| xhtml \| pdf \| - postscript) - + ps)
man(7)	man language reference - (text \| xhtml \| pdf \| - postscript) - + ps)
man.cgi(7)	+ cgi for manpage query and display + (text \| + xhtml \| + pdf \| + ps) +
eqn(7)	eqn-mandoc language reference - (text \| xhtml \| pdf \| - postscript) - + ps)
mandoc_char(7)	mandoc special characters - (text \| xhtml \| pdf \| - postscript) - + ps)
mdoc(7)	mdoc language reference - (text \| xhtml \| pdf \| - postscript) - + ps)
roff(7)	roff-mandoc language reference - (text \| xhtml \| pdf \| - postscript) - + ps)
tbl(7)	tbl-mandoc language reference - (text \| xhtml \| pdf \| - postscript) - + 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.

- + @@ -301,7 +304,6 @@ @@ -311,7 +313,6 @@ @@ -321,7 +322,6 @@ @@ -330,36 +330,53 @@ News

- 16-08-2011: version 1.11.6 + xx-xx-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, and a 64-bit Windows binary is now available at /binaries/mdocml-win64.zip. + 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.

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

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

- 12-07-2011: version 1.11.4 +

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

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

bug-reports, general questions, and announcements - (archive)

patches and system discussions - (archive)

source commit messages - (archive)