X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/7ccefed6909eee0e5ee1b394264d75d16d45df7b..1a3bd1cb27795956ca71c666968330b81362d013:/index.sgml?ds=inline diff --git a/index.sgml b/index.sgml index 918d0bbb..08826271 100644 --- a/index.sgml +++ b/index.sgml @@ -1,241 +1,449 @@ - - - - - - mdocml.bsd.lv - - - - - - - - - - + + + + + + + + + + + + + + +
-
- mdocml – mdoc macro compiler -
-
-

- 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 | mdoc macro compiler + + + + + + + + + + - - - + + + - - - - - - - - - - - -
+
+ mdocml – mdoc macro compiler +
+
+

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

- -

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

-
-

- DOWNLOADS -

- -

- 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@. A full ChangeLog is written with each new version. -

- -

- Downstream -

- - - - - - - - - - - - - - - - - - -
FreeBSD - ports/textproc/mandoc -
NetBSD - pkgsrc/textproc/mandoc -
OpenBSD - src/usr.bin/mandoc -
- -

+ this (respectively small, C, ISC-licensed, fast and regular). +

+ +

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

+ +

+ Disambiguation: mdocml is often referred to by its installed binary, + mandoc. +

+

+

+ SOURCES +

+ +

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

+ +

Current -

- - - - - - - - - - - - - - - - - - - - - - -
Source archive - mdocml.tar.gz - (md5) -
FreeBSD port - mdocml.tar.gz - (md5) -
NetBSD pkgsrc - /ports-netbsd/mdocml.tar.gz - (md5) -
OpenBSD port - mdocml.tar.gz - (md5) -
- -

+

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

+ Downstream +

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

Historical -

- - - - - - - - - - - - - - - - - - - - - - -
Source archive - /snapshots/ -
FreeBSD port - /ports-freebsd/ -
NetBSD pkgsrc - /ports-netbsd/ -
OpenBSD port - /ports-openbsd/ -
-
-

- DOCUMENTATION -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
mandoc(1)format and display UNIX manuals
mandoc_char(7)mandoc special characters
mdoc(7)mdoc language reference
man(7)man language reference
manuals(7)a guide to writing UNIX manuals
mdoc(3)mdoc macro compiler library
man(3)man macro compiler library
-
-

- CONTACT -

- -

- For all issues related to mdocml, contact Kristaps Džonsons, kris...@kth.se. -

- -

- If you want to receive a semi-automated mail-out of new versions, then please write with a message - subject of subscribe mdocml (or unsubscribe mdocml). -

-
-
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/25 10:52:56 $ -
-
- - + + + + + + + + + + + +
Source archive + /snapshots/ +
+

+

+ DOCUMENTATION +

+ +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
man(3) + man macro compiler library + + (text | + pdf | + postscript) + +
man(7) + man language reference + + (text | + pdf | + postscript) + +
mandoc(1) + format and display UNIX manuals + + (text | + pdf | + postscript) + +
mandoc_char(7) + mandoc special characters + + (text | + pdf | + postscript) + +
mdoc(3) + mdoc macro compiler library + + (text | + pdf | + postscript) + +
mdoc(7) + mdoc language reference + + (text | + pdf | + postscript) + +
roff(3) + roff macro compiler library + + (text | + pdf | + postscript) + +
roff(7) + roff-mandoc language reference + + (text | + pdf | + postscript) + +
+ +

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

+
+

+ CONTACT +

+ +

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

+ + + + + + + + + + + + + + + + + + +
+ disc...@mdocml.bsd.lv + + bug-reports, general questions, and announcements + (archive) +
+ tec...@mdocml.bsd.lv + + patches and system discussions + (archive) +
+ sou...@mdocml.bsd.lv + + source commit messages + (archive) +
+
+

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

+
    +
  • fix Sm and Bd handling
    • +
  • fix end-of-sentence handling for embedded sentences
    • +
  • polish man documentation
    • +
  • document all mdoc macros
    • +
  • polish mandoc -Tps output
    • +
  • lots of internal clean-ups in character escapes
    • +
  • un-break literal contexts in man documents
    • +
  • improve -Thtml output for -man
    • +
  • add mandoc -Tpdf support
    • +
+
+
+

+ 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!).
    • +
+
+

+ See cvsweb for + historical notes. +

+
+
+ Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/08/19 20:49:34 $ +
+
+ +