Description
@@ -39,10 +33,11 @@
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;
- demandoc, for emitting only text parts of manuals;
- mandocdb, for indexing manuals; and
- apropos, for semantic search of manual content.
+ 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.
- mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll
- need libdb to build apropos 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 and apropos binary names are usually taken by
- existing utilities.
+ 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.
- 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.
-
@@ -253,7 +204,7 @@
TODO for known issues
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.
+ this e-mail address">kris...@bsd.lv. Archives are available at Gmane.
@@ -266,7 +217,6 @@
bug-reports, general questions, and announcements
- (archive)
- 08-10-2011: version 1.12.0
+ xx-xx-2012: version 1.12.4
- This version features a new, work-in-progress mandoc output mode: -Tman. This mode
- allows a system maintainer to distribute man media for older systems that may not natively
- support mdoc, such as old Solaris systems.
- The -Ofragment option was added to mandoc's -Thtml and -Txhtml modes.
+ Ingo, can you summarise your changes here?
- While adding features, an apropos utility has been merged from the mandoc-tools sandbox.
- This interfaces with mandocdb for semantic search of manual content. apropos is different from the traditional apropos primarily in allowing keyword search
- (such as for functions, utilities, etc.) and regular expressions.
+ The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to
+ use sqlite3 as a database.
- In documentation news, the mdoc and man manuals have been made
- considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE
- SYNTAX to the roff manual, and by moving the very technical MACRO SYNTAX sections
- down to the bottom of the page.
-
-
- Furthermore, for tbl, the -Tascii mode horizontal spacing of tables was rewritten
- completely. It is now compatible with groff, both
- with and without frames and rulers. Nesting of indented blocks is now supported in man, and
- several bugs were fixed regarding indentation and alignment. The page headers in mdoc are now
- nicer for very long titles.
-
-
- 02-09-2011: version 1.11.7
-
-
- Added demandoc utility for stripping away macros and escapes. This replaces the
- historical deroff utility. Also improved the mdoc and man manuals.
-
-
- 16-08-2011: version 1.11.6
-
-
- 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.
-
-
- 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.
-
-
- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.
-