X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/52a6412fdcb8f1a5dc171050b265756e3046642b..92d36306307652f916347656b5c31928db651c45:/index.sgml?ds=inline diff --git a/index.sgml b/index.sgml index 7ca146d3..08826271 100644 --- a/index.sgml +++ b/index.sgml @@ -15,13 +15,6 @@
mdocml – mdoc macro compiler
-
- Description | - Sources | - Documentation | - Contact | - News -
@@ -31,30 +24,31 @@

- 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. + 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 troff + implementation, for displaying -mdoc pages whilst providing token support for -man.

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). + this (respectively small, C, ISC-licensed, fast and regular).

- The core of mdocml is composed of the libmdoc, libman, and libroff validating compiler libraries. All - 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 front-end is mandoc, which formats - manuals for display. + mdocml consists of the libmdoc, libman, and libroff validating compilers; and mandoc, which interfaces with the compiler libraries to format output for UNIX + terminals, XHTML, HTML, and PostScript. mdocml is a BSD.lv project.

- The mdocml suite is a BSD.lv - Project member. + Disambiguation: mdocml is often referred to by its installed binary, + mandoc.

@@ -65,10 +59,9 @@

- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many - other 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. + mdocml is architecture- and system-neutral, written in plain-old C. The most + current version is @VERSION@, dated @VDATE@. A full + ChangeLog (txt) is written with each release.

@@ -159,7 +152,7 @@

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

@@ -170,72 +163,88 @@ @@ -244,6 +253,7 @@

See Writing UNIX Manual Pages for a general introduction to manpages and mdoc. +

@@ -253,15 +263,15 @@

- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. + Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact + Kristaps at kris...@bsd.lv.

- You may also subscribe to several mailing lists (these require subscription, which is moderated). An - archive is not yet available on-line, although you may request one once subscribed. + You may also subscribe to several mailing lists (these require subscription, which is + moderated).

man(3) man macro compiler library -
- text | postscript -
+ + (text | + pdf | + postscript) +
man(7) man language reference -
- text | postscript -
+ + (text | + pdf | + postscript) +
mandoc(1) format and display UNIX manuals -
- text | postscript -
+ + (text | + pdf | + postscript) +
mandoc_char(7) mandoc special characters -
- text | postscript -
+ + (text | + pdf | + postscript) +
mdoc(3) mdoc macro compiler library -
- text | postscript -
+ + (text | + pdf | + postscript) +
mdoc(7) mdoc language reference -
- text | postscript -
+ + (text | + pdf | + postscript) +
roff(3) roff macro compiler library -
- text | postscript -
+ + (text | + pdf | + postscript) +
roff(7) roff-mandoc language reference -
- text | postscript -
+ + (text | + pdf | + postscript) +
@@ -273,21 +283,30 @@ disc...@mdocml.bsd.lv - + - + - +
high-level discussions and version announcements + bug-reports, general questions, and announcements + (archive) +
tec...@mdocml.bsd.lv low-level discussions + patches and system discussions + (archive) +
sou...@mdocml.bsd.lv source commit messages + source commit messages + (archive) +
@@ -298,6 +317,60 @@

NEWS

+
+

+ 27-07-2010: + version 1.10.5 +

+

+ Primarily a bug-fix and polish release, but including -Tpdf + support in mandoc by way of Summer of Code. + Highlights: +

+ +
+
+

+ 12-07-2010: + version 1.10.4 +

+

+ Lots of features developed during both Summer of Code and the + OpenBSD c2k10 hackathon: +

+ +
+
+

+ 19-06-2010: + version 1.10.2 +

+

+ Small release featuring text-decoration in -Tps output, a few + minor relaxations of errors, and some optimisations. +

+

07-06-2010: @@ -357,39 +430,6 @@ for yourself!).

-
-

- 13-05-2010: - version 1.9.25 -

-

- Fixed handling of \*(Ba escape. Backed out -fno-ign-chars (pointless complexity). Fixed erroneous - breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial - macros. Changed default section ordering. Most importantly, the framework for - end-of-sentence double-spacing is in place, now implemented for the - end-of-sentence, end-of-line rule. This is a stable roll-back point - before the mandoc hackathon in Rostock! -

-
-
-

- 09-05-2010: - version 1.9.24 -

-

- Rolled back break-at-hyphen. -DUGLY is now the - default (no feature splits!). Free-form text is not de-chunked any more: lines - are passed whole-sale into the front-end, including whitespace. Added mailing - lists. Lastly, mdocml is the focus of two Google Summer of Code - projects this year: mandoc -Tps - (NetBSD) and BSD-licensed - Text-Processing Tools (FreeBSD). -

-

See cvsweb for historical notes. @@ -399,7 +439,7 @@

- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/06/08 09:15:58 $ + Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/08/19 20:49:34 $