|
-
- mdocml – mdoc macro compiler
-
- |
- |||||||||||||||||||||
- - DESCRIPTION -+ + + + ++ mdocml – mdoc macro compiler + -- 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 roff implementation, for - displaying -mdoc pages whilst providing token support for -man. - ++ 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 are 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. - - |
- |||||||||||||||||||||
- - INSTALLING SOURCES -++ 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). + -- Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested - variously on i386, AMD64, alpha and others. The most current version is @VERSION@, dated @VDATE@. - ++ 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. + -- Snapshot source -+
+ Disambiguation: mdocml is often referred to by its installed binary, - CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots) - may be found in the /snapshots/ directory. A full ChangeLog is written with each new snapshot. - ++ Sources +-
- % cd /tmp
+ 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
+ - Snapshot port/pkgsrc -++ Current +-- The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at /ports-openbsd/, /ports-netbsd/ and /ports-freebsd/, respectively. Please read the OpenBSD Ports FAQ, the NetBSD pkgsrc guide or the FreeBSD ports - guide, first. - +
- OpenBSD port -++ Downstream +-
- # pkg_delete mdocml
- NetBSD pkgsrc -++ Historical +-
- # pkg_delete mdocml
- FreeBSD port -++ Documentation +-
- # pkg_delete -x mdocml |
- |||||||||||||||||||||
- - DOCUMENTATION -++ These manuals are generated automatically and refer to the current snapshot. + -
|
- |||||||||||||||||||||
- - CONTACT -+
- For all issues related to mdocml, contact Kristaps, kris...@kth.se. - ++ Contact +-- If you want to receive a semi-automated mail-out of new versions, then please write with a message - subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”). - ++ 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. + -- We don't yet offer anonymous CVS access. If you must have read-only access to the CVS tree (for - down-stream maintenance and so on), then please contact Kristaps directly for a read-only CVS account. - We strongly suggest using snapshots, instead. - - |
- |||||||||||||||||||||
|
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/13 13:02:53 $
-
- |
-
| + 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. + 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. +
+ ++ 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/14 23:41:50 $ + +
+ +