=================================================================== RCS file: /cvs/mandoc/Attic/index.sgml,v retrieving revision 1.134 retrieving revision 1.154.2.4 diff -u -p -r1.134 -r1.154.2.4 --- mandoc/Attic/index.sgml 2011/08/16 12:13:27 1.134 +++ mandoc/Attic/index.sgml 2013/09/23 20:20:10 1.154.2.4 @@ -3,12 +3,17 @@
-- mdocml – mdoc macro compiler + mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)
++ Sources: current, + cvsweb + (archives) +
- 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 + Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. 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).
@@ -28,121 +33,77 @@ mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals (with support for wide-character locales), XHTML, HTML, PostScript, and PDF. - It also includes preconv, for recoding multibyte manuals; and mandocdb, for indexing manuals. + It also includes preconv, for recoding multibyte manuals; + demandoc, for emitting only text parts of manuals; + mandocdb, for indexing manuals; and + apropos, whatis, and + man.cgi (via catman) for semantic search of manual content. It is a BSD.lv project.
Disambiguation: mdocml is often referred to by its installed binary, mandoc
.
- mdocml is in plain-old ANSI C and should build and run on any modern system (mandocdb requires Berkeley Database, installed by
- default on all BSD UNIX operating systems).
+ mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll
+ need libdb to build apropos, whatis, man.cgi, catman, and mandocdb (this is installed by default on BSD UNIX
+ systems — see the Makefile if you're running Linux). To build and install into /usr/local/, just
+ run make install
. Be careful: the preconv, apropos, and whatis binary names are
+ usually taken by existing utilities.
- To compile mdocml, run make
, then make install
to install into
- /usr/local. Be aware: if you have an existing groff installation, this may overwrite its preconv binary. The mandocdb utility is not yet linked to the build: you must run make mandocdb
to
- build it (it does not install).
-
- The most current version of mdocml is @VERSION@, dated @VDATE@. -
Source archive | -- /snapshots/mdocml.tar.gz - (md5) - | -
Online source | -- cvsweb - | -
Win32 (i686) binary archive | -- /binaries/mdocml-win32.zip - | -
Win64 (x86_64) binary archive | -- /binaries/mdocml-win64.zip - | -
+ Several systems come bundled with mdocml utilities.
+ If your system does not appear below, the maintainers have not contacted me and it should not be considered
+ official
.
+ Please contact us if you plan on maintaining a downstream version!
+
DragonFly BSD | - usr.bin/mandoc + contrib/mdocml (1.12.1 sources) + lib/libmandoc + usr.bin/mandoc (build system) |
FreeBSD | - ports/textproc/mdocml + ports/textproc/mdocml (1.12.1 port) |
NetBSD | - src/external/bsd/mdocml + src/external/bsd/mdocml (1.12.1 sources plus patches and build system) |
OpenBSD | - src/usr.bin/mandoc + src/usr.bin/mandoc (1.12.2 sources and build system) |
Source archive | +pkgsrc | - /snapshots/ + textproc/mdocml (1.12.0 port) |
Binary archive | +Minix3 | - /binaries/ + external/bsd/mdocml (1.10.9 sources and build system) |
mandoc(1) | +apropos(1) | - format and display UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + search the manual page database |
mandocdb(8) | +demandoc(1) | - index UNIX manuals - - (text | - xhtml | - pdf | - postscript) - + emit only text of UNIX manuals |
mandoc(1) | ++ format and display UNIX manuals + | +|
preconv(1) | recode multibyte UNIX manuals - - (text | - xhtml | - pdf | - postscript) - | |
whatis(1) | ++ search the manual page database + | +|
mandoc(3) | mandoc macro compiler library - - (text | - xhtml | - pdf | - postscript) - | |
man(7) | +tbl(3) | - man language reference - - (text | - xhtml | - pdf | - postscript) - + roff table parser library for mandoc |
eqn(7) | eqn-mandoc language reference - - (text | - xhtml | - pdf | - postscript) - | |
man(7) | ++ man language reference + | +|
man.cgi(7) | ++ cgi for manpage query and display + | +|
mandoc_char(7) | mandoc special characters - - (text | - xhtml | - pdf | - postscript) - | |
mdoc(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) - | |
catman(8) | ++ update a man.cgi manpage cache + | +|
mandocdb(8) | ++ index UNIX manuals + | +
- Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the + Use the mailing lists for bug-reports, patches, questions, etc. Please check the TODO for known issues - before posting. Beyond that, contact Kristaps at kris...@bsd.lv. + before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, + contact Kristaps at kris...@bsd.lv. Archives are available at Gmane.
bug-reports, general questions, and announcements - (archive) |
patches and system discussions - (archive) |
source commit messages - (archive) |