|
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||||||||||||||||||||||||
- - DESCRIPTION -++ mdocml – mdoc macro compiler + -
- mdocml is a suite of tools compiling + DESCRIPTION +-- 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 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. + -- 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. - ++ 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 mdocml utility is a BSD.lv - Project member. - - |
- ||||||||||||||||||||||||||||||||||||||
- - SOURCES -++ 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. + -- 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. - +
+ Disambiguation: mdocml is often referred to by its installed binary, - Current -++ SOURCES +-
+ 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
+ Note that makewhatis is not yet linked to the build. You must run - Downstream -++ Current +-
- Historical -++ Downstream +-
|
- ||||||||||||||||||||||||||||||||||||||
- - DOCUMENTATION -+
- These manuals are generated automatically and refer to the current snapshot. - ++ Historical +-
|
- ||||||||||||||||||||||||||||||||||||||
- - CONTACT -+
- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. - ++ DOCUMENTATION +-- You may also subscribe to several mailing lists (these require subscription, which is moderated). An - archive is not yet available. - ++ These manuals are generated automatically and refer to the current snapshot. + -
|
- ||||||||||||||||||||||||||||||||||||||
- - NEWS -+
|
- ||||||||||||||||||||||||||||||||||||||
|
-
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/05/17 23:50:05 $
-
- |
-
+ 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. +
+ +| + disc...@mdocml.bsd.lv + | ++ bug-reports, general questions, and announcements + (archive) + | +
| + tec...@mdocml.bsd.lv + | ++ patches and system discussions + (archive) + | +
| + sou...@mdocml.bsd.lv + | ++ source commit messages + (archive) + | +
+ 12-05-2011: version 1.11.2 +
++ 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. +
+ ++ 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. +
+ ++ 07-01-2011: version 1.10.9 +
++ Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more. +
+
+ 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.
+
+ 24-12-2010: version 1.10.8 +
++ Significant improvements merged from OpenBSD downstream, including +
+
+ 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.
+
+ See cvsweb for + historical notes. +
+ ++ Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2011/05/13 00:42:26 $ +