=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.129 retrieving revision 1.157 diff -u -p -r1.129 -r1.157 --- mandoc/Attic/index.sgml 2011/07/23 09:47:25 1.129 +++ mandoc/Attic/index.sgml 2012/06/09 14:11:15 1.157 @@ -3,12 +3,17 @@ - mdocml | mdoc macro compiler + mdocml | UNIX manpage compiler

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

+

+ Sources: current, + cvsweb + (archives) +

Description

@@ -28,57 +33,35 @@ 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 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 UNIX system, although mandocdb requires Berkeley Database (this is - installed by default on all BSD operating systems). - 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). + mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos, 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.

-

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

- Current -

- - - - - - - - - - - - - -
Source archive - /snapshots/mdocml.tar.gz - (md5) -
Online source - cvsweb -
-

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

@@ -86,53 +69,47 @@ - -
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
-

- Historical -

- - - - - + + + + +
Source archivepkgsrc - /snapshots/ + textproc/mdocml
Minix3 + external/bsd/mdocml +

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.

@@ -140,136 +117,146 @@ + + + + + + + + - - - - + + + + + + + +
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)
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)
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.

@@ -282,7 +269,6 @@ @@ -292,7 +278,6 @@ @@ -302,7 +287,6 @@ @@ -311,52 +295,18 @@ News

- xx-07-2011: version 1.11.5 + xx-xx-2012: version 1.12.4

- Significant eqn improvements. mdocml can now parse arbitrary equations - (although few GNU troff 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. + Ingo, can you summarise your changes here?

-

- 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! + The mandocdb tools (mandocdb, + apropos (absorbing whatis), and + man.cgi have been re-written to use + sqlite3 as a database.

-

- 26-05-2011: version 1.11.3 -

- Introduce locale-encoding of output with the -Tlocale output option and Unicode escaped-character input. - See mandoc and mandoc_char, respectively, for details. - This allows for non-ASCII characters (e.g., \[u5000]) to be rendered in the locale's encoding, if said - environment supports wide-character encoding (if it does not, -Tascii is used instead). - Locale support can be turned off at compile time by removing -DUSE_WCHAR in the Makefile, in which case - -Tlocale is always a synonym for -Tascii. -

-

- Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into mandoc input by using the newly-added preconv utility. - Note: in the future, this feature may be integrated into mandoc. -

-

- 12-05-2011: version 1.11.2 -

-

- Corrected some installation issues in version 1.11.1. - Further migration to libmandoc. - Initial public release (this utility is very much under development) of mandocdbmakewhatis, - initially named mandoc-db. - This utility produces keyword databases of manual content - mandoc-cgi, - mandoc-tools, - which features semantic querying of manual content. -

-

See cvsweb for historical notes.

@@ -364,7 +314,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/07/23 09:47:25 $ + $Date: 2012/06/09 14:11:15 $

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