COLLATEINDEX(1)

💖 COLLATEINDEX(1) 💖

okay bestie, gather round, because this is the DocBook DSSSL era icon and she is serving utility. This is collateindex.pl, and she lives in the DocBook DSSSL family of manual pages. Let's get into it. 🎀

✨ NAME ✨

collateindex.pl — generate DocBook index files. literally her whole job. 💅

🌸 SYNOPSIS 🌸

collateindex.pl [-f] [-g] [-i id] [-I scope] [-N]
                [-o file] [-p] [-P file] [-q] [-s name]
                [-S scope] [-t name] [-x] file

🦋 DESCRIPTION 🦋

collateindex.pl creates index data for DocBook XML or SGML files. that's it, that's the vibe. she takes your index data and she makes it happen. ✨

👑 OPTIONS 👑

so many options bestie, but each one is doing her little thing. no skips, no cuts, we go through all of them:

• -f — Force the output file to be written, even if it appears to have been edited by hand. like, she sees that you touched it, and she's choosing to write over it anyway. bold. 😭
• -g — Group terms with IndexDiv based on the first letter of the term (or its SortAs attribute). heads up though: this might not handle all language environments, so don't come for her if your language is built different. 🙈
• -i id — The ID to use for the <index> tag.
• -I scope — The implied scope. must be "all", "local", or "global". IndexTerms which do not specify a scope will have the implied scope. if you don't say anything, "all" is assumed. default queen behavior. 👑
• -N — New index (generates an empty index file). a fresh start, a clean slate, main character energy. ✨
• -o file — Output to file. Defaults to stdout.
• -p — Link to points in the document. the default is to link to the closest containing section, so this one is the switch-up. 🔥
• -P file — Read a preamble from file. the contents of file will be inserted before the <index> tag.
• -q — Run quietly. 🤫
• -s name — Name the IndexDiv that contains symbols. the default is "Symbols". Meaningless if -g is not used. (so don't bother if you didn't bring -g to the party, bestie 💀)
• -S scope — Scope of the index. must be "all", "local", or "global". If unspecified, "all" is assumed.
• -t name — Title for the index.
• -x — Make a SetIndex.
• -V — Print version number and exit. bye bestie, love you. 🫶
• file — The file containing index data generated with the DocBook DSSSL HTML stylesheet (usually called HTML.index). she needs her snack. 🍓

🌈 EXAMPLE 🌈

look at her go:

collateindex.pl -o index.sgml HTML.index

ate. no crumbs. 💅

💀 EXIT STATUS 💀

• 0 — Success 🎉
• 1 — Failure 😭

💜 AUTHOR 💜

Norm Walsh <ndw@nwalsh.com> — the icon, the legend. 👑

Minor updates by Adam Di Carlo <adam@onshore.com> and Peter Eisentraut <peter_e@gmx.net> — the besties who pulled up to help. 🫶

and that's the whole page, bestie!! this one came from docbook-dsssl 1.79, dated 2004-11-04 — yes she's vintage, yes she still slays. mwah 💖✨🎀