=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.134 retrieving revision 1.144 diff -u -p -r1.134 -r1.144 --- mandoc/Attic/index.sgml 2011/08/16 12:13:27 1.134 +++ mandoc/Attic/index.sgml 2011/10/06 23:06:31 1.144 @@ -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,72 +39,45 @@ 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, 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. + 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.

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

- + @@ -126,172 +110,152 @@

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

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

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

- + @@ -301,7 +265,7 @@ @@ -311,7 +275,7 @@ @@ -321,7 +285,7 @@ @@ -330,13 +294,47 @@ News

+ xx-xx-2011: version 1.xx.x +

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

+ While adding features, an apropos utility has been merged from the mandoc-tools sandbox. + This interfaces with mandocdb for semantic search of manual content. +

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

+ 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, and a 64-bit Windows binary is now available at /binaries/mdocml-win64.zip. + 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 @@ -352,16 +350,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! -

See cvsweb for historical notes.

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

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

source commit messages - (archive) + (archive)