- mdocml – mdoc macro compiler + mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@) +
++ Sources: current, + cvsweb + (archives)
-mdocml is a suite of tools compiling mdoc, the roff macro package of choice for BSD manual pages, and man, the predominant historical package for @@ -21,66 +24,44 @@ HREF="http://www.gnu.org/software/groff/" CLASS="external">groff, the GNU troff implementation, for displaying mdoc 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 uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, ISC-licensed, fast and regular).
-mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals, XHTML, - HTML, PostScript, and PDF. It is a BSD.lv project. + HREF="mandoc.1.html">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, + 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
.
- 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). The most current version is @VERSION@,
- dated @VDATE@. If your system doesn't come with mdocml (see
- Downstream
), run make to compile and make install to install into /usr/local.
- Note that makewhatis is not yet linked to the build. You must run make
- makewhatis to build it (it does not install).
+ 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.
| 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!
+
| 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 |
| Source archive | +pkgsrc | - /snapshots/ + textproc/mdocml + | +
| Minix3 | ++ external/bsd/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.
| 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) | 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 |
- 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) |
- 19-05-2011: version 1.11.3 + xx-xx-2012: version 1.12.4
- 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. + Ingo, can you summarise your changes here?
- Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as mandoc input by using the newly-added preconv utility. -
- -- 12-05-2011: version 1.11.2 + The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database.
-- 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. -
- -- 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). -
-- 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 12:14:46 $ + $Date: 2012/06/09 14:19:55 $