- mdocml – mdoc macro compiler + mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
++ Sources: current, + cvsweb + (archives) +
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
- 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.
- 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.
-| Source archive | -- /snapshots/mdocml.tar.gz - (md5) - | -
| Online source | -- cvsweb - | -
+ 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 | +pkgsrc | - /snapshots/ + textproc/mdocml |
- 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) |
| 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) + | +
- 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.
-| bug-reports, general questions, and announcements - (archive) |
| patches and system discussions - (archive) |
| source commit messages - (archive) |
- 26-05-2011: version 1.11.3 + 23-03-2011: version 1.12.1
- 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. + 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.
- 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. + 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.
- -- 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 makewhatis, - initially named mandoc-db. - This utility produces keyword databases of manual content - mandoc-cgi, 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.
- -- 04-04-2011: version 1.11.1 -
- The earlier libroff, libmdoc, and libman soup have been merged into - a single library, libmandoc, which manages all aspects of - parsing real manuals (from line-handling to tbl parsing). + Lastly, I'm no longer providing binaries, as nobody has asked for them.
- Beyond this structural change, initial eqn functionality is in - place. For the time being, this is limited to the recognition of equation blocks; - future version of mdocml will expand upon this framework. -
-- As usual, many general fixes and improvements have also occurred. In particular, a great - deal of redundancy and superfluous code has been removed with the merging of the backend - libraries. -
- -See cvsweb for historical notes.
-Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/26 21:23:50 $ + $Date: 2012/03/24 01:54:43 $