1tex2xindy(1)                         xindy                        tex2xindy(1)
2
3
4

NAME

6       tex2xindy - a preprocessor of the xindy index processor
7

SYNOPSIS

9        tex2xindy [-o] [attr_file]
10

DESCRIPTION

12       tex2xindy transforms a LaTeX index file ".idx" (or an ".aux" file) into
13       a xindy raw index file.
14
15       It is a filter that reads from stdin a file in the input format of
16       LaTeX's raw index file, i.e., with "\indexentry" tags. It outputs on
17       stdout a xindy raw index file, i.e., with "indexentry" clauses.
18
19       If the option -o is not specified, tex2xindy handles ^^-notation of TeX
20       and outputs the octet that is represented: "^^ab" in the input gets
21       output as the octet 0xab. If "^^^^abcd" or "^^^^^^^^abcdefab" are
22       detected, they are output as is.
23
24       If the option -o is specified, tex2xindy operates in Omega mode and
25       handles its ^^-notation: Then "^^ab", "^^^^abcd", and
26       "^^^^^^^^abcdefab" represent Unicode characters with code points 0xab,
27       0xabcd, and 0xabcdefab respectively. They are output in UTF-8 encoding.
28
29       If the optional argument attr_file is specified, tex2xindy writes all
30       index key attributes into this file.
31

DEFICITS

33       This program was written since it was not easily possible to extract
34       the parser from the old makeindex system. Therefore it does not find
35       all errors in the input as the makeindex(1) version.
36
37       Additionally it uses only the default input specifiers of makeindex(1).
38       If other input specifiers (cf. manual page of makeindex(1)) are needed,
39       the input specifiers (starting from the pattern "KEYWORD", see below)
40       must be changed and the program must be recompiled.
41
42       The particular missing feature is configuration of the quote and the
43       actual characters, maybe also the escape, subitem (level), and encap
44       characters. Argument and range delimiters seem to be less of a problem.
45
46       In fact, input markup handling (and thus tex2xindy) should be
47       incorporated into the xindy kernel, to be able to specify configuration
48       in xindy style files.
49

SEE ALSO

51       texindy(1), xindy(1), makeindex(1)
52

AUTHOR

54       Roger Kehr, Institut fuer Theoretische Informatik, TU Darmstadt
55

57       Copyright (c) 1996,1997 Roger Kehr.  Copyright (c) 2006 Joachim Schrod.
58
59       This program is free software; you can redistribute it and/or modify it
60       under the terms of the GNU General Public License as published by the
61       Free Software Foundation; either version 2 of the License, or (at your
62       option) any later version.
63
64       This program is distributed in the hope that it will be useful, but
65       WITHOUT ANY WARRANTY; without even the implied warranty of
66       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
67       General Public License for more details.
68
69       You should have received a copy of the GNU General Public License along
70       with this program; if not, write to the Free Software Foundation, Inc.,
71       675 Mass Ave, Cambridge, MA 02139, USA.
72
73
74
75Version 1.24                      2010-05-10                      tex2xindy(1)
Impressum