=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.2 retrieving revision 1.10 diff -u -p -r1.2 -r1.10 --- mandoc/Attic/index.sgml 2009/02/23 15:38:20 1.2 +++ mandoc/Attic/index.sgml 2009/02/28 10:13:45 1.10 @@ -24,14 +24,19 @@

- mdocml is a suite of tools that compile “mdoc”, the roff macro - package of the BSD manual pages. The mission of mdocml is to deprecate 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. groff amounts to over 60 000 lines of GPL C++ source, which is a - considerable encumbrance to BSD operating system. + 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

  • mdocterm(1) – formats mdoc input for display on the terminal -
  • mdochtml(1) – formats mdoc input as strict HTML (nascent) +
  • mdochtml(1) – formats mdoc input as HTML/CSS (nascent)
  • mdoclint(1) – validates mdoc input
  • mdoctree(1) – prints input abstract syntax tree @@ -73,50 +78,66 @@ i386, AMD64 and Alpha.

    +

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

    +

    - nightly source + Snapshot source

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

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

    - nightly port + Snapshot port/pkgsrc

    - The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not - yet available). These may be found in the /ports-openbsd/ directory. + 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.

    -

    - If installing for the first time: -

    +

    + OpenBSD port +

    - % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -
    - % cd mdocml
    - % sudo make
    - % sudo make install + # 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

    -

    - Subsequent installations: -

    +

    + NetBSD pkgsrc +

    - % sudo pkg_add -r mdocml + # 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

    @@ -143,7 +164,7 @@
    - Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/23 15:38:20 $ + Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/28 10:13:45 $