=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.133 retrieving revision 1.139 diff -u -p -r1.133 -r1.139 --- mandoc/Attic/index.sgml 2011/07/24 19:08:09 1.133 +++ mandoc/Attic/index.sgml 2011/09/02 13:04:05 1.139 @@ -7,8 +7,19 @@

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

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

Description

@@ -28,68 +39,42 @@ 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; + and mandocdb, for indexing manuals. 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. + 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.

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

- Distributed Win32 binaries are compiled using mingw32. They are - distributed in a ZIP archive consisting of binaries, manuals, and other installable media. -

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

- Current -

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

Source archive	- /snapshots/mdocml.tar.gz - (md5) -
Online source	- cvsweb -
Win32 binary archive	- /binaries/mdocml-win32.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,32 +109,12 @@

- Historical -

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

Source archive	- /snapshots/ -
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.

@@ -160,132 +125,122 @@ - + + + + +

mandoc(1)	format and display UNIX manuals - (text \| xhtml \| pdf \| - postscript) - + ps)
mandocdb(8)	demandoc(1)	- index UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) - + emit only text of UNIX manuals + (text \| + xhtml \| + pdf \| + ps)
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)
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.

@@ -299,7 +254,7 @@ @@ -309,7 +264,7 @@ @@ -319,7 +274,7 @@ @@ -328,6 +283,23 @@ News

+ 02-09-2011: version 1.11.7 +

+ Added demandoc utility for stripping away macros and escapes. This replaces the + historical deroff utility. Also improved the mdoc and man manuals. +

+ 16-08-2011: version 1.11.6 +

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

24-07-2011: version 1.11.5

@@ -341,45 +313,7 @@ This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.

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

- 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 mandocdb~~makewhatis~~, - 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.

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

patches and system discussions - (archive) + (archive)

source commit messages - (archive) + (archive)