- mdocml – mdoc macro compiler + mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
- ++ Sources: current, + cvsweb + (archives) + | + Binaries: windows 32-bit, windows 64-bit, mac os x + (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 +30,55 @@ 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; and + apropos, whatis, and + man.cgi (via catman) 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 UNIX system. 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.
+ 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.
- Note that makewhatis is not yet linked to the build. You must run make
- makewhatis to build it.
+ 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) | +preconv(1) | - index UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + recode multibyte UNIX manuals + (text | + xhtml | + pdf | + 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) |
- 12-05-2011: version 1.11.2 + xx-xx-2011: version 1.12.1
- Corrected some installation issues in version 1.11.1. - 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. + Significant work on apropos and mandocdb. These tools are + now much more robust and in line with other manpage systems. 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.
- -- 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). + 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.
- 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. + Lastly, 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.
-- 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. -
-- 07-01-2011: version 1.10.9 + 08-10-2011: version 1.12.0
- Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more. + 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.
- Initial tbl functionality (see the TS
, TE
, and
- T&
macros in the roff manual) has been
- merged from tbl.bsd.lv. Output is
- still minimal, especially for -Thtml and -Txhtml, but manages to at least display data. This means that mandoc now has built-in support for two troff preprocessors via
- libroff: soelim and tbl.
+ 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.
+ Note that the calling syntax for apropos is likely to change as it settles down.
- 24-12-2010: version 1.10.8 -
- Significant improvements merged from OpenBSD downstream, including + 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.
-
- Also overhauled the -Thtml and -Txhtml output modes. They now display readable output in arbitrary
- browsers, including text-based ones like lynx. See HTML and XHTML manuals in the DOCUMENTATION section for examples. Attention: available style-sheet classes have been considerably
- changed! See the example.style.css file for details.
- Lastly, libmdoc and libman have been
- cleaned up and reduced in size and complexity.
+ 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.
See cvsweb for historical notes.
-- Copyright © 2008–2011 - Kristaps Dzonsons, - $Date: 2011/05/13 00:42:26 $ + + Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2011/12/14 23:17:12 $ +