diff options
Diffstat (limited to 'Build/source/utils/xindy/xindy-2.4/user-commands/texindy.1')
| -rw-r--r-- | Build/source/utils/xindy/xindy-2.4/user-commands/texindy.1 | 446 |
1 files changed, 446 insertions, 0 deletions
diff --git a/Build/source/utils/xindy/xindy-2.4/user-commands/texindy.1 b/Build/source/utils/xindy/xindy-2.4/user-commands/texindy.1 new file mode 100644 index 00000000000..d1b4417af93 --- /dev/null +++ b/Build/source/utils/xindy/xindy-2.4/user-commands/texindy.1 @@ -0,0 +1,446 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.04) +.\" +.\" 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 +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.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 +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "texindy 1" +.TH texindy 1 "2010-05-10" "Version 1.11" "xindy" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +texindy \- create sorted and tagged index from raw LaTeX index +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 2 +\& 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:" +.IX Subsection "GNU-Style Long Options for Short Options:" +.Vb 10 +\& \-V / \-\-version +\& \-? / \-h / \-\-help +\& \-q / \-\-quiet +\& \-v / \-\-verbose +\& \-i / \-\-stdin +\& \-g / \-\-german +\& \-l / \-\-letter\-ordering +\& \-r / \-\-no\-ranges +\& \-d / \-\-debug (multiple times) +\& \-o / \-\-out\-file +\& \-t / \-\-log\-file +\& \-L / \-\-language +\& \-C / \-\-codepage +\& \-M / \-\-module (multiple times) +\& \-I / \-\-input\-markup (supported: latex, omega) +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtexindy\fR is the LaTeX-specific command of xindy, the flexible +indexing system. It takes a raw index as input, and produces a merged, +sorted and tagged index. Merging, sorting, and tagging is controlled +by xindy modules, with a convenient set already preloaded. +.PP +Files with the raw index are passed as arguments. If no arguments are +passed, the raw index will be read from standard input. +.PP +A good introductionary description of \fBtexindy\fR appears in the +indexing chapter of the LaTeX Companion (2nd ed.) +.PP +If you want to produce an index for LaTeX documents with special index +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/. +.SH "OPTIONS" +.IX Header "OPTIONS" +.ie n .IP """\-\-version""\fR / \fB\-V" 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 +.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 +.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 +.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 +.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. +\&\fImagic\fR determines what is output: +.Sp +.Vb 6 +\& magic remark +\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +\& script internal progress messages of driver scripts +\& keep_tmpfiles don\*(Aqt discard temporary files +\& 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 +.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 +.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 +.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 +rules are encoded in a xindy module created by \fImake-rules\fR. +.Sp +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 +.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. +.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 +.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 +.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 +\&\fIinput\fR are \f(CW\*(C`latex\*(C'\fR and \f(CW\*(C`omega\*(C'\fR. +.Sp +\&\f(CW\*(C`latex\*(C'\fR input markup is the one that is emitted by default from the +LaTeX kernel, or by the \f(CW\*(C`index\*(C'\fR macro package of David Jones. +^^\-notation of single byte characters is supported. Usage of LaTeX's +\&\fIinputenc\fR package is assumed as well. +.Sp +\&\f(CW\*(C`omega\*(C'\fR input markup is like \f(CW\*(C`latex\*(C'\fR input markup, but with Omega's +^^\-notation as encoding for non-ASCII characters. LaTeX \fIinputenc\fR +encoding is not used then, and \f(CW\*(C`utf8\*(C'\fR is enforced to be the codepage +for sorting. +.SH "SUPPORTED LANGUAGES / CODEPAGES" +.IX Header "SUPPORTED LANGUAGES / CODEPAGES" +The following languages are supported: +.Sh "Latin scripts" +.IX Subsection "Latin scripts" +.Vb 10 +\& 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 +.Ve +.PP +German recognizes two different sorting schemes to handle umlauts: +normally, \f(CW\*(C`a\*:\*(C'\fR is sorted like \f(CW\*(C`ae\*(C'\fR, but in phone books or +dictionaries, it is sorted like \f(CW\*(C`a\*(C'\fR. The first scheme is known as +\&\fI\s-1DIN\s0 order\fR, the second as \fIDuden order\fR. +.PP +\&\f(CW\*(C`*\-iso\*(C'\fR language names assume that the raw index entries are in \s-1ISO\s0 +8859\-9 encoding. +.PP +\&\f(CW\*(C`gypsy\*(C'\fR is a northern Russian dialect. +.Sh "Cyrillic scripts" +.IX Subsection "Cyrillic scripts" +.Vb 3 +\& belarusian mongolian serbian +\& bulgarian russian ukrainian +\& macedonian +.Ve +.Sh "Other scripts" +.IX Subsection "Other scripts" +.Vb 1 +\& greek klingon +.Ve +.Sh "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 +\&\fIlanguage\fR is your language). They are named +\&\fIvariant\-codepage\-lang.xdy\fR, where \fIvariant\-\fR is most often empty +(for german, it's \f(CW\*(C`din5007\*(C'\fR and \f(CW\*(C`duden\*(C'\fR; for spanish, it's \f(CW\*(C`modern\*(C'\fR +and \f(CW\*(C`traditional\*(C'\fR, etc.) +.PP +.Vb 1 +\& < Describe available codepages for each language > +\& +\& < Describe relevance of codepages (as internal representation) for +\& LaTeX inputenc > +.Ve +.SH "TEXINDY STANDARD MODULES" +.IX Header "TEXINDY STANDARD MODULES" +There is a set of \fBtexindy\fR standard modules that help to process +LaTeX index files. Some of them are automatically loaded. Some of them +are loaded by default, this can be turned off with a \fBtexindy\fR +option. Others may be specified as \f(CW\*(C`\-\-module\*(C'\fR argument to achieve a +specific effect. +.PP +.Vb 1 +\& xindy Module Category Description +.Ve +.Sh "Sorting" +.IX Subsection "Sorting" +.Vb 10 +\& word\-order Default A space comes before any letter in the +\& alphabet: \`\`index style\*(Aq\*(Aq is listed before +\& \`\`indexing\*(Aq\*(Aq. Turn it off with option \-l. +\& letter\-order Add\-on Spaces are ignored: \`\`index style\*(Aq\*(Aq +\& is sorted after \`\`indexing\*(Aq\*(Aq. +\& keep\-blanks Add\-on Leading and trailing white space (blanks +\& and tabs) are not ignored; intermediate +\& white space is not changed. +\& ignore\-hyphen Add\-on Hyphens are ignored: +\& \`\`ad\-hoc\*(Aq\*(Aq is sorted as \`\`adhoc\*(Aq\*(Aq. +\& ignore\-punctuation Add\-on All kinds of punctuation characters are +\& ignored: hyphens, periods, commas, slashes, +\& parentheses, and so on. +\& numeric\-sort Auto Numbers are sorted numerically, not like +\& characters: \`\`V64\*(Aq\*(Aq appears before \`\`V128\*(Aq\*(Aq. +.Ve +.Sh "Page Numbers" +.IX Subsection "Page Numbers" +.Vb 10 +\& page\-ranges Default Appearances on more than two consecutive +\& pages are listed as a range: \`\`1\-\-4\*(Aq\*(Aq. +\& Turn it off with option \-r. +\& ff\-ranges Add\-on Uses implicit \`\`ff\*(Aq\*(Aq notation for ranges +\& of three pages, and explicit ranges +\& thereafter: 2f, 2ff, 2\-\-6. +\& ff\-ranges\-only Add\-on Uses only implicit ranges: 2f, 2ff. +\& book\-order Add\-on Sorts page numbers with common book numbering +\& scheme correctly \-\- Roman numerals first, then +\& Arabic numbers, then others: i, 1, A. +.Ve +.Sh "Markup and Layout" +.IX Subsection "Markup and Layout" +.Vb 10 +\& tex Auto Handles basic TeX conventions. +\& latex\-loc\-fmts Auto Provides LaTeX formatting commands +\& for page number encapsulation. +\& latex Auto Handles LaTeX conventions, both in raw +\& index entries and output markup; implies +\& tex. +\& makeindex Auto Emulates the default MakeIndex input syntax +\& and quoting behavior. +\& latin\-lettergroups Auto Layout contains a single Latin letter +\& above each group of words starting with the +\& same letter. +\& german\-sty Add\-on Handles umlaut markup of babel\*(Aqs german +\& and ngerman options. +.Ve +.SH "COMPATIBILITY TO MAKEINDEX" +.IX Header "COMPATIBILITY TO MAKEINDEX" +\&\fBxindy\fR does not claim to be completely compatible with MakeIndex, +that would prevent some of its enhancements. That said, we strive to +deliver as much compatibility as possible. The most important +incompatibilities are +.IP "\(bu" 4 +For raw index entries in LaTeX syntax, \f(CW\*(C`\eindex{aaa|bbb}\*(C'\fR is +interpreted differently. For MakeIndex \f(CW\*(C`bbb\*(C'\fR is markup that is output +as a LaTeX tag for this page number. For \fBxindy\fR, this is a location +attribute, an abstract identifier that will be later associated with +markup that should be output for that attribute. +.Sp +For straight-forward usage, when \f(CW\*(C`bbb\*(C'\fR is \f(CW\*(C`textbf\*(C'\fR or similar, we +supply location attribute definitions that mimic MakeIndex's +behaviour. +.Sp +For more complex usage, when \f(CW\*(C`bbb\*(C'\fR is not an identifier, no such +compatibility definitions exist and may also not been created with +current \fBxindy\fR. In particular, this means that by default the LaTeX +package \f(CW\*(C`hyperref\*(C'\fR will create raw index files that cannot be +processed with \fBxindy\fR. 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 \fBxindy\fR. +.Sp +A similar situation is reported to exist for the \f(CW\*(C`memoir\*(C'\fR LaTeX +class. +.Sp +Programmers who know Common Lisp and Lex and want to work on a remedy +should please contact the author. +.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 +markup. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +.ie n .IP """TEXINDY_AUTO_MODULE""" 4 +.el .IP "\f(CWTEXINDY_AUTO_MODULE\fR" 4 +.IX Item "TEXINDY_AUTO_MODULE" +This is the name of the xindy module that loads all auto-loaded +modules. The default is \f(CW\*(C`texindy\*(C'\fR. +.SH "AUTHOR" +.IX Header "AUTHOR" +Joachim Schrod +.SH "LEGALESE" +.IX Header "LEGALESE" +\&\fBtexindy\fR is free software; you can redistribute it and/or modify it +under the terms of the \s-1GNU\s0 General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the +\&\s-1GNU\s0 General Public License for more details. |