| 1 |
.TH mkhtmlindex 1 __vendorversion__ |
| 2 |
.SH NAME |
| 3 |
mkhtmlindex \- generate index files for HTML man pages |
| 4 |
.SH SYNOPSIS |
| 5 |
.B mkhtmlindex |
| 6 |
.I htmlmandir |
| 7 |
.SH DESCRIPTION |
| 8 |
The |
| 9 |
.I mkhtmlindex |
| 10 |
program generates index files for a directory of HTML-formatted manual |
| 11 |
pages. |
| 12 |
It searches for files whose names are of the form \(lqname.1.html\(rq, |
| 13 |
and outputs index files \(lqmanindex1.html\(rq, \(lqmanindex.2.html\(rq, |
| 14 |
and so on, one for each manual volume. |
| 15 |
Empty index files will be removed. |
| 16 |
Names and descriptions are found by scanning the first |
| 17 |
.I <H2> |
| 18 |
section of each page. |
| 19 |
.SH OPTIONS |
| 20 |
.I mkhtmlindex |
| 21 |
takes only one argument: the directory to process. |
| 22 |
.SH NOTES |
| 23 |
This utility is currently rather specific to X manual pages. |
| 24 |
In particular, the format of the index files it outputs is not configurable, |
| 25 |
nor is the HTML formatting it expects of manual pages. |
| 26 |
.SH AUTHOR |
| 27 |
The version of the |
| 28 |
.I mkhtmlindex |
| 29 |
included in this X.Org Foundation release was originally written |
| 30 |
by David Dawes wrote as a part of XFree86. |
| 31 |
.PP |
| 32 |
Colin Watson wrote this manual page, originally for the Debian Project. |