|
-
- mdocml – mdoc macro compiler
-
- |
- |||||||||||||||||||||
- - DESCRIPTION -+ + + + ++ mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@) + ++ Sources: current, + cvsweb + (archives) + | + Binaries: windows 32-bit, windows 64-bit, mac os x + (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, 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 plain-old ANSI C and should build and run on any modern system; however, you'll
+ need libdb to build apropos and mandocdb (this is installed by default on BSD UNIX
+ systems — see the Makefile if you're running Linux). To build and install into /usr/local/, just
+ run + Binaries +++ Binary archives consist of pre-compiled binaries, manuals, and other necessary files. + Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures. + Windows binaries are compiled with MingW for the 32-bit (i686) and + 64-bit (x86_64) architectures. + ++ 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 “-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 -- -
- # pkg_delete mdocml - NetBSD pkgsrc -- -
- # pkg_delete mdocml - FreeBSD 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”). - - -- We don'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 18:48:21 $
-
- |
-
| 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) + | +
| 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. +
+| + 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) + | +
+ 08-10-2011: version 1.12.0 +
++ This version features a new, work-in-progress mandoc output mode: -Tman. This mode + allows a system maintainer to distribute man media for older systems that may not natively + support mdoc, such as old Solaris systems. + The -Ofragment option was added to mandoc's -Thtml and -Txhtml modes. +
++ While adding features, an apropos utility has been merged from the mandoc-tools sandbox. + This interfaces with mandocdb for semantic search of manual content. apropos is different from the traditional apropos primarily in allowing keyword search + (such as for functions, utilities, etc.) and regular expressions. +
++ In documentation news, the mdoc and man manuals have been made + considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE + SYNTAX to the roff manual, and by moving the very technical MACRO SYNTAX sections + down to the bottom of the page. +
++ Furthermore, for tbl, the -Tascii mode horizontal spacing of tables was rewritten + completely. It is now compatible with groff, both + with and without frames and rulers. Nesting of indented blocks is now supported in man, and + several bugs were fixed regarding indentation and alignment. The page headers in mdoc are now + nicer for very long titles. +
++ 02-09-2011: version 1.11.7 +
+
+ Added demandoc utility for stripping away macros and escapes. This replaces the
+ historical deroff utility. Also improved the mdoc and man manuals.
+
+ 16-08-2011: version 1.11.6 +
++ Handling of tr macro in roff implemented. This makes Perl documentation much more + readable. Hyphenation is also now enabled in man format documents. Many other general + improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at mdocml-win64.zip and a Mac OS X universal binary is available at mdocml-macosx.zip. +
++ 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. +
++ This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip. +
++ See cvsweb for + historical notes. +
++ + Copyright © 2008–2011 + Kristaps Dzonsons, + $Date: 2011/10/08 12:21:57 $ + +
+ +