|
-
- 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 mandocdb, 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 mandocdb 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@. + ++ Current ++
+ Downstream ++
+ Historical ++
+ Documentation +++ These manuals are generated automatically and refer to the current snapshot. + -- 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. - - -- 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. - - |
- |||||||||||||||||||||
- - INSTALLING SOURCES -- -- 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@. - - -- Snapshot source -- -- 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. - - -
- % cd /tmp - Snapshot port/pkgsrc -- -- 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 -- -- Note: the mdocml utility is part of OpenBSD's base system at usr.bin/mandoc. Please use this - instead of the provided port. - - -
- # pkg_delete mdocml - NetBSD pkgsrc -- -- Note: a pkgsrc port is maintained in-tree at textproc/mdocml. Please use this - instead of the provided pkgsrc. - - -
- # pkg_delete mdocml - FreeBSD port -- -- Note: a port is maintained in-tree at textproc/mdocml. Please use - this instead of the provided port. - - -
- # pkg_delete -x mdocml |
- |||||||||||||||||||||
- - DOCUMENTATION -- -
|
- |||||||||||||||||||||
- - CONTACT -- -- For all issues related to mdocml, contact Kristaps, kris...@kth.se. - - -- 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”). - - |
- |||||||||||||||||||||
|
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/17 19:12:03 $
-
- |
-
| mandoc(1) | ++ format and display UNIX manuals + + (text | + xhtml | + pdf | + postscript) + + | +
| mandocdb(8) | ++ index UNIX manuals + + (text | + xhtml | + pdf | + postscript) + + | +
| preconv(1) | ++ recode multibyte UNIX manuals + + (text | + xhtml | + pdf | + postscript) + + | +
| mandoc(3) | ++ mandoc macro compiler library + + (text | + xhtml | + pdf | + postscript) + + | +
| man(7) | ++ man language reference + + (text | + xhtml | + pdf | + postscript) + + | +
| eqn(7) | ++ eqn-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + + | +
| mandoc_char(7) | ++ mandoc special characters + + (text | + xhtml | + pdf | + postscript) + + | +
| mdoc(7) | ++ mdoc language reference + + (text | + xhtml | + pdf | + postscript) + + | +
| roff(7) | ++ roff-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + + | +
| tbl(7) | ++ tbl-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + + | +
+ 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) + | +
+ 24-07-2011: version 1.11.5 +
++ 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. +
++ 12-07-2011: version 1.11.4 +
+
+ 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
+ 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. +
++ 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 mandocdbmakewhatis,
+ initially named mandoc-db.
+ This utility produces keyword databases of manual content
+ mandoc-cgi,
+ mandoc-tools,
+ which features semantic querying of manual content.
+
+ See cvsweb for + historical notes. +
++ + Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2011/07/24 10:09:03 $ + +
+ +