mkhtmlindex(1)

mkhtmlindex1

Generate index files for html man pages

Usage

mkhtmlindex htmlmandir

Overview

The mkhtmlindex program generates index files for a directory of HTML-formatted manual pages. It searches for files whose names are of the form “name.1.html”, and outputs index files “manindex1.html”, “manindex.2.html”, and so on, one for each manual volume. Empty index files will be removed. Names and descriptions are found by scanning the first <H2> section of each page.

Options

mkhtmlindex takes only one argument: the directory to process.

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.

Releases

11 releases since Debian 4.0 (Etch); the text changed 6 times.

  1. 4.0–5.0
  2. 6.0
  3. 7
  4. 8–11
  5. 12
  6. 13
  7. Arch

Author

The version of the mkhtmlindex utility included in this X.Org Foundation release was originally written by David Dawes as a part of XFree86.

Colin Watson wrote this manual page, originally for the Debian Project.

From imake 1.0.11-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.