X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/e2966786aac5996e10ef67b6b197867846a99c1c..52a2d24a5977427830c9757b19fb36e1d1ac5307:/index.sgml?ds=sidebyside diff --git a/index.sgml b/index.sgml index b14ce2d4..a7baa7f2 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,73 @@ @@ -244,6 +238,7 @@

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

@@ -253,15 +248,16 @@

- 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). An archive is not yet available on-line, although you may request one once + subscribed.

man(3) man macro compiler library -
- text | postscript -
+ + (text | postscript) +
man(7) man language reference -
- text | postscript -
+ + (text | postscript) +
mandoc(1) format and display UNIX manuals -
- text | postscript -
+ + (text | postscript) +
mandoc_char(7) mandoc special characters -
- text | postscript -
+ + (text | postscript) +
mdoc(3) mdoc macro compiler library -
- text | postscript -
+ + (text | postscript) +
mdoc(7) mdoc language reference -
- text | postscript -
+ + (text | postscript) +
roff(3) roff macro compiler library -
- text | postscript -
+ + (text | postscript) +
roff(7) roff-mandoc language reference -
- text | postscript -
+ + (text | postscript) +
@@ -273,14 +269,14 @@ disc...@mdocml.bsd.lv - + - +
high-level discussions and version announcementsbug-reports, general questions, and announcements
tec...@mdocml.bsd.lv low-level discussionspatches and system discussions
@@ -299,7 +295,37 @@ NEWS
+

+ 12-07-2010: + version 1.10.4 +

+

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

+
    +
  • minimal ds roff symbols are supported
    • +
  • Bk mdoc support
    • +
  • beautified SYNOPSIS section output
    • +
  • variable font-width and paper-size support in mandoc + -Tps output
    • +
  • acceptance of scope-block breakage in mdoc
    • +
  • clarify error message status
    • +
  • many minor bug-fixes and formatting issues resolved
    • +
+
+

+ 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: version 1.10.1 @@ -358,39 +384,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. @@ -400,7 +393,7 @@

- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/06/07 21:05:59 $ + Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/07/21 10:10:24 $