X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/30f55adc136c204d3d558b367edbc380844a2929..46e3c278c370d1404debff5aa25ae184a3e13a14:/index.sgml diff --git a/index.sgml b/index.sgml index fd1a9065..23269e80 100644 --- a/index.sgml +++ b/index.sgml @@ -3,11 +3,16 @@ - 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, + apropos (includes whatis mode) for indexed manual search, and + man.cgi for indexed manual search online. 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). -

- The most current version of mdocml is @VERSION@, dated @VDATE@. + mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos (links to 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.

- 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,44 +69,37 @@ - -

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 -

- - - - - + + + + + @@ -132,7 +108,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 archive	pkgsrc	- /snapshots/ + textproc/mdocml +
Minix3	+ external/bsd/mdocml

@@ -140,123 +117,81 @@ - + - + + + + + + + + + + + + + @@ -265,11 +200,11 @@ 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.

mandoc(1)	apropos(1)	- format and display UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) - + search the manual page database
mandocdb(8)	demandoc(1)	- index UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) - + emit only text of UNIX manuals +
mandoc(1)	+ format and display UNIX manuals
preconv(1)	recode multibyte UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) -
mandoc(3)	mandoc macro compiler library - - (text \| - xhtml \| - pdf \| - postscript) -
man(7)	man language reference - - (text \| - xhtml \| - pdf \| - postscript) - +
man.cgi(7)	+ cgi for manpage query and display
eqn(7)	eqn-mandoc language reference - - (text \| - xhtml \| - pdf \| - postscript) -
mandoc_char(7)	mandoc special characters - - (text \| - xhtml \| - pdf \| - postscript) -
mdoc(7)	mdoc language reference - - (text \| - xhtml \| - pdf \| - postscript) -
roff(7)	roff-mandoc language reference - - (text \| - xhtml \| - pdf \| - postscript) -
tbl(7)	tbl-mandoc language reference - - (text \| - xhtml \| - pdf \| - postscript) - +
mandocdb(8)	+ index UNIX manuals

@@ -282,7 +217,6 @@ @@ -292,7 +226,6 @@ @@ -302,7 +235,6 @@ @@ -311,52 +243,15 @@ News

- xx-07-2011: version 1.11.5 -

- 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 eqn User's Guide. -

- 12-07-2011: version 1.11.4 + xx-xx-2012: version 1.12.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 + Ingo, can you summarise your changes here?

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

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

patches and system discussions - (archive)

source commit messages - (archive)