- 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. + It is small, ISO C, ISC-licensed, and quite fast. +
++ The tool set features mandoc, + based on the libmandoc validating compiler, + 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 (via catman) for semantic search of manual content. +
++ mdocml has predominantly been developed on OpenBSD + and is both an OpenBSD + and a BSD.lv project. + We strive to support all interested free operating systems, in particular + DragonFly, + NetBSD, + FreeBSD, + Minix 3, + and GNU/Linux, + as well as all systems running the pkgsrc portable package build system. + All of these projects have helped to make mdocml better, by providing feedback and advice, + bug reports, and patches. +
+
+ Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
+
+ Sources +
+
+ mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos (links to whatis),
+ man.cgi, and mandocdb.
+ To build and install into /usr/local/, just run make install.
+ Be careful: the preconv, apropos, and whatis binary names are usually taken by existing utilities.
+
+ 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
+ official
, so please contact us if you plan on maintaining a downstream version!
+
| DragonFly BSD | ++ contrib/mdocml (post-1.12.2 sources) + lib/libmandoc + usr.bin/mandoc (build system) + | +
| FreeBSD 10.0, -CURRENT | ++ contrib/mdocml (1.12.1 sources) + usr.bin/mandoc (build system) + | +
| FreeBSD 9.x, 8.x | ++ ports/textproc/mdocml (1.12.2 port) + | +
| NetBSD | ++ src/external/bsd/mdocml (1.12.1 sources plus patches and build system) + | +
| OpenBSD | ++ src/usr.bin/mandoc (post-1.12.2 sources under active development and build system) + | +
| pkgsrc | ++ textproc/mdocml (1.12.2 port) + | +
| Minix3 | ++ external/bsd/mdocml (1.10.9 sources and build system) + | +
| Alpine Linux | ++ aports/main/mdocml (1.12.2 port) + | +
+ 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 “-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
- % ftp -V -o-
- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -
- % cd mdocml
- % make all
- # make install
-
- 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
- # cd /usr/ports/textproc/
- # rm -rf mdocml
- # ftp -V -o-
- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
-
- NetBSD pkgsrc -
- -- Note: a pkgsrc port is maintained in-tree at textproc/mdocml. Please use this - instead of the provided pkgsrc. -
- -
- # pkg_delete mdocml
- # cd /usr/pkgsrc/textproc/
- # rm -rf mdocml
- # ftp -V -o-
- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
-
- FreeBSD port -
- -- Note: a port is maintained in-tree at textproc/mdocml. Please use - this instead of the provided port. -
- -
- # pkg_delete -x mdocml
- # cd /tmp
- # ftp -V -o-
- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make
- # make install
-
- DOCUMENTATION -
- -| mandoc(1) | -- | format and display UNIX manuals | -
| mandoc_char(7) | -- | mandoc special characters | -
| mdoc(7) | -- | mdoc language reference | -
| man(7) | -- | man language reference | -
| manuals(7) | -- | a guide to writing UNIX manuals | -
| mdoc(3) | -- | mdoc macro compiler library | -
| man(3) | -- | man macro compiler library | -
- 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”). -
-