MKHTMLINDEX(1)

📦
version 1.0.11 · 3 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

💖 mkhtmlindex(1) 💖

okay so bestie, this is the mkhtmlindex(1) page — it lives in the General Commands Manual, and it exists to generate index files for HTML man pages. no cap, let's get into it 💅

📛 NAME 📛

mkhtmlindex — generate index files for HTML man pages

🧾 SYNOPSIS 🧾

mkhtmlindex htmlmandir

🌸 DESCRIPTION 🌸

so 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. iconic behavior, honestly ✨

empty index files will be removed. gone. bye. 🫶

names and descriptions are found by scanning the first <H2> section of each page. that's the vibe check for where the useful text lives 💖

✨ OPTIONS ✨

  • the one and only argument — mkhtmlindex takes only one argument: the directory to process. that's it. that's the whole options list. periodt 💅

🚨 NOTES 🚨

🚨 real talk, bestie: 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. so like, those bits are not giving customizable energy 😭

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

okay bye bestie! this page came from imake 1.0.11, dated 2004-04-23, and the footer says MKHTMLINDEX(1) — slay, that's a wrap 🌈💅

📦 where this page comes from