|
-
- 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 roff implementation, for - displaying mdoc(7) pages whilst providing token support for man(7). - +
+ mdocml is a suite of tools compiling - What are UNIX manuals? Read manuals(7) for an introduction. - - -+ 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 are the man(3) and mdoc(3) libraries, validating compilers producing intermediate-form - output from -man or -mdoc input. 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(1), which formats manuals for - display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a - limited extent, -man manuals on the terminal. - ++ 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. + -- Please submit patches, bug reports and suggestions! Although a significant - implementation exists, work remains for the backend library and especially the front-end utilities. See - the contact information below for submissions. - - |
- ||||||||||||||||
- - INSTALLING SOURCES -++ The mdocml utility is a BSD.lv + Project member. + + |
+ ||||||||||||||||
+ + SOURCES +-- Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested - variously on i386, AMD64, alpha and others. - ++ 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 most current version is @VERSION@, dated - @VDATE@. - ++ Current +-- Snapshot source -+
- CVS sources are checkedout and snapshotted with version updates. These may be found in the /snapshots/ directory. A full ChangeLog is - written with each new snapshot. - ++ Downstream +-
- % cd /tmp
- Snapshot port/pkgsrc -++ Historical +-- The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at /ports-openbsd/, /ports-netbsd/ and /ports-freebsd/, respectively. Please read the OpenBSD Ports FAQ, the NetBSD pkgsrc guide or the FreeBSD ports - guide, first. - +
|
+ ||||||||||||||||
+ + DOCUMENTATION +-- OpenBSD port -++ These manuals are generated automatically and refer to the current snapshot. + -
- # pkg_delete mdocml
|
+ ||||||||||||||||
+ + CONTACT +-- NetBSD pkgsrc -++ For all issues related to mdocml, contact Kristaps Dzonsons, kris...@bsd.lv. + -
- # pkg_delete mdocml + You may also subscribe to several mailing lists (these require subscription, which is moderated). An + archive is not yet available. + -- FreeBSD port -+
|
+ ||||||||||||||||
+ + NEWS +-
- # pkg_delete -x mdocml |
- ||||||||||||||||
- - CONTACT -+
| ||||||||||||||||
| 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. + |
+