@@ -24,10 +24,11 @@
- mdocml is a suite of tools compiling “-mdoc”, the roff macro
- package of choice for BSD manual pages. The mission of mdocml is to deprecate
- groff, the GNU roff implementation,
- for displaying -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.
@@ -37,115 +38,139 @@
- 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, 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. The mandoc(1) utility is intended to deprecate usage of groff for displaying mdoc 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.
+ 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.
- INSTALLING SOURCES
+ DOWNLOADS
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
- variously on i386, AMD64, alpha and others.
-
-
-
- The most current version is @VERSION@, dated
- @VDATE@.
+ variously on i386, AMD64, alpha, and others. The most current version is @VERSION@, dated @VDATE@. A full ChangeLog is written with each release.
- Snapshot source
+ Current
-
- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory.
-
-
-
- % cd /tmp
- % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -
- % cd mdocml
- % make all
- % make regress
- # 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
-
+
-
- # 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
-
+
+ Historical
+
-
- NetBSD pkgsrc
-
+
+ |
+
+
+
+
+ DOCUMENTATION
+
-
- # pkg_delete mdocml
- # cd /usr/pkgsrc/textproc/
- # rm -rf mdocml
- # ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
+
+ These manuals are generated automatically (with mandoc(1)) and refer to the
+ current snapshot.
-
- FreeBSD port
-
-
-
- # pkg_delete mdocml
- # cd /usr/ports/textproc/
- # rm -rf mdocml
- # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make build
- # make install
-
+
+
+
+
+
+ | mandoc(1) |
+ format and display UNIX manuals |
+
+
+ | mandoc_char(7) |
+ mandoc special characters |
+
+
+ | mdoc(7) |
+ mdoc language reference |
+
+
+ | man(7) |
+ man language reference |
+
+
+ | manuals(7) |
+ a guide to writing UNIX manuals |
+
+
+ | mdoc(3) |
+ mdoc macro compiler library |
+
+
+ | man(3) |
+ man macro compiler library |
+
+
+
|
@@ -155,23 +180,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).
|
|