=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.126 retrieving revision 1.151 diff -u -p -r1.126 -r1.151 --- mandoc/Attic/index.sgml 2011/07/12 10:04:36 1.126 +++ 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,57 +39,46 @@ 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 makewhatis, 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 UNIX system, although makewhatis 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 makewhatis utility is not yet linked to the build. You must run make - makewhatis to build it (it does not install). + 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 +

- The most current version of mdocml is @VERSION@, dated @VDATE@. + 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.

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

@@ -111,19 +111,10 @@ CLASS="external">src/usr.bin/mandoc - -
-

- Historical -

- - - - - + @@ -132,7 +123,8 @@ 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.

Source archivepkgsrc - /snapshots/ + textproc/mdocml
@@ -140,136 +132,166 @@ + + + + + + + + - - - - + + + + + + + + + + + + + + + +
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)
makewhatis(1) - 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.

@@ -282,7 +304,6 @@ @@ -292,7 +313,6 @@ @@ -302,7 +322,6 @@ @@ -311,42 +330,53 @@ News

- 12-07-2011: version 1.11.4 + xx-xx-2011: version 1.12.1

- Bug-fixes and clean-ups across all systems, especially in makewhatis (note: still not - connected to the general build and must be compiled with make makewhatis) and the man parser. This release was significantly assisted by participants in OpenBSD's c2k11. Thanks! + 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. +

- 26-05-2011: version 1.11.3 + 08-10-2011: version 1.12.0

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

- 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. + 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-05-2011: version 1.11.2 +

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

- Corrected some installation issues in version 1.11.1. - Further migration to libmandoc. - Initial public release (this utility is very much under development) of makewhatis, - initially named mandoc-db. - This utility produces keyword databases of manual content - mandoc-cgi, - mandoc-tools, - which features semantic querying of manual content. + 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 @@ -356,7 +386,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/07/12 10:04:36 $ + $Date: 2011/12/14 23:17:12 $

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