|
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||||||||||||||||||||||||||||||
- - DESCRIPTION -++ mdocml – mdoc macro compiler + ++ Description +++ 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 + UNIX manuals. The mission of mdocml is to deprecate 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 (with + support for wide-character locales), XHTML, HTML, PostScript, and PDF. + It also includes preconv, for recoding multibyte manuals; and makewhatis, for indexing manuals. + It is a BSD.lv project. + +
+ Disambiguation: mdocml is often referred to by its installed binary, + Sources ++
+ 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).
+ To compile mdocml, run + The most current version of mdocml is @VERSION@, dated @VDATE@. + -
- mdocml is a suite of tools compiling + Current +-- 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). - +
- The core of mdocml is composed of the libmdoc and libman - validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may - be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is - mandoc, which formats manuals for display on the terminal. - ++ Downstream +-- The mdocml utility is a BSD.lv - Project member. - - |
- ||||||||||||||||||||||||||||||||||||||||||||
- - SOURCES -+
- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating - systems, tested variously on i386, AMD64, alpha, and others. The most current version is @VERSION@, dated @VDATE@. A full ChangeLog (txt) is written with each release. - ++ Historical +-- Current -+
+ Documentation +-- Downstream -++ These manuals are generated automatically and refer to the current snapshot. + -
- Historical -++ Contact +-
|
- ||||||||||||||||||||||||||||||||||||||||||||
- - DOCUMENTATION -++ Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + TODO for known issues + before posting. Beyond that, contact Kristaps at kris...@bsd.lv. + -- These manuals are generated automatically and refer to the current snapshot. - +
|
- ||||||||||||||||||||||||||||||||||||||||||||
- - CONTACT -++ News +-- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. - ++ 26-05-2011: version 1.11.3 + ++ 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. + ++ Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into mandoc input by using the newly-added preconv utility. + Note: in the future, this feature may be integrated into mandoc. + -- If you want to receive a semi-automated mail-out of new releases, then please write with a message - subject of subscribe mdocml (or unsubscribe mdocml). - - |
- ||||||||||||||||||||||||||||||||||||||||||||
- - NEWS -++ 12-05-2011: version 1.11.2 + ++ 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. + -
|
- ||||||||||||||||||||||||||||||||||||||||||||
|
-
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/02/17 19:31:00 $
-
- |
-
+ 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 21:23:50 $ + +