===================================================================
RCS file: /cvs/mandoc/Attic/index.sgml,v
retrieving revision 1.133
retrieving revision 1.146
diff -u -p -r1.133 -r1.146
--- mandoc/Attic/index.sgml 2011/07/24 19:08:09 1.133
+++ mandoc/Attic/index.sgml 2011/10/08 12:21:57 1.146
@@ -7,8 +7,19 @@
- mdocml – mdoc macro compiler
+ mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@)
+
+ Sources: current,
+ cvsweb
+ (archives)
+ |
+ Binaries: windows 32-bit, windows 64-bit, mac os x
+ (archives)
+
@@ -28,68 +39,44 @@
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.
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 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.
+
- 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).
+ 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.
-
- Distributed Win32 binaries are compiled using mingw32. They are
- distributed in a ZIP archive consisting of binaries, manuals, and other installable media.
-
-
- The most current version of mdocml is @VERSION@, dated @VDATE@.
-
- Current
-
-
-
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
+ official
.
+ Please contact us if you plan on maintaining a downstream version!
+
-
- Historical
-
-
- These manuals are generated automatically and refer to the current snapshot.
+ These manuals are generated automatically and refer to the current release.
+ They are the authoritative documentation for the mdocml system.
- 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.
@@ -299,7 +266,7 @@
|
bug-reports, general questions, and announcements
- (archive)
+ (archive)
|
@@ -309,7 +276,7 @@
|
patches and system discussions
- (archive)
+ (archive)
|
@@ -319,7 +286,7 @@
|
source commit messages
- (archive)
+ (archive)
|
@@ -328,58 +295,65 @@
News
- 24-07-2011: version 1.11.5
+ 08-10-2011: version 1.12.0
- 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.
+ 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.
- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.
+ 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.
-
- 12-07-2011: version 1.11.4
+
+ 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.
- 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 makewhatis
- 26-05-2011: version 1.11.3
+ 02-09-2011: version 1.11.7
- Introduce locale-encoding of output with the -Tlocale output option and Unicode escaped-character input.
- See mandoc and mandoc_char, respectively, for details.
- This allows for non-ASCII characters (e.g., \[u5000]) to be rendered in the locale's encoding, if said
- environment supports wide-character encoding (if it does not, -Tascii is used instead).
- Locale support can be turned off at compile time by removing -DUSE_WCHAR in the Makefile, in which case
- -Tlocale is always a synonym for -Tascii.
+ Added demandoc utility for stripping away macros and escapes. This replaces the
+ historical deroff utility. Also improved the mdoc and man manuals.
+
+ 16-08-2011: version 1.11.6
+
- Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into mandoc input by using the newly-added preconv utility.
- Note: in the future, this feature may be integrated into mandoc.
+ 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.
- 12-05-2011: version 1.11.2
+ 24-07-2011: version 1.11.5
- Corrected some installation issues in version 1.11.1.
- Further migration to libmandoc.
- Initial public release (this utility is very much under development) of mandocdbmakewhatis,
- initially named mandoc-db.
- This utility produces keyword databases of manual content
- mandoc-cgi,
- mandoc-tools,
- which features semantic querying of manual content.
+ 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.
+ This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip.
+
+
See cvsweb for
historical notes.
@@ -387,7 +361,7 @@
Copyright © 2008–2011
Kristaps Dzonsons,
- $Date: 2011/07/24 19:08:09 $
+ $Date: 2011/10/08 12:21:57 $