=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.12 retrieving revision 1.13 diff -u -p -r1.12 -r1.13 --- mandoc/Attic/index.sgml 2009/03/23 21:46:04 1.12 +++ mandoc/Attic/index.sgml 2009/03/24 10:28:06 1.13 @@ -24,43 +24,33 @@

- mdocml is a suite of tools compiling “mdoc”, the roff macro + 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). + 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 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. + intermediate-form output from -mdoc input. libmdoc is a simple, fast library operating on memory + buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on). The primary + front-end is mandoc(1), which formats -mdoc manuals for display on the + terminal.

- There are three utilities implementing mdoc(3): + The mandoc(1) utility is intended to deprecate usage of groff for displaying mdoc manuals on the + terminal.

- -

- 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. @@ -74,8 +64,8 @@

- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. + Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested + variously on i386, AMD64, Alpha and others.

@@ -180,7 +170,7 @@

- Copyright © 2009 Kristaps Džonsons, $Date: 2009/03/23 21:46:04 $ + Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/03/24 10:28:06 $