X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/92492cc66c8225172dda8e6ce16fba936dd845f2..b088e954af8efacd0953fb5fb903d2e434649ebf:/index.sgml
diff --git a/index.sgml b/index.sgml
index 229b3aec..32494e44 100644
--- a/index.sgml
+++ b/index.sgml
@@ -15,12 +15,19 @@
mdocml – mdoc macro compiler
+
@@ -38,14 +45,15 @@
- 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.
+ 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.
- The mdocml utility is a BSD.lv
+ The mdocml suite is a BSD.lv
Project member.
|
@@ -53,13 +61,13 @@
- 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 @VERSION@, dated @VDATE@. A full ChangeLog (txt) is written with each release.
@@ -81,7 +89,7 @@
|
Online source |
- cvsweb
+ cvsweb
|
@@ -147,7 +155,7 @@
@@ -159,41 +167,90 @@
|
- mandoc(1) (text) |
- format and display UNIX manuals |
+ man(3) |
+
+ man macro compiler library
+
+ |
- mandoc_char(7) (text) |
- mandoc special characters |
+ man(7) |
+
+ man language reference
+
+ |
- mdoc(7) (text) |
- mdoc language reference |
+ mandoc(1) |
+
+ format and display UNIX manuals
+
+ |
- man(7) (text) |
- man language reference |
+ mandoc_char(7) |
+
+ mandoc special characters
+
+ |
- manuals(7) (text) |
- a guide to writing UNIX manuals |
+ mdoc(3) |
+
+ mdoc macro compiler library
+
+ |
- mdoc(3) (text) |
- mdoc macro compiler library |
+ mdoc(7) |
+
+ mdoc language reference
+
+ |
- man(3) (text) |
- man macro compiler library |
+ roff(3) |
+
+ roff macro compiler library
+
+ |
+
+
+ roff(7) |
+
+ roff-mandoc language reference
+
+ |
+
+
+ See Writing UNIX Manual Pages
for a general
+ introduction to manpages and mdoc.
+
@@ -204,7 +261,8 @@
- You may also subscribe to several mailing lists (these require subscription, which is moderated):
+ 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.
@@ -214,14 +272,21 @@
disc...@mdocml.bsd.lv
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...@mdocml.bsd.lv
|
- discussions and announcements |
+ high-level discussions and version announcements |
+
+
+
+ tec...@mdocml.bsd.lv
+ |
+ low-level discussions |
sou...@mdocml.bsd.lv
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...@mdocml.bsd.lv
|
source commit messages |
@@ -232,123 +297,141 @@
- NEWS
+ NEWS
-
-
-
-
-
- 13-05-2010 |
-
- 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!
- Version: 1.9.25.
- |
-
- 09-05-2010 |
-
- 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).
- Version: 1.9.24.
- |
-
-
-
- 07-04-2010 |
-
- mdocml has been linked to the OpenBSD build. This
- version incorporates many small changes, mostly from patches by OpenBSD,
- allowing crufty manuals to slip by with warnings instead of erroring-out. Some
- subtle semantic issues, such as punctuation scope, have also been fixed.
- Lastly, some issues with -Thtml have been fixed, which
- prompted an update to the online manual pages style
- layout. Version: 1.9.23.
- |
-
-
- 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).
- |
-
-
- 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.
- |
-
-
- 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.
- |
-
-
- 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.
- |
-
-
- 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.
- |
-
-
- 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.
- |
-
-
-
+
+
+ 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
+
+
+ This primarily focusses on the Bl and It macros described in mdoc. Multi-line column support is now fully compatible with
+ groff, as are implicit list entries for columns. Removed manuals.7 in favour of http://manpages.bsd.lv. The way we
+ handle the SYNOPSIS section (see the SYNOPSIS documentation in MANUAL STRUCTURE) has also
+ been considerably simplified compared to groff's method. Furthermore, the -Owidth=width output option has been added to -Tascii (see mandoc). Lastly, initial
+ PostScript output has been added with the -Tps option to mandoc. It's brutally simple at the moment: fixed-font, with
+ no font decorations.
+
+
+
+
+ 29-05-2010:
+ version 1.10.0
+
+
+ Release consisting of the results from the m2k10 hackathon and up-merge from OpenBSD.
+ This requires a significant note of thanks to Ingo Schwarze (OpenBSD) and Joerg
+ Sonnenberger (NetBSD) for their hard work, and again to Joerg for hosting m2k10.
+ Highlights (mostly cribbed from Ingo's m2k10 report) follow in no particular order:
+
+
+ - a libroff preprocessor in front of libmdoc and libman stripping out
+ roff instructions;
+ - end-of-sentence (EOS) detection in free-form and macro lines;
+ - correct handling of tab-separated columnar lists in -mdoc;
+ - improved main calling routines to optionally use mmap() for better
+ performance;
+ - cleaned up exiting when invoked as -Tlint or over
+ multiple files with -fign-errors;
+ - error and warning message handling re-written to be unified for libroff, libmdoc, and libman;
+ - handling of badly-nested explicit-scoped macros;
+ - improved free-form text parsing in libman and libmdoc;
+ - significant GNU troff compatibility improvements in -Tascii, largely in terms of spacing;
+ - a regression framework for making sure the many fragilities of GNU troff
+ aren't trampled in subsequent work;
+ - support for -Tascii breaking at hyphens
+ encountered in free-form text;
+ - and many more minor fixes and improvements (no really, consult cvsweb and see
+ 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.
+
|
|
|