- mdocml – mdoc macro compiler + mdocml – mdoc macro 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,50 @@ 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; and mandocdb, for indexing manuals. + 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 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.
| Source archive | -- /snapshots/mdocml.tar.gz - (md5) - | -
| Online source | -- cvsweb - | -
+ 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. +
+ 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 | -- /snapshots/ - | -
- 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) | format and display UNIX manuals - (text | xhtml | pdf | - postscript) - + ps) | |
| makewhatis(1) | +mandocdb(8) | index UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + (text | + xhtml | + pdf | + ps) |
| preconv(1) | recode multibyte UNIX manuals - (text | xhtml | pdf | - postscript) - + ps) | |
| mandoc(3) | mandoc macro compiler library - (text | xhtml | pdf | - postscript) - + ps) | |
| man(7) | man language reference - (text | xhtml | pdf | - postscript) - + 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) |
Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the TODO for known issues @@ -279,7 +232,6 @@ HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal this e-mail address">kris...@bsd.lv.
-| bug-reports, general questions, and announcements - (archive) + (archive) |
| patches and system discussions - (archive) + (archive) |
| source commit messages - (archive) + (archive) |
- 19-05-2011: version 1.11.3 + 16-08-2011: version 1.11.6
- 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. + 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.
-- 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 + 24-07-2011: version 1.11.5
- 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. + 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.
- -- 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). + This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.
-- 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. +
+ 12-07-2011: version 1.11.4
- 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.
+ Bug-fixes and clean-ups across all systems, especially in mandocdb makewhatis (note: still not
+ connected to the general build and must be compiled with make mandocdb make makewhatis
See cvsweb for historical notes.
-Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/26 12:14:46 $ + $Date: 2011/08/18 09:02:57 $