xindy [-V?h] [-qv] [-d magic] [-o outfile.ind] [-t log] \ [-L lang] [-C codepage] [-M module] [-I input] \ [--interactive] [--mem-file=xindy.mem] \ [idx0 idx1 ...]
GNU-Style Long Options for Short Options:
-V / --version -? / -h / --help -q / --quiet -v / --verbose -d / --debug (multiple times) -o / --out-file -t / --log-file -L / --language -C / --codepage -M / --module (multiple times) -I / --input-markup (supported: latex, omega, xindy)
Files with the raw index are passed as arguments. If no arguments are passed, the raw index will be read from standard input.
xindy is completely described in its manual that you will find on its Web Site, http://www.xindy.org/. A good introductionary description appears in the indexing chapter of the LaTeX Companion (2nd ed.)
If you want to produce an index for LaTeX documents, the command texindy(1) is probably more of interest for you. It is a wrapper for xindy that turns on many LaTeX conventions by default.
magic remark ------------------------------------------------------------ script internal progress messages of driver scripts keep_tmpfiles don't discard temporary files markup output markup trace, as explained in xindy manual level=n log level, n is 0 (default), 1, 2, or 3
If no input encoding is specified via "--codepage", a xindy module for that language is searched with a latin, a cp, an iso, or ascii encoding, in that order.
When "omega" input markup is used, "utf8" is always used as codepage, this option is then ignored.
"latex" input markup is the one that is emitted by default from the LaTeX kernel, or by the "index" macro package of David Jones. ^^-notation of single byte characters is supported. Usage of LaTeX's inputenc package is assumed as well.
"omega" input markup is like "latex" input markup, but with Omega's ^^-notation as encoding for non-ASCII characters. LaTeX inputenc encoding is not used then, and "utf8" is enforced to be the codepage.
"xindy" input markup is specified in the xindy manual.
Latin scripts
albanian gypsy portuguese croatian hausa romanian czech hungarian russian-iso danish icelandic slovak-small english italian slovak-large esperanto kurdish-bedirxan slovenian estonian kurdish-turkish spanish-modern finnish latin spanish-traditional french latvian swedish general lithuanian turkish german-din lower-sorbian upper-sorbian german-duden norwegian vietnamese greek-iso polish
German recognizes two different sorting schemes to handle umlauts: normally, "a." is sorted like "ae", but in phone books or dictionaries, it is sorted like "a". The first scheme is known as DIN order, the second as Duden order.
"*-iso" language names assume that the raw index entries are in ISO 8859-9 encoding.
"gypsy" is a northern Russian dialect.
Cyrillic scripts
belarusian mongolian serbian bulgarian russian ukrainian macedonian
Other scripts
greek klingon
Available Codepages
This is not yet written. You can look them up in your xindy distribution, in the modules/lang/language/ directory (where language is your language). They are named variant-codepage-lang.xdy, where variant- is most often empty (for german, it's "din5007" and "duden"; for spanish, it's "modern" and "traditional", etc.)
< Describe available codepages for each language > < Describe relevance of codepages (as internal representation) for LaTeX inputenc >
If this environment variable is not set, the default is used: ".:"modules_dir":"modules_dir"/base". modules_dir is determined at run time, relative to the xindy command location: Either it's ../modules, that's the case for opt-installations. Or it's ../lib/xindy/modules, that's the case for usr-installations.
The modules directory may be a subdirectory, too.
For straight-forward usage, when "bbb" is "textbf" or similar, we supply location attribute definitions that mimic MakeIndex's behaviour.
For more complex usage, when "bbb" is not an identifier, no such compatibility definitions exist and may also not been created with current xindy. In particular, this means that by default the LaTeX package "hyperref" will create raw index files that cannot be processed with xindy. This is not a bug, this is the unfortunate result of an intented incompatibility. It is currently not possible to get both hyperref's index links and use xindy.
A similar situation is reported to exist for the "memoir" LaTeX class.
Programmers who know Common Lisp and Lex and want to work on a remedy should please contact the author.
There should be a way to output the final index to stdout. This would imply -q, of course.
LaTeX raw index parsing should be configurable.
Codepage "utf8" should be supported for all languages, and should be used as internal codepage for LaTeX inputenc re-encoding.
xindy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.