X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/5ab74af420002aecfc6e50c48d14fe81df326147..6c92b33c82f700e7de6fd5bd6ab7360f45905649:/index.sgml diff --git a/index.sgml b/index.sgml index d7b2d26c..6c9b9ea6 100644 --- a/index.sgml +++ b/index.sgml @@ -9,11 +9,9 @@
mdocml – mdoc macro compiler
-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 @@ -21,42 +19,44 @@ HREF="http://www.gnu.org/software/groff/" CLASS="external">groff, the GNU troff implementation, for displaying mdoc pages whilst providing token support for man.
-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).
-mdocml consists of the libmandoc validating compiler and mandoc, which interfaces with the compiler library to format output for UNIX terminals, XHTML, - HTML, PostScript, and PDF. It is a BSD.lv project. + HREF="mandoc.1.html">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 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 UNIX system, although makewhatis requires mandocdb requires Berkeley Database (this is
- installed by default on all BSD operating systems). The most current version is @VERSION@,
- dated @VDATE@. If your system doesn't come with mdocml (see
- Downstream
), run make
to compile and make install
to install into /usr/local.
- Note that makewhatis is not yet linked to the build. You must run make
- makewhatis
to build it (it does not install).
+ installed by default on all BSD operating systems).
+ 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) + (md5) |
These manuals are generated automatically and refer to the current snapshot.
@@ -158,14 +152,26 @@Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the TODO for known issues @@ -267,7 +271,6 @@ HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal this e-mail address">kris...@bsd.lv.
-- 12-05-2011: version 1.11.2 + 12-07-2011: version 1.11.4
- Corrected some installation issues in version 1.11.1.
- Further migration to libmandoc.
- Initial public release (this utility is very much under development) of makewhatis,
- initially named mandoc-db.
- This utility produces keyword databases of manual content
- mandoc-cgi, which features semantic querying of manual content.
+ 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
) and the man parser. This release was significantly assisted by participants in OpenBSD's c2k11. Thanks!
make makewhatis
- 04-04-2011: version 1.11.1 + 26-05-2011: version 1.11.3
- The earlier libroff, libmdoc, and libman soup have been merged into - a single library, libmandoc, which manages all aspects of - parsing real manuals (from line-handling to tbl parsing). + 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.
- Beyond this structural change, initial eqn functionality is in - place. For the time being, this is limited to the recognition of equation blocks; - future version of mdocml will expand upon this framework. + 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. +
++ 12-05-2011: version 1.11.2
- As usual, many general fixes and improvements have also occurred. In particular, a great
- deal of redundancy and superfluous code has been removed with the merging of the backend
- libraries.
+ 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.
See cvsweb for historical notes.
-Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/05/14 23:41:50 $ + $Date: 2011/07/14 14:36:37 $