X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/88fc6b869e3c723d6787f44989cf6139432fed70..df4b4fe716941b7152aa9d779f5c2e71c3acfaf7:/index.sgml diff --git a/index.sgml b/index.sgml index 19dbf64a..096ef474 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 @@ -20,7 +25,7 @@ pages whilst providing token support for man.

- Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs slowly, produces + Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. It runs slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, ISC-licensed, fast and regular).
@@ -28,102 +33,88 @@ 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, + 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 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). -

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

- + - + - -

Source archive	DragonFly BSD	- /snapshots/mdocml.tar.gz - (md5) + contrib/mdocml (1.12.2 sources) + lib/libmandoc + usr.bin/mandoc (build system)
Online source	FreeBSD 10.0, -CURRENT	- cvsweb + contrib/mdocml (1.12.1 sources) + usr.bin/mandoc (build system)

- Downstream -

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

DragonFly BSD	FreeBSD 9.x, 8.x	- usr.bin/mandoc + ports/textproc/mdocml (1.12.1 port)
FreeBSD	NetBSD	- ports/textproc/mdocml + src/external/bsd/mdocml (1.12.1 sources plus patches and build system)
NetBSD	OpenBSD	- src/external/bsd/mdocml + src/usr.bin/mandoc (1.12.2 sources and build system)
OpenBSD	pkgsrc	- src/usr.bin/mandoc + textproc/mdocml (1.12.2 port) +
Minix3	+ external/bsd/mdocml (1.10.9 sources and build system)

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

Alpine Linux

- /snapshots/ + aports/main/mdocml (1.12.2 port)

@@ -140,136 +132,119 @@ - + - + + + + + - + + + + + + + + + + + + +

mandoc(1)	apropos(1)	- format and display UNIX manuals - - (text \| - xhtml \| - pdf \| - postscript) - + search the manual page database
makewhatis(1)	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)	tbl(3)	- man language reference - - (text \| - xhtml \| - pdf \| - postscript) - + roff table parser library for mandoc
eqn(7)	eqn-mandoc language reference - - (text \| - xhtml \| - pdf \| - postscript) - +
man(7)	+ man language reference +
man.cgi(7)	+ cgi for manpage query and display
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

+ Supplementary Information +

+ Practical UNIX Manuals: mdoc tutorial by Kristaps Dzonsons +
+ OpenBSD porting guide + chapter regarding manual pages +
+ Publications and media coverage + concerning mdocml and mandoc +
+ History of UNIX Manpages: a comprehensive overview by Kristaps Dzonsons +

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 +257,6 @@ @@ -292,7 +266,6 @@ @@ -302,7 +275,6 @@ @@ -311,52 +283,116 @@ News

- 12-07-2011: version 1.11.4 + xx-xx-2013: version 1.13.0

- 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! + 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 + 05-10-2013: version 1.12.2 +

+ The mdoc(7) to man(7) converter, + to be called as mandoc -Tman, is now fully functional. +

+ The mandoc(1) utility now supports the -Ios (default operating system) + input option, and the -Tutf8 output mode now actually works. +

+ The mandocdb(8) utility no longer truncates existing databases when starting to build new ones, + but only replaces them when the build actually succeeds. +

+ The man(7) parser now supports the PD macro (paragraph distance), + and (for GNU man-ext compatibility only) EX (example block) and EE (example end). + Plus several bugfixes regarding indentation, line breaks, and vertical spacing, + and regarding RS following TP.

- 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. + The roff(7) parser now supports the \f(BI (bold+italic) font escape, + the \z (zero cursor advance) escape and the cc (change control character) + and it (input line trap) requests. + Plus bugfixes regarding the \t (tab) escape, nested escape sequences, and conditional requests.

- 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. + In mdoc(7), several bugs were fixed related to UTF-8 output of quoting enclosures, + delimiter handling, list indentation and horizontal and vertical spacing, + formatting of the Lk, %U, and %C macros, + plus some bugfixes related to the handling of syntax errors like badly nested font blocks, + stray Ta macros outside column lists, unterminated It Xo blocks, + and non-text children of Nm blocks. +

+ In tbl(7), the width of horizontal spans and the vertical spacing around tables was corrected, + and in man(7) files, a crash was fixed that was triggered by some particular unclosed T{ macros. +

+ For mandoc developers, we now provide a tbl(3) library manual and gmdiff, + a very small, very simplistic groff-versus-mandoc output comparison tool.

- 12-05-2011: version 1.11.2 + 23-03-2012: version 1.12.1 +

+ Significant work on apropos and mandocdb. These tools are + now much more robust. + 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.

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

- See cvsweb for - historical notes. + Lastly, I'm no longer providing binaries, as nobody has asked for them.

+ History +

+ Release notes going back to release 1.9.15, February 18, 2010. + Briefly explaining the most important changes in each release in relatively easy terms. + Very many changes are not mentioned here. +
+ Development history going back to the beginning of the project, November 22, 2008. + One-line entries for important commits, releases, merges, hackathons and talks. + Makes it easy to find out who did what, and when, and when it became available where. + However, this is still incomplete, mentioning only a small fraction of all commits, + and to keep the size down, the individual entries are extremely terse and technical. + Feel free to look up more details and longer explanations about individual entries + in the ChangeLog or in CVS. +
+ CVS ChangeLog going back to the beginning of the project. + Very technical information of varying quality, strictly chronological. + All commits are mentioned, but some messages neglect to mention some changes. + Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - + more than 25,000 lines, more than 700 kB. +
+ CVS web interface, going back to the beginning of the project. + Source code, diffs and commit messages for each source file. The real thing. +

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

patches and system discussions - (archive)

source commit messages - (archive)