===================================================================
RCS file: /cvs/mandoc/Attic/index.sgml,v
retrieving revision 1.136
retrieving revision 1.148
diff -u -p -r1.136 -r1.148
--- mandoc/Attic/index.sgml 2011/08/17 19:35:58 1.136
+++ mandoc/Attic/index.sgml 2011/11/23 10:26:37 1.148
@@ -39,35 +39,39 @@
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, for semantic search of manual content (both mandocdb and apropos are
+ still experimental).
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.
- To build and install into /usr/local/, just run make install.
- 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; please contact
- us if you plan to use it.
+ mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll
+ need libdb to build apropos 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 and apropos binary names are usually taken by
+ existing utilities.
-
+
Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
Windows binaries are compiled with MingW for the 32-bit (i686) and
64-bit (x86_64) architectures.
-
+
Downstream
-
+
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
@@ -106,6 +110,12 @@
CLASS="external">src/usr.bin/mandoc
+
+ | pkgsrc |
+
+ textproc/mdocml
+ |
+
@@ -121,6 +131,26 @@
+ | apropos(1) |
+
+ search the manual page database
+ (text |
+ xhtml |
+ pdf |
+ ps)
+ |
+
+
+ | demandoc(1) |
+
+ emit only text of UNIX manuals
+ (text |
+ xhtml |
+ pdf |
+ ps)
+ |
+
+
| mandoc(1) |
format and display UNIX manuals
@@ -131,16 +161,6 @@
|
- | mandocdb(8) |
-
- index UNIX manuals
- (text |
- xhtml |
- pdf |
- ps)
- |
-
-
| preconv(1) |
recode multibyte UNIX manuals
@@ -220,16 +240,26 @@
ps)
|
+
+ | mandocdb(8) |
+
+ index UNIX manuals
+ (text |
+ xhtml |
+ pdf |
+ ps)
+ |
+
- 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.
@@ -243,7 +273,7 @@
|
bug-reports, general questions, and announcements
- (archive)
+ (archive)
|
@@ -253,7 +283,7 @@
|
patches and system discussions
- (archive)
+ (archive)
|
@@ -263,7 +293,7 @@
|
source commit messages
- (archive)
+ (archive)
|
@@ -272,39 +302,52 @@
News
- 16-08-2011: version 1.11.6
+ 08-10-2011: version 1.12.0
- Handling of tr macro in roff implemented. This makes Perl documentation much more
- readable. Hyphenation is also now enabled in man format documents. Many other general
- improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at mdocml-win64.zip and a Mac OS X universal binary is available at mdocml-macosx.zip.
+ This version features a new, work-in-progress mandoc output mode: -Tman. This mode
+ allows a system maintainer to distribute man media for older systems that may not natively
+ support mdoc, such as old Solaris systems.
+ The -Ofragment option was added to mandoc's -Thtml and -Txhtml modes.
-
- 24-07-2011: version 1.11.5
+
+ While adding features, an apropos utility has been merged from the mandoc-tools sandbox.
+ This interfaces with mandocdb for semantic search of manual content. apropos is different from the traditional apropos primarily in allowing keyword search
+ (such as for functions, utilities, etc.) and regular expressions.
+ Note that the calling syntax for apropos is likely to change as it settles down.
- Significant eqn improvements. mdocml can now parse arbitrary eqn input
- (although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the eqn
- manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies
- the language specified in the Second
- Edition User's Guide.
+ In documentation news, the mdoc and man manuals have been made
+ considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE
+ SYNTAX to the roff manual, and by moving the very technical MACRO SYNTAX sections
+ down to the bottom of the page.
- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.
+ Furthermore, for tbl, the -Tascii mode horizontal spacing of tables was rewritten
+ completely. It is now compatible with groff, both
+ with and without frames and rulers. Nesting of indented blocks is now supported in man, and
+ several bugs were fixed regarding indentation and alignment. The page headers in mdoc are now
+ nicer for very long titles.
- 12-07-2011: version 1.11.4
+ 02-09-2011: version 1.11.7
- Bug-fixes and clean-ups across all systems, especially in mandocdb makewhatis (note: still not
- connected to the general build and must be compiled with make mandocdb make makewhatisderoff utility. Also improved the mdoc and man manuals.
+
+ 16-08-2011: version 1.11.6
+
+ Handling of tr macro in roff implemented. This makes Perl documentation much more
+ readable. Hyphenation is also now enabled in man format documents. Many other general
+ improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at mdocml-win64.zip and a Mac OS X universal binary is available at mdocml-macosx.zip.
+
+
See cvsweb for
historical notes.
@@ -312,7 +355,7 @@
Copyright © 2008–2011
Kristaps Dzonsons,
- $Date: 2011/08/17 19:35:58 $
+ $Date: 2011/11/23 10:26:37 $