X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/12a998ed6c1cbb3d6dcfe0e2d410ed33c70a9d84..dd41ba9876ecdb30f9dbb35bcdeff569f90b2c0a:/index.sgml diff --git a/index.sgml b/index.sgml index af354ce3..23269e80 100644 --- a/index.sgml +++ b/index.sgml @@ -3,22 +3,16 @@ - mdocml | mdoc macro compiler + mdocml | UNIX manpage compiler

- mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@) + mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

Sources: current, cvsweb (archives) - | - Binaries: windows 32-bit, windows 64-bit, mac os x - (archives)

Description @@ -39,10 +33,11 @@ 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; - demandoc, for emitting only text parts of manuals; - mandocdb, for indexing manuals; and - apropos, for semantic search of manual content. + It also includes preconv for recoding multibyte manuals, + demandoc for emitting only text parts of manuals, + mandocdb for indexing manuals, + apropos (includes whatis mode) for indexed manual search, and + man.cgi for indexed manual search online. It is a BSD.lv project.

@@ -52,20 +47,11 @@ Sources

- 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. -

-

- Binaries -

-

- 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. + mdocml is in ISO C99 and should build and run on any modern system; however, you'll need sqlite3 to build apropos (links to whatis), + man.cgi, and mandocdb. + 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.

Downstream @@ -83,29 +69,37 @@ DragonFly BSD - usr.bin/mandoc + usr.bin/mandoc FreeBSD - ports/textproc/mdocml + ports/textproc/mdocml NetBSD - src/external/bsd/mdocml + src/external/bsd/mdocml OpenBSD - src/usr.bin/mandoc + src/usr.bin/mandoc + + + + pkgsrc + + textproc/mdocml + + + + Minix3 + + external/bsd/mdocml @@ -126,120 +120,78 @@ 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 - (text | - xhtml | - pdf | - ps) preconv(1) recode multibyte UNIX manuals - (text | - xhtml | - pdf | - ps) mandoc(3) mandoc macro compiler library - (text | - xhtml | - pdf | - ps) man(7) man language reference - (text | - xhtml | - pdf | - ps) + + + + man.cgi(7) + + cgi for manpage query and display eqn(7) eqn-mandoc language reference - (text | - xhtml | - pdf | - ps) mandoc_char(7) mandoc special characters - (text | - xhtml | - pdf | - ps) mdoc(7) mdoc language reference - (text | - xhtml | - pdf | - ps) roff(7) roff-mandoc language reference - (text | - xhtml | - pdf | - ps) tbl(7) tbl-mandoc language reference - (text | - xhtml | - pdf | - ps) mandocdb(8) index UNIX manuals - (text | - xhtml | - pdf | - ps) @@ -252,7 +204,7 @@ TODO for known issues 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. + this e-mail address">kris...@bsd.lv. Archives are available at Gmane.

@@ -265,7 +217,6 @@ @@ -275,7 +226,6 @@ @@ -285,7 +235,6 @@ @@ -294,61 +243,15 @@ News

- xx-xx-2011: version 1.xx.x -

-

- 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. -

-

- While adding features, an apropos utility has been merged from the mandoc-tools sandbox. - This interfaces with mandocdb for semantic search of manual content. -

-

- 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. -

-

- 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. -

-

- 02-09-2011: version 1.11.7 -

-

- 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 -

-

- 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. -

-

- 24-07-2011: version 1.11.5 + xx-xx-2012: version 1.12.4

- 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. + Ingo, can you summarise your changes here?

- This is also the first release featuring a distributed Windows binary, available at /binaries/mdocml-win32.zip. + The mandocdb tools (mandocdb, apropos (absorbing whatis), and man.cgi) have been re-written to + use sqlite3 as a database.

See cvsweb for @@ -358,7 +261,7 @@ Copyright © 2008–2011 Kristaps Dzonsons, - $Date: 2011/10/06 23:06:31 $ + $Date: 2012/06/09 14:19:55 $

bug-reports, general questions, and announcements - (archive)
patches and system discussions - (archive)
source commit messages - (archive)