|
-
- mdocml – mdoc macro compiler
-
- |
- ||||||||||||||||||||
- - DESCRIPTION -++ mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@) + ++ Sources: current, + cvsweb + (archives) + ++ 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; + demandoc, for emitting only text parts of manuals; + mandocdb, for indexing manuals; and + apropos, whatis, and + man.cgi for semantic search of manual content. + It is a BSD.lv project. + +
+ Disambiguation: mdocml is often referred to by its installed binary, + Sources ++
+ mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos, whatis, man.cgi, and mandocdb.
+ To build and install into /usr/local/, just run + Downstream ++
+ 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
+
+ Documentation +++ These manuals are generated automatically and refer to the current release. + They are the authoritative documentation for the mdocml system. + -
- mdocml is a suite of tools compiling - 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. - - -- 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. - - -- Current -- -
- Downstream -- -
- Historical -- -
|
- ||||||||||||||||||||
- - DOCUMENTATION -- -- These manuals are generated automatically and refer to the current snapshot. - - -
|
- ||||||||||||||||||||
- - CONTACT -- -- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. - - -- You may also subscribe to several mailing lists (these require subscription, which is moderated). An - archive is not yet available. - - -
|
- ||||||||||||||||||||
- - NEWS -- -
|
- ||||||||||||||||||||
|
-
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/05/17 23:50:05 $
-
- |
-
| 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 | + ps) + | +
| preconv(1) | ++ recode multibyte UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
| mandoc(3) | ++ mandoc macro compiler library + (text | + xhtml | + pdf | + ps) + | +
| man(7) | ++ man language reference + (text | + xhtml | + pdf | + ps) + | +
| man.cgi(7) | ++ cgi for manpage query and display + (text | + xhtml | + pdf | + ps) + | +
| eqn(7) | ++ eqn-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
| mandoc_char(7) | ++ mandoc special characters + (text | + xhtml | + pdf | + ps) + | +
| mdoc(7) | ++ mdoc language reference + (text | + xhtml | + pdf | + ps) + | +
| roff(7) | ++ roff-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
| tbl(7) | ++ tbl-mandoc language reference + (text | + xhtml | + pdf | + ps) + | +
| mandocdb(8) | ++ index UNIX manuals + (text | + xhtml | + pdf | + ps) + | +
+ Use the mailing lists for bug-reports, patches, questions, etc. Please check the + TODO for known issues + 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. +
+| + disc...@mdocml.bsd.lv + | ++ bug-reports, general questions, and announcements + | +
| + tec...@mdocml.bsd.lv + | ++ patches and system discussions + | +
| + sou...@mdocml.bsd.lv + | ++ source commit messages + | +
+ xx-xx-2012: version 1.12.4 +
++ Ingo, can you summarise your changes here? +
++ The mandocdb tools (mandocdb, + apropos (absorbing whatis), and + man.cgi have been re-written to use + sqlite3 as a database. +
++ See cvsweb for + historical notes. +
++ + Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2012/06/09 14:11:15 $ + +