INDEXTOOL(1)

💅 INDEXTOOL(1) — bestie edition ✨

okay so you opened the indextool man page from the Sphinxsearch family of programs and honestly? you came to the right place. buckle up 🎀

---

🌸 NAME 🌸

indextool — the Sphinxsearch tool that dumps miscellaneous debug info about the physical index. it's giving "look inside the box" energy 🫶

---

✨ SYNOPSIS ✨

indextool {command} [options]

like, one command minimum, then whatever options you need. periodt 💅

---

🦋 DESCRIPTION 🦋

Sphinx is a whole collection of programs that aim to provide high quality fulltext search. iconic behavior, no cap.

indextool is one of the helper tools inside the Sphinx package 👑. its whole job is to dump miscellaneous debug information about the physical index — like, it reads the index and tells you what's actually in there.

and bestie, the reason it's called indextool and not just indexdump is because besides dumping, it can also do index verification 🔥. so it's not just a talker, it works too.

---

🧚 COMMANDS 🧚

here's the full roster, no skips, no summarising, we respect every single one 💖:

• --dumpheader FILENAME.sph — quickly dumps the index header file you hand it, without touching any other index files or even the configuration file. the report gives you a breakdown of all the index settings, and in particular the entire attribute and field list. prior to 0.9.9-rc2, this command was present in the CLI search utility (throwback fr).
• --dumpconfig FILENAME.sph — dumps the index definition from the given index header file in (almost) compliant sphinx.conf file format. almost. close enough. slay.
• --dumpheader INDEXNAME — dumps the index header by index name, and it looks up the header path in the configuration file for you. convenient ✨
• --dumpdocids INDEXNAME — dumps document IDs by index name. heads up: it takes the data from the attribute (.spa) file, and therefore it requires docinfo=extern to work. no docinfo=extern, no docids, that's the vibe check 😭
• --dumphitlist INDEXNAME KEYWORD — dumps all the hits (occurences) of a given keyword in a given index, with the keyword specified as text.
• --dumphitlist INDEXNAME --wordid ID — same deal, dumps all the hits (occurences) of a given keyword in a given index, except here the keyword is specified as an internal numeric ID.
• --htmlstrip INDEXNAME — filters stdin using the HTML stripper settings for a given index, and prints the filtering results to stdout. 🎀 note that the settings will be taken from sphinx.conf, and not the index header. important distinction, bestie.
• --check INDEXNAME — checks the index data files for consistency errors that might have been introduced either by bugs in indexer and/or hardware faults. like a health check but for your index 🩺
• --strip-path — strips the path names from all the file names referenced from the index (stopwords, wordforms, exceptions, etc). this is useful for checking indexes built on another machine with possibly different path layouts. moving-house energy 🚚
• --optimize-rt-klists — optimizes the kill list memory use in the disk chunk of a given RT index. that is a one-off optimization intended for rather old RT indexes, created by development versions prior to 1.10-beta release.

as of 1.10-beta releases, this kill list optimization (purging) should happen automatically, and there should never be a need to use this option. so like… it's here, but you basically shouldn't need it 🙈

---

💜 OPTIONS 💜

the only currently available option applies to all commands, and it lets you specify the configuration file:

• --config CONFIGFILE, -c CONFIGFILE — overrides the built-in config file names. that's it, that's the whole option list. short and sweet, we love a minimalist queen 👑

---

🌈 AUTHOR 🌈

Andrey Aksenoff (shodan@sphinxsearch.com). this manual page is written by Alexey Vinogradov (klirichek@sphinxsearch.com). permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. go read it if you're curious, we support the reading era 📚

---

⭐ SEE ALSO ⭐

indexer(1), searchd(1), search(1) — the whole friend group 🫶

Sphinx and it's programs are documented fully by the Sphinx reference manual available in /usr/share/doc/sphinxsearch. go check it out, iykyk 💖

---

and that's the page bestie!! this was INDEXTOOL(1) from the 2.2.11-release era, dated 07/19/2016 — a classic, an icon, a legend, and honestly? it ate. now go dump some headers 💅✨🦋