=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.11 retrieving revision 1.59 diff -u -p -r1.11 -r1.59 --- mandoc/Attic/index.sgml 2009/03/21 09:50:07 1.11 +++ mandoc/Attic/index.sgml 2010/05/09 06:18:55 1.59 @@ -1,174 +1,346 @@ - -
- - - -
-
- mdocml – mdoc macro compiler
-
- |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-
+
+
+
+
+
+ |
+
+
+ mdocml – mdoc macro compiler
+
+ |
+ ||||||||||||||
+ DESCRIPTION -+ -- mdocml is a suite of tools compiling “mdoc”, the roff macro - package for BSD manual pages. The mission of mdocml is to deprecate groff, the GNU roff implementation, for - displaying BSD mdoc pages. - +
+ mdocml is a suite of tools compiling - Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some 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). - ++ 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 the libmdoc library, a validating scanner-parser producing - intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers - of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the mdoc(3) reference manual. - ++ 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. + -- There are three utilities implementing mdoc(3): - ++ The mdocml utility is a BSD.lv + Project member. + + |
+ ||||||||||||||
+ + 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. + -- The mdocterm(1) utility is intended to deprecate usage of groff for displaying BSD manuals to the - terminal, either directly or cached as a “catman” page. - ++ Current +-- Please submit patches! Although a significant implementation exists, work - remains for the backend library and especially the front-end utilities. See the contact information below to submit patches and bug reports. - - |
- ||||||||||||||
- - INSTALLING SOURCES -+
- Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. - ++ Downstream +-- The most current version is @VERSION@, dated - @VDATE@. - +
- Snapshot source -++ Historical +-- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. - +
|
+ ||||||||||||||
+ + DOCUMENTATION +-
- % cd /tmp + These manuals are generated automatically and refer to the current snapshot. + -- Snapshot port/pkgsrc -+
|
+ ||||||||||||||
+ + CONTACT +-- The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at /ports-openbsd/ and /ports-netbsd/, - respectively. Please read the OpenBSD Ports FAQ or - NetBSD pkgsrc guide, first. - ++ For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. + -- OpenBSD port -++ You may also subscribe to several mailing lists (these require subscription): + -
- # pkg_delete mdocml
|
+ ||||||||||||||
+ + NEWS +-- NetBSD pkgsrc -+
| ||||||||||||||
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 Xoblocks (block full implicit, e.g., + Itfor 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 BRseen 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 + igroff 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 Bor 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); Xrmade more + compatible with groff; Vtfixed 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. + |
+