diff options
author | Reinhard Tartler <siretart@tauware.de> | 2011-10-10 17:43:39 +0200 |
---|---|---|
committer | Reinhard Tartler <siretart@tauware.de> | 2011-10-10 17:43:39 +0200 |
commit | f4092abdf94af6a99aff944d6264bc1284e8bdd4 (patch) | |
tree | 2ac1c9cc16ceb93edb2c4382c088dac5aeafdf0f /nx-X11/config/util/mkhtmlindex.man | |
parent | a840692edc9c6d19cd7c057f68e39c7d95eb767d (diff) | |
download | nx-libs-f4092abdf94af6a99aff944d6264bc1284e8bdd4.tar.gz nx-libs-f4092abdf94af6a99aff944d6264bc1284e8bdd4.tar.bz2 nx-libs-f4092abdf94af6a99aff944d6264bc1284e8bdd4.zip |
Imported nx-X11-3.1.0-1.tar.gznx-X11/3.1.0-1
Summary: Imported nx-X11-3.1.0-1.tar.gz
Keywords:
Imported nx-X11-3.1.0-1.tar.gz
into Git repository
Diffstat (limited to 'nx-X11/config/util/mkhtmlindex.man')
-rw-r--r-- | nx-X11/config/util/mkhtmlindex.man | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/nx-X11/config/util/mkhtmlindex.man b/nx-X11/config/util/mkhtmlindex.man new file mode 100644 index 000000000..fc8a4276b --- /dev/null +++ b/nx-X11/config/util/mkhtmlindex.man @@ -0,0 +1,32 @@ +.TH mkhtmlindex 1 __vendorversion__ +.SH NAME +mkhtmlindex \- generate index files for HTML man pages +.SH SYNOPSIS +.B mkhtmlindex +.I htmlmandir +.SH DESCRIPTION +The +.I mkhtmlindex +program generates index files for a directory of HTML-formatted manual +pages. +It searches for files whose names are of the form \(lqname.1.html\(rq, +and outputs index files \(lqmanindex1.html\(rq, \(lqmanindex.2.html\(rq, +and so on, one for each manual volume. +Empty index files will be removed. +Names and descriptions are found by scanning the first +.I <H2> +section of each page. +.SH OPTIONS +.I mkhtmlindex +takes only one argument: the directory to process. +.SH NOTES +This utility is currently rather specific to X manual pages. +In particular, the format of the index files it outputs is not configurable, +nor is the HTML formatting it expects of manual pages. +.SH AUTHOR +The version of the +.I mkhtmlindex +included in this X.Org Foundation release was originally written +by David Dawes wrote as a part of XFree86. +.PP +Colin Watson wrote this manual page, originally for the Debian Project. |