=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.10 retrieving revision 1.40 diff -u -p -r1.10 -r1.40 --- mandoc/Attic/index.sgml 2009/02/28 10:13:45 1.10 +++ mandoc/Attic/index.sgml 2010/02/17 19:31:00 1.40 @@ -1,174 +1,242 @@ - - - - - - mdocml.bsd.lv - - - - - - - - - - + + + + + +
-
- mdocml – mdoc macro compiler -
-
-

+ + + + + + mdocml.bsd.lv + + + + + + + + + + + + + - - - + + + + + + + + + - - - - - - - - -
+
+ mdocml – mdoc macro compiler +
+
+

DESCRIPTION -

+ -

- 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. -

+

+ 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 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. -

+

+ 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. +

-

- There are three utilities implementing mdoc(3): -

+

+ The mdocml utility is a BSD.lv + Project member. +

+
+

+ SOURCES +

-
    -
  • mdocterm(1) – formats mdoc input for display on the terminal -
  • mdochtml(1) – formats mdoc input as HTML/CSS (nascent) -
  • mdoclint(1) – validates mdoc input -
  • mdoctree(1) – prints input abstract syntax tree -
+

+ Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating + systems, tested variously on i386, AMD64, alpha, and others. The most current version is @VERSION@, dated @VDATE@. A full ChangeLog (txt) is written with each release. +

-

- 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. -

+

+ Current +

-

- 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 -

+ + + + + + + + + + + + + +
Source archive + /snapshots/mdocml.tar.gz + (md5) +
Online source + cvsweb +
-

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

+

+ Downstream +

-

- The most current version is @VERSION@, dated - @VDATE@. -

+ + + + + + + + + + + + + + + + + + + + + +
DragonFly BSD + usr.bin/mandoc +
FreeBSD + ports/textproc/mdocml +
NetBSD + src/external/bsd/mdocml +
OpenBSD + src/usr.bin/mandoc +
-

- Snapshot source -

+

+ Historical +

-

- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. -

+ + + + + + + + + +
Source archive + /snapshots/ +
+
+

+ DOCUMENTATION +

-

- % cd /tmp
- % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -
- % cd mdocml
- % make all
- % make regress
- # make install -

+

+ These manuals are generated automatically and refer to the current snapshot. +

-

- Snapshot port/pkgsrc -

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
mandoc(1) (text)format and display UNIX manuals
mandoc_char(7) (text)mandoc special characters
mdoc(7) (text)mdoc language reference
man(7) (text)man language reference
manuals(7) (text)a guide to writing UNIX manuals
mdoc(3) (text)mdoc macro compiler library
man(3) (text)man macro compiler library
+
+

+ CONTACT +

-

- 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. -

+

+ For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. +

-

- OpenBSD port -

+

+ If you want to receive a semi-automated mail-out of new releases, then please write with a message + subject of subscribe mdocml (or unsubscribe mdocml). +

+
+

+ NEWS +

-

- # pkg_delete mdocml
- # cd /usr/ports/devel/
- # 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 -

- -

- # pkg_delete mdocml
- # cd /usr/pkgsrc/devel/
- # rm -rf mdocml
- # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install -

-
-

- 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 $ -
-
- - + + + + + + + + +
15-02-2010 + Moved to our new BSD.lv home. + Version 1.9.15. +
+

+
+ Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/02/17 19:31:00 $ +
+
+ +