@@ -28,133 +28,155 @@
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(7) pages whilst providing token support for man(7).
+ displaying -mdoc pages whilst providing token support for -man.
- What are UNIX manuals? Read manuals(7) for an introduction.
-
-
-
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 are the man(3) and mdoc(3) libraries, validating compilers producing intermediate-form
- output from -man or -mdoc input. 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 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.
-
-
- The primary front-end is mandoc(1), which formats manuals for
- display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a
- limited extent, -man manuals on the terminal.
-
-
-
- Please submit patches, bug reports and suggestions! Although a significant
- implementation exists, work remains for the backend library and especially the front-end utilities. See
- the contact information below for submissions.
-
- INSTALLING SOURCES
+ SOURCES
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
- variously on i386, AMD64, alpha and others.
+ 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 most current version is @VERSION@, dated
- @VDATE@.
-
-
- Snapshot source
+ Current
-
- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. A full ChangeLog is
- written with each new snapshot.
-
+
-
- % cd /tmp
- % ftp -V -o-
- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -
- % cd mdocml
- % make all
- # make install
-
-
- Snapshot port/pkgsrc
+ Downstream
-
- 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
-
+
+ Historical
+
-
- # pkg_delete mdocml
- # cd /usr/ports/textproc/
- # rm -rf mdocml
- # ftp -V -o-
- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
-
+
+ |
+
+
@@ -164,24 +186,22 @@
- Please contact Kristaps, krismdocml, contact Kristaps Džonsons, kris...@kth.se, with questions, bug reports, patches, and so
- on.
+ title="Reveal this e-mail address">...@kth.se.
-
+
- 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.
+ 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).