X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/2b410ed7871c140f726a9665d3810f82e69f67ff..d6b4b7d01dc50c7808c233cb162e71c30a817c08:/index.sgml diff --git a/index.sgml b/index.sgml index 9800343e..2725db7b 100644 --- a/index.sgml +++ b/index.sgml @@ -20,47 +20,48 @@

- DESCRIPTION + DESCRIPTION

- 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 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. + 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, PostScript, and PDF. It is a BSD.lv project.

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

- SOURCES + SOURCES

- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux 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.

@@ -68,7 +69,7 @@

- + @@ -81,7 +82,7 @@ @@ -92,7 +93,7 @@
Online source - cvsweb + cvsweb
- + @@ -131,7 +132,7 @@
- + @@ -147,145 +148,247 @@ - - - + + +

- DOCUMENTATION + DOCUMENTATION

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

- + - - + + - - + + - - + + - - + + - - + + - - + + - - + + + + + + + + + +
mandoc(1) (text)format and display UNIX manualsmandoc(1) + format and display UNIX manuals + + (text | + xhtml | + pdf | + postscript) + +
mandoc_char(7) (text)mandoc special charactersman(3) + man macro compiler library + + (text | + xhtml | + pdf | + postscript) + +
mdoc(7) (text)mdoc language referencemdoc(3) + mdoc macro compiler library + + (text | + xhtml | + pdf | + postscript) + +
man(7) (text)man language referenceroff(3) + roff macro compiler library + + (text | + xhtml | + pdf | + postscript) + +
manuals(7) (text)a guide to writing UNIX manualsman(7) + man language reference + + (text | + xhtml | + pdf | + postscript) + +
mdoc(3) (text)mdoc macro compiler librarymandoc_char(7) + mandoc special characters + + (text | + xhtml | + pdf | + postscript) + +
man(3) (text)man macro compiler librarymdoc(7) + mdoc language reference + + (text | + xhtml | + pdf | + postscript) + +
roff(7) + roff-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + +
tbl(7) + tbl-mandoc language reference + + (text | + xhtml | + pdf | + postscript) + +
-
-

- CONTACT -

- For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. -

- -

- 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). + See Writing UNIX Manual Pages for a general + introduction to manpages and mdoc.

- NEWS + CONTACT

- - +

+ Please use the mailing lists for bug-reports, patches, questions, etc. (these require + subscription). Beyond that, contact Kristaps at kris...@bsd.lv. +

+ +
+ + - - - - - - - - - - - - - - - - - -
31-03-2010 - Version 1.9.22: adjusted merge of the significant work - by Ingo Schwarze in getting Xo blocks (block full implicit, e.g., - It for non-columnar lists) to work properly. This isn't enabled by - default: you must specify -DUGLY as a compiler flag - (see the Makefile for details). + + disc...@mdocml.bsd.lv
30-03-2010 - Version 1.9.20: more efforts to get roff instructions - in -man documents under control. Note that roff instructions embedded in - line-scoped, next-line macros (e.g. B) are not supported. Leading - punctuation for -mdoc macros, such as Fl ( ( a, are now correctly - handled. + + bug-reports, general questions, and announcements + (archive)
27-03-2010 - Version 1.9.18: many fixes (largely pertaining to - scope) and improvements (e.g., handling of apostrophe-control macros, which - fixes the strange BR seen in some macro output) to handling roff - instructions in -man documents. + + tec...@mdocml.bsd.lv
25-03-2010 - Version 1.9.17 highlights: accept perlpod standard preamble. - Also accept (and discard) de, dei, am, ami, and - ig roff macro blocks. + + patches and system discussions + (archive)
22-03-2010 - Version 1.9.16 highlights: inspired by patches and bug - reports by Ingo Schwarze, allowed -man to accept - non-printing elements to be nested within next-line scopes, such as br - within B or TH, which is valid roff. Longsoon architecture also - noted and Makefile cleaned up. + + sou...@mdocml.bsd.lv
18-02-2010 - Moved to our new BSD.lv home. - Version 1.9.15 highlights: XHTML is now an acceptable - output mode for mandoc(1); Xr made more - compatible with groff; Vt fixed when invoked in SYNOPSIS; \\ - escape removed; end-of-line white-space detected for all lines; subtle bug - fixed in list display for some modes; compatibility layer checked in for - compilation in diverse UNIX systems; and column lengths handled correctly. + + source commit messages + (archive)
+

+ NEWS +

+
+

+ 07-01-2011: + version 1.10.9 +

+

+ Many back-end fixes have been implemented: argument handling (quoting), man improvements, error/warning classes, and many more. +

+

+ Initial tbl functionality (see the TS, TE, and + T& macros in the roff manual) has been + merged from tbl.bsd.lv. Output is + still minimal, especially for -Thtml and -Txhtml, but manages to at least display data. This means that mandoc now has built-in support for two troff preprocessors via + libroff: soelim and tbl. +

+
+
+

+ 24-12-2010: + version 1.10.8 +

+

+ Significant improvements merged from OpenBSD downstream, including +

+
    +
  • many new roff components,
    • +
  • in-line implementation of troff's soelim,
    • +
  • broken-block handling,
    • +
  • overhauled error classifications, and
    • +
  • cleaned up handling of error conditions.
    • +
+

+ Also overhauled the -Thtml and -Txhtml output modes. They now display readable output in arbitrary + browsers, including text-based ones like lynx. See HTML and XHTML manuals in the DOCUMENTATION section for examples. Attention: available style-sheet classes have been considerably + changed! See the example.style.css file for details. + Lastly, libmdoc and libman have been + cleaned up and reduced in size and complexity. +

+
+

+ See cvsweb for + historical notes. +

+
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/03/31 08:42:40 $ + Copyright © 2008–2011 Kristaps Dzonsons, $Date: 2011/01/07 15:22:21 $