1INDEXTOOL(1) Sphinxsearch INDEXTOOL(1)
2
6 indextool - Sphinxsearch tool dump miscellaneous debug information
7 about the physical index.
8
10 indextool {command} [options]
11
13 Sphinx is a collection of programs that aim to provide high quality
14 fulltext search.
15 indextool is one of the helper tools within the Sphinx package. It is
17 used to dump miscellaneous debug information about the physical index.
18 Apart ghe dumping indextool can perform index verification, hence the
19 indextool name rather than just indexdump.
20
22 The commands are as follows:
23 --dumpheader FILENAME.sph
25 quickly dumps the provided index header file without touching any
26 other index files or even the configuration file. The report
27 provides a breakdown of all the index settings, in particular the
28 entire attribute and field list. Prior to 0.9.9-rc2, this command
29 was present in CLI search utility.
30 --dumpconfig FILENAME.sph
32 dumps the index definition from the given index header file in
33 (almost) compliant sphinx.conf file format.
34 --dumpheader INDEXNAME
36 dumps index header by index name with looking up the header path in
37 the configuration file.
38 --dumpdocids INDEXNAME
40 dumps document IDs by index name. It takes the data from attribute
41 (.spa) file and therefore requires docinfo=extern to work.
42 --dumphitlist INDEXNAME KEYWORD
44 dumps all the hits (occurences) of a given keyword in a given
45 index, with keyword specified as text.
46 --dumphitlist INDEXNAME --wordid ID
48 dumps all the hits (occurences) of a given keyword in a given
49 index, with keyword specified as internal numeric ID.
50 --htmlstrip INDEXNAME
52 filters stdin using HTML stripper settings for a given index, and
53 prints the filtering results to stdout. Note that the settings will
54 be taken from sphinx.conf, and not the index header.
55 --check INDEXNAME
57 checks the index data files for consistency errors that might be
58 introduced either by bugs in indexer and/or hardware faults.
59 --strip-path
61 strips the path names from all the file names referenced from the
62 index (stopwords, wordforms, exceptions, etc). This is useful for
63 checking indexes built on another machine with possibly different
64 path layouts.
65 --optimize-rt-klists
67 optimizes the kill list memory use in the disk chunk of a given RT
68 index. That is a one-off optimization intended for rather old RT
69 indexes, created by development versions prior to 1.10-beta
70 release. As of 1.10-beta releases, this kill list optimization
71 (purging) should happen automatically, and there should never be a
72 need to use this option.
73
75 The only currently available option applies to all commands and lets
76 you specify the configuration file:
77 --config CONFIGFILE, -c CONFIGFILE
79 overrides the built-in config file names.
80
82 Andrey Aksenoff (shodan@sphinxsearch.com). This manual page is written
83 by Alexey Vinogradov (klirichek@sphinxsearch.com). Permission is
84 granted to copy, distribute and/or modify this document under the terms
85 of the GNU General Public License, Version 2 any later version
86 published by the Free Software Foundation.
87 On Debian systems, the complete text of the GNU General Public License
89 can be found in /usr/share/common-licenses/GPL.
90
92 indexer(1), searchd(1), search(1)
93 Sphinx and it's programs are documented fully by the Sphinx reference
95 manual available in /usr/share/doc/sphinxsearch.
962.2.11-release 07/19/2016 INDEXTOOL(1)