Description
@@ -39,35 +33,31 @@
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; and
+ apropos, whatis, and
+ man.cgi for semantic search of manual content.
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 modern system.
- To build and install into /usr/local/, just run make install.
- 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; please contact
- us if you plan to use it.
+ 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,
+ 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.
- 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.
-
-
+
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
@@ -81,31 +71,39 @@
- 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.
@@ -243,7 +281,6 @@
bug-reports, general questions, and announcements
- (archive)
- 16-08-2011: version 1.11.6
+ 23-03-2011: version 1.12.1
- Handling of tr macro in roff implemented. This makes Perl documentation much more
- readable. Hyphenation is also now enabled in man format documents. Many other general
- improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at mdocml-win64.zip and a Mac OS X universal binary is available at mdocml-macosx.zip.
+ 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.
-
- 24-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 User's Guide.
+ 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.
- Bug-fixes and clean-ups across all systems, especially in mandocdbmakewhatis (note: still not
- connected to the general build and must be compiled with make mandocdbmake makewhatis) and the man parser. This release was significantly assisted by participants in OpenBSD's c2k11. Thanks!
+ Lastly, I'm no longer providing binaries, as nobody has asked for them.