summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/texindy.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/texindy.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/texindy.188
1 files changed, 52 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/man/man1/texindy.1 b/Master/texmf-dist/doc/man/man1/texindy.1
index d1b4417af93..b873d713b74 100644
--- a/Master/texmf-dist/doc/man/man1/texindy.1
+++ b/Master/texmf-dist/doc/man/man1/texindy.1
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.04)
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
@@ -53,7 +45,7 @@
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
@@ -132,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "texindy 1"
-.TH texindy 1 "2010-05-10" "Version 1.11" "xindy"
+.TH texindy 1 "2014-04-19" "Release 2.5" "texindy"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -145,7 +137,7 @@ texindy \- create sorted and tagged index from raw LaTeX index
\& texindy [\-V?h] [\-qv] [\-iglr] [\-d magic] [\-o outfile.ind] [\-t log] \e
\& [\-L lang] [\-C codepage] [\-M module] [idx0 idx1 ...]
.Ve
-.Sh "GNU-Style Long Options for Short Options:"
+.SS "GNU-Style Long Options for Short Options:"
.IX Subsection "GNU-Style Long Options for Short Options:"
.Vb 10
\& \-V / \-\-version
@@ -174,6 +166,9 @@ by xindy modules, with a convenient set already preloaded.
Files with the raw index are passed as arguments. If no arguments are
passed, the raw index will be read from standard input.
.PP
+\&\fBDo not use texindy with XeLaTeX or LuaLaTeX!\fR When you use these
+LaTeX engines, you must use \fBxindy \-C utf8 \-M texindy \-M page-ranges\fR instead.
+.PP
A good introductionary description of \fBtexindy\fR appears in the
indexing chapter of the LaTeX Companion (2nd ed.)
.PP
@@ -182,28 +177,26 @@ markup, the command \fIxindy\fR\|(1) is probably more of interest for you.
.PP
\&\fBtexindy\fR is an approach to merge support for the \fImake-rules\fR
framework, own xindy modules (e.g., for special LaTeX commands in the
-index), and a reasonable level of MakeIndex compatibility. There are
-other older approaches, eventually they will get a description on the
-xindy Web Site, http://www.xindy.org/.
+index), and a reasonable level of MakeIndex compatibility.
.SH "OPTIONS"
.IX Header "OPTIONS"
-.ie n .IP """\-\-version""\fR / \fB\-V" 4
+.ie n .IP """\-\-version"" / \fB\-V\fR" 4
.el .IP "\f(CW\-\-version\fR / \fB\-V\fR" 4
.IX Item "--version / -V"
output version numbers of all relevant components and exit.
-.ie n .IP """\-\-help""\fR / \fB\-h\fR / \fB\-?" 4
+.ie n .IP """\-\-help"" / \fB\-h\fR / \fB\-?\fR" 4
.el .IP "\f(CW\-\-help\fR / \fB\-h\fR / \fB\-?\fR" 4
.IX Item "--help / -h / -?"
output usage message with options explanation.
-.ie n .IP """\-\-quiet""\fR / \fB\-q" 4
+.ie n .IP """\-\-quiet"" / \fB\-q\fR" 4
.el .IP "\f(CW\-\-quiet\fR / \fB\-q\fR" 4
.IX Item "--quiet / -q"
Don't output progress messages. Output only error messages.
-.ie n .IP """\-\-verbose""\fR / \fB\-v" 4
+.ie n .IP """\-\-verbose"" / \fB\-v\fR" 4
.el .IP "\f(CW\-\-verbose\fR / \fB\-v\fR" 4
.IX Item "--verbose / -v"
Output verbose progress messages.
-.ie n .IP """\-\-debug""\fR \fImagic\fR / \fB\-d\fR \fImagic" 4
+.ie n .IP """\-\-debug"" \fImagic\fR / \fB\-d\fR \fImagic\fR" 4
.el .IP "\f(CW\-\-debug\fR \fImagic\fR / \fB\-d\fR \fImagic\fR" 4
.IX Item "--debug magic / -d magic"
Output debug messages, this option may be specified multiple times.
@@ -217,20 +210,20 @@ Output debug messages, this option may be specified multiple times.
\& markup output markup trace, as explained in xindy manual
\& level=n log level, n is 0 (default), 1, 2, or 3
.Ve
-.ie n .IP """\-\-out\-file""\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind" 4
+.ie n .IP """\-\-out\-file"" \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind\fR" 4
.el .IP "\f(CW\-\-out\-file\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind\fR" 4
.IX Item "--out-file outfile.ind / -o outfile.ind"
Output index to file \fIoutfile.ind\fR. If this option is not passed, the
name of the output file is the base name of the first argument and the
file extension \fIind\fR. If the raw index is read from standard input,
this option is mandatory.
-.ie n .IP """\-\-log\-file""\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg" 4
+.ie n .IP """\-\-log\-file"" \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg\fR" 4
.el .IP "\f(CW\-\-log\-file\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg\fR" 4
.IX Item "--log-file log.ilg / -t log.ilg"
Output log messages to file \fIlog.ilg\fR. These log messages are
independent from the progress messages that you can influence with
\&\f(CW\*(C`\-\-debug\*(C'\fR or \f(CW\*(C`\-\-verbose\*(C'\fR.
-.ie n .IP """\-\-language""\fR \fIlang\fR / \fB\-L\fR \fIlang" 4
+.ie n .IP """\-\-language"" \fIlang\fR / \fB\-L\fR \fIlang\fR" 4
.el .IP "\f(CW\-\-language\fR \fIlang\fR / \fB\-L\fR \fIlang\fR" 4
.IX Item "--language lang / -L lang"
The index is sorted according to the rules of language \fIlang\fR. These
@@ -239,23 +232,32 @@ rules are encoded in a xindy module created by \fImake-rules\fR.
If no input encoding is specified via \f(CW\*(C`\-\-codepage\*(C'\fR, a xindy module
for that language is searched with a latin, a cp, an iso, or ascii
encoding, in that order.
-.ie n .IP """\-\-codepage""\fR \fIenc\fR / B <\-C> \fIenc" 4
+.ie n .IP """\-\-codepage"" \fIenc\fR / B <\-C> \fIenc\fR" 4
.el .IP "\f(CW\-\-codepage\fR \fIenc\fR / B <\-C> \fIenc\fR" 4
.IX Item "--codepage enc / B <-C> enc"
-The raw input is in input encoding \fIenc\fR. This information is used to
-select the correct xindy sort module and also the \fIinputenc\fR target
-encoding for \f(CW\*(C`latex\*(C'\fR input markup.
+\&\fBtexindy\fR's raw input is always assumed to be encoded in LaTeX
+Internal Character Representation (\s-1LICR\s0). I.e., non-ASCII characters
+are encoded as command sequences. This option tells xindy the encoding
+it shall use internally for sorting.
+.Sp
+Effectively, you need this option to specify the encoding of letter
+group headings.
+.Sp
+Encoding \f(CW\*(C`utf8\*(C'\fR is only supported for Latin alphabets. But if you use
+non-Latin alphabets, you probably use XeLaTeX or LuaLaTeX and then you
+must not use \fBtexindy\fR anyhow. Then direct usage of \fBxindy\fR is
+appropriate.
.Sp
When \f(CW\*(C`omega\*(C'\fR input markup is used, \f(CW\*(C`utf8\*(C'\fR is always used as the sort
codepage and no inputenc module is loaded. Then this option is
ignored.
-.ie n .IP """\-\-module""\fR \fImodule\fR / \fB\-M\fR \fImodule" 4
+.ie n .IP """\-\-module"" \fImodule\fR / \fB\-M\fR \fImodule\fR" 4
.el .IP "\f(CW\-\-module\fR \fImodule\fR / \fB\-M\fR \fImodule\fR" 4
.IX Item "--module module / -M module"
Load the xindy module \fImodule.xdy\fR. This option may be specified
multiple times. The modules are searched in the xindy search path that
can be changed with the environment variable \f(CW\*(C`XINDY_SEARCHPATH\*(C'\fR.
-.ie n .IP """\-\-input\-markup""\fR \fIinput\fR / \fB\-I\fR \fIinput" 4
+.ie n .IP """\-\-input\-markup"" \fIinput\fR / \fB\-I\fR \fIinput\fR" 4
.el .IP "\f(CW\-\-input\-markup\fR \fIinput\fR / \fB\-I\fR \fIinput\fR" 4
.IX Item "--input-markup input / -I input"
Specifies the input markup of the raw index. Supported values for
@@ -273,7 +275,7 @@ for sorting.
.SH "SUPPORTED LANGUAGES / CODEPAGES"
.IX Header "SUPPORTED LANGUAGES / CODEPAGES"
The following languages are supported:
-.Sh "Latin scripts"
+.SS "Latin scripts"
.IX Subsection "Latin scripts"
.Vb 10
\& albanian gypsy portuguese
@@ -300,19 +302,19 @@ dictionaries, it is sorted like \f(CW\*(C`a\*(C'\fR. The first scheme is known a
8859\-9 encoding.
.PP
\&\f(CW\*(C`gypsy\*(C'\fR is a northern Russian dialect.
-.Sh "Cyrillic scripts"
+.SS "Cyrillic scripts"
.IX Subsection "Cyrillic scripts"
.Vb 3
\& belarusian mongolian serbian
\& bulgarian russian ukrainian
\& macedonian
.Ve
-.Sh "Other scripts"
+.SS "Other scripts"
.IX Subsection "Other scripts"
.Vb 1
\& greek klingon
.Ve
-.Sh "Available Codepages"
+.SS "Available Codepages"
.IX Subsection "Available Codepages"
This is not yet written. You can look them up in your xindy
distribution, in the \fImodules/lang/language/\fR directory (where
@@ -338,7 +340,7 @@ specific effect.
.Vb 1
\& xindy Module Category Description
.Ve
-.Sh "Sorting"
+.SS "Sorting"
.IX Subsection "Sorting"
.Vb 10
\& word\-order Default A space comes before any letter in the
@@ -357,7 +359,7 @@ specific effect.
\& numeric\-sort Auto Numbers are sorted numerically, not like
\& characters: \`\`V64\*(Aq\*(Aq appears before \`\`V128\*(Aq\*(Aq.
.Ve
-.Sh "Page Numbers"
+.SS "Page Numbers"
.IX Subsection "Page Numbers"
.Vb 10
\& page\-ranges Default Appearances on more than two consecutive
@@ -371,7 +373,7 @@ specific effect.
\& scheme correctly \-\- Roman numerals first, then
\& Arabic numbers, then others: i, 1, A.
.Ve
-.Sh "Markup and Layout"
+.SS "Markup and Layout"
.IX Subsection "Markup and Layout"
.Vb 10
\& tex Auto Handles basic TeX conventions.
@@ -419,6 +421,20 @@ class.
Programmers who know Common Lisp and Lex and want to work on a remedy
should please contact the author.
.IP "\(bu" 4
+If you have an index rage and a location attribute, e.g.,
+\&\f(CW\*(C`\eindex{key\e(attr}\*(C'\fR starts the range, one needs (1) to specify that
+attribute in the range closing entry as well (i.e., as
+\&\f(CW\*(C`\eindex{key\e)attr}\*(C'\fR) and (2) one needs to declare the index attribute
+in an \fBxindy\fR style file.
+.Sp
+MakeIndex will output the markup \f(CW\*(C`\eattr{page1\-\-page2}\*(C'\fR for such a
+construct. This is not possible to achieve in \fBxindy\fR, output will be
+\&\f(CW\*(C`\eattrMarkup{page1}\-\-\eattrMarkup{page2}\*(C'\fR. (This is actually
+considered a bug, but not a high priority one.)
+.Sp
+The difference between MakeIndex page number tags and \fBxindy\fR
+location attributes was already explained in the previous item.
+.IP "\(bu" 4
The MakeIndex compatibility definitions support only the default raw
index syntax and markup definition. It is not possible to configure
raw index parsing or use a MakeIndex style file to describe output