X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/0d31fe8e373641961cf6174f5eda01fafe311ad3..b9ac7e789aa2c1bf358e1d967a0b87ef2322744b:/index.sgml diff --git a/index.sgml b/index.sgml index 2da1913e..0df668ea 100644 --- a/index.sgml +++ b/index.sgml @@ -3,11 +3,11 @@ - + mdocml.bsd.lv - +

@@ -28,12 +28,7 @@ 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). -

- -

- What are UNIX manuals? Read manuals(7) for an introduction. + displaying -mdoc pages whilst providing token support for -man.

@@ -43,118 +38,145 @@

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

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

- INSTALLING SOURCES + SOURCES

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 (txt) 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. 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 -

+ + + + + + + + + + + + + +

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

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

+ + + + + + + + + + + + + + + + + +

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

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

- -

- NetBSD pkgsrc -

- -

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

+ Historical +

- FreeBSD port -

+ + + + + + + + + +

Source archive

+ /snapshots/ +

+ DOCUMENTATION +

- # pkg_delete -x mdocml
- # cd /tmp
- # ftp -V -o- - http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -
- # cd mdocml
- # make
- # make install -

+ These manuals are generated automatically (with mandoc(1) -Thtml) and refer to the + current snapshot. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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