=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.10 retrieving revision 1.126 diff -u -p -r1.10 -r1.126 --- mandoc/Attic/index.sgml 2009/02/28 10:13:45 1.10 +++ mandoc/Attic/index.sgml 2011/07/12 10:04:36 1.126 @@ -1,174 +1,363 @@ - -
- - - -
-
- 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 makewhatis, 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 makewhatis 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 for BSD manual pages. The mission of mdocml is to deprecate groff, the GNU roff implementation, for - displaying BSD mdoc pages. - - -- Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some 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 the libmdoc library, a validating scanner-parser producing - intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers - of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the mdoc(3) reference manual. - - -- There are three utilities implementing mdoc(3): - - -
- The mdocterm(1) utility is intended to deprecate usage of groff for displaying BSD manuals to the - terminal, either directly or cached as a “catman” page. - - -- Please submit patches! Although a significant implementation exists, work - remains for the backend library and especially the front-end utilities. See the contact information below to submit patches and bug reports. - - |
- ||||||||||||||
- - INSTALLING SOURCES -- -- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. - - -- The most current version is @VERSION@, dated - @VDATE@. - - -- Snapshot source -- -- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. - - -
- % cd /tmp - Snapshot port/pkgsrc -- -- The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at /ports-openbsd/ and /ports-netbsd/, - respectively. Please read the OpenBSD Ports FAQ or - NetBSD pkgsrc guide, first. - - -- OpenBSD port -- -
- # pkg_delete mdocml - NetBSD pkgsrc -- -
- # pkg_delete mdocml |
- ||||||||||||||
- - CONTACT -- -- Please contact Kristaps, kris...@kth.se, with questions, bug reports, patches, and so on. - - -- If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not - checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. - - |
- ||||||||||||||
-
- Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/28 10:13:45 $
-
- |
-
mandoc(1) | ++ format and display UNIX manuals + + (text | + xhtml | + pdf | + postscript) + + | +
makewhatis(1) | ++ 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) + | +
+ 12-07-2011: version 1.11.4 +
+
+ Bug-fixes and clean-ups across all systems, especially in makewhatis (note: still not
+ connected to the general build and must be compiled with make makewhatis
) and the man parser. This release was significantly assisted by participants in OpenBSD's c2k11. Thanks!
+
+ 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 makewhatis,
+ 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/12 10:04:36 $ + +
+ +