Debian Codegraph @

texmf-dist/doc/man/man1/upmendex.1

raw
1 .TH UPMENDEX 1
2 \"=====================================================================
3 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
4 .if n .ds TX TeX
5 .\" LX definition must follow TX so LX can use TX
6 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
7 .if n .ds LX LaTeX
8 \"=====================================================================
9 .SH NAME
10 upmendex \- Multilingual index processor
11 .SH SYNOPSIS
12 \fBupmendex\fR [-ilqrcgf] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
13 .br
14 \fBupmendex\fR \fB--help\fR
15 .br
16 \fBupmendex\fR \fB--version\fR
17 .SH DESCRIPTION
18 .PP
19 The program \fIupmendex\fR is a general purpose multilingual hierarchical
20 index generator working with up\*(LX, Xe\*(LX and Lua\*(LX;
21 it accepts one or more input files (\fI.idx\fR; often produced by a text
22 formatter such as \*(LX families), sorts the entries, and produces an output file
23 which can be formatted.
24 It supports Latin (including non-English), Greek, Cyrillic, Korean Hangul and
25 Han (Hanzi ideographs) scripts, as well as Japanese Kana.
26 It also experimentally supports Brahmic (Bengali, Devanagari, Gurmukhi,
27 Gujarati, Kannada, Lao, Malayalam, Oriya, Sinhala, Tamil, Telugu, Thai),
28 Arabic and Hebrew scripts.
29 It is almost compatible with \fImakeindex\fR and \fImendex\fR, and
30 additional feature for handling readings of kanji words is also available.
31 .RE
32 The formats of the input and output files are specified in a style file.
33 The readings of kanji words can be specified in a dictionary file.
34 .RE
35 The index can have up to five levels (0, 1, 2, 3, and 4) of subitem nesting.
36 .SH OPTIONS
37 .PP
38 .TP 10
39 \fB-i\fR
40 Take input from stdin, even when index files are specified.
41 .TP 10
42 \fB-l\fR
43 Set \'sort by character order\'. By default, \'sort by word order\' is used.
44 Details are described below.
45 .TP 10
46 \fB-q\fR
47 Quiet mode; send no message to \fIstderr\fR, except error
48 messages and warnings.
49 .TP 10
50 \fB-r\fR
51 Disable implicit page range formation. By default, three or
52 more successive pages are automatically abbreviated as a range
53 (e.g. 1\(en5).
54 .TP 10
55 \fB-c\fR
56 Compress sequence of intermediate blanks (space(s) and/or tab(s)) into a space
57 and ignore leading and trailing blank(s).
58 By default, blanks in the index key are retained.
59 .TP 10
60 \fB-g\fR
61 Make Japanese index head \fIA\fR-line (\fIA, Ka, Sa, ...\fR; 10 characters)
62 of the \fIgojuon\fR table (Japanese syllabary). By default, all 48 characters
63 in the \fIgojuon\fR table are used.
64 .TP 10
65 \fB-f\fR
66 Force to output characters even if the scripts are not supported by \fIupmendex\fR.
67 .TP 10
68 \fB-s\fI sty\fR
69 Employ \fIsty\fR as the style file.
70 .TP 10
71 \fB-d\fI dic\fR
72 Employ \fIdic\fR as the dictionary file. The dictionary file is
73 composed of lists of <\fIindex_word\fR\ \fIreading\fR>.
74 .TP 10
75 \fB-o\fI ind\fR
76 Employ \fIind\fR as the output index file. By default, the file
77 name is created by appending the extension \fIind\fR to the base
78 name of the first input file.
79 .TP 10
80 \fB-t\fI log\fR
81 Employ \fIlog\fR as the transcript file. By default, the file name
82 is created by appending the extension \fIilg\fR to the base name
83 of the first input file.
84 .TP 10
85 \fB-p\fI no\fR
86 Set the starting page number of the output index list to be
87 \fIno\fR. The argument \fIno\fR may be numerical or one of
88 the following: \fIany\fR (the next page to the end of contents), \fIodd\fR
89 (the next odd page to the end of contents), \fIeven\fR (the next even page to the end of contents).
90 .TP 10
91 \fB--help\fR
92 Show summary of options and exit.
93 .TP 10
94 \fB--version\fR
95 Show version information and exit.
96 .TP 10
97 \fB--\fR
98 Arguments after \fB--\fR are not taken as options.
99 This is useful when the input file name starts with '-'.
100
101 .SH "STYLE FILE"
102 The style file informs \fIupmendex\fR about the format of the
103 \fIidx\fR input files and the intended format of the final
104 output file. The format is upper compatible with the one for
105 \fImakeindex\fR and \fImendex\fR.
106 The style file contains a list of
107 <\fIspecifier\fR\ \fIattribute\fR> pairs.
108 There are two types of specifiers: input and output.
109 Pairs do not have to appear in any particular order.
110 A line begun by \'%\' is a comment.
111
112 .PP
113 \fBInput file style parameter\fR
114 .TP 30
115 \fBkeyword\fR <string>
116 "\\\\indexentry"
117 .RS
118 Command with an argument of index entry which is going to be processed.
119 .RE
120 .TP 30
121 \fBarg_open\fR <char>
122 \'{\'
123 .RS
124 Opening delimiter which shows the beginning of index entry.
125 .RE
126 .TP 30
127 \fBarg_close\fR <char>
128 \'}\'
129 .RS
130 Closing delimiter which shows the end of index entry.
131 .RE
132 .TP 30
133 \fBrange_open\fR <char>
134 \'(\'
135 .RS
136 Opening delimiter which shows the beginning of page range.
137 .RE
138 .TP 30
139 \fBrange_close\fR <char>
140 \')\'
141 .RS
142 Closing delimiter which shows the end of page range.
143 .RE
144 .TP 30
145 \fBlevel\fR <char>
146 \'!\'
147 .RS
148 Delimiter which shows lower level.
149 .RE
150 .TP 30
151 \fBactual\fR <char>
152 \'@\'
153 .RS
154 Symbol which shows the next sequence is to appear as index strings
155 in the output file.
156 .RE
157 .TP 30
158 \fBencap\fR <char>
159 \'|\'
160 .RS
161 Symbol which shows the next sequence is to be used as command name
162 attached to the page number.
163 .RE
164 .TP 30
165 \fBpage_compositor\fR <string>
166 "-"
167 .RS
168 Separator between page levels for a style with multi-levels of page numbers.
169 .RE
170 .TP 30
171 \fBpage_precedence\fR <string>
172 "rnaRA"
173 .RS
174 Priority of expression for page number.
175 \'R\' and \'r\' correspond to Roman. \'n\' corresponds to arabic numeral.
176 \'A\' and \'a\' correspond to Latin alphabet.
177 .RE
178 .TP 30
179 \fBquote\fR <char>
180 \'"\'
181 .RS
182 Escape character for \fIupmendex\fR parameters.
183 .RE
184 .TP 30
185 \fBescape\fR <char>
186 \'\\\\\'
187 .RS
188 Escape character for general scripts.
189 .RE
190
191 \fBOutput file style parameter\fR
192 .TP 30
193 \fBpreamble\fR <string>
194 "\\\\begin{theindex}\\n"
195 .RS
196 Preamble of output file.
197 .RE
198 .TP 30
199 \fBpostamble\fR <string>
200 "\\n\\n\\\\end{theindex}\\n"
201 .RS
202 Postamble of output file.
203 .RE
204 .TP 30
205 \fBsetpage_prefix\fR <string>
206 "\\n \\\\setcounter{page}{"
207 .RS
208 Prefix of page number if start page is designated.
209 .RE
210 .TP 30
211 \fBsetpage_suffix\fR <string>
212 "}\\n"
213 .RS
214 Suffix of page number if start page is designated.
215 .RE
216 .TP 30
217 \fBgroup_skip\fR <string>
218 "\\n\\n \\\\indexspace\\n"
219 .RS
220 Strings to insert vertical space before new section of index.
221 .RE
222 .TP 30
223 \fBlethead_prefix\fR <string>
224 ""
225 .RS
226 Prefix of heading for newly appeared heading letter.
227 .RE
228 .TP 30
229 \fBheading_prefix\fR <string>
230 ""
231 .RS
232 Same as \fBlethead_prefix\fR. (compatible with makeindex)
233 .RE
234 .TP 30
235 \fBlethead_suffix\fR <string>
236 ""
237 .RS
238 Suffix of heading for newly appeared heading letter.
239 .RE
240 .TP 30
241 \fBheading_suffix\fR <string>
242 ""
243 .RS
244 Same as \fBlethead_suffix\fR. (compatible with makeindex)
245 .RE
246 .TP 30
247 \fBlethead_flag\fR <number>
248 0
249 .RS
250 Flag to control output of heading letters in Latin, Greek and Cyrillic scripts.
251 \'0\', \'1\', \'-1\' and \'2\' respectively denotes no output, uppercase,
252 lowercase and titlecase.
253 .RE
254 .TP 30
255 \fBheading_flag\fR <number>
256 0
257 .RS
258 Same as \fBlethead_flag\fR. (Note: makeindex uses a different name \fBheadings_flag\fR)
259 .RE
260 .TP 30
261 \fBheadings_flag\fR <number>
262 0
263 .RS
264 Same as \fBlethead_flag\fR. (compatible with makeindex)
265 .RE
266 .TP 30
267 \fBscript_head\fR <string 1> <string 2>
268 "(standard heading characters)"
269 .RS
270 Heading characters of script specified by string 2.
271 One of script names must be specified in the string 1:
272 \'kana\', \'hangul\', \'hanzi\', \'devanagari\', \'bengali\', \'gurmukhi\',
273 \'gujarati\', \'oriya\', \'tamil\', \'telugu\', \'kannada\', \'malayalam\',
274 \'sinhala\', \'thai\', or \'lao\'.
275 (Extended by upmendex)
276 .RE
277 .TP 30
278 \fBkana_head\fR <string>
279 ""
280 .RS
281 Heading characters of Kana specified by a string.
282 By default, it is controlled by \fBletter_head\fR and
283 command line option \fB-g\fR.
284 (Extended by upmendex)
285 .RE
286 .TP 30
287 \fBhangul_head\fR <string>
288 "ㄱㄴㄷㄹㅁㅂㅅㅇㅈㅊㅋㅌㅍㅎ"
289 .RS
290 Heading characters of Hangul specified by a string.
291 (Extended by upmendex)
292 .RE
293 .TP 30
294 \fBhanzi_head\fR <string>
295 ""
296 .RS
297 Heading strings of hanzi (Kanji, Hanja)
298 specified by a string, which is
299 concatenated of items with a separator \';\'.
300 (Extended by upmendex)
301 .RE
302 .TP 30
303 \fBdevanagari_head\fR <string>
304 "ऄअआइईउऊऋऌऍऎएऐऑऒओऔकखगघङचछजझञटठडढणतथदधनपफबभमयरलळवशषसह"
305 .RS
306 Heading characters of Devanagari specified by a string.
307 (Experimental, Extended by upmendex)
308 .RE
309 .TP 30
310 \fBthai_head\fR <string>
311 "กขฃคฅฆงจฉชซฌญฎฏฐฑฒณดตถทธนบปผฝพฟภมยรฤลฦวศษสหฬอฮ"
312 .RS
313 Heading characters of Thai script specified by a string.
314 (Experimental, Extended by upmendex)
315 .RE
316 .TP 30
317 \fBitem_0\fR <string>
318 "\\n \\\\item "
319 .TP 30
320 \fBitem_1\fR <string>
321 "\\n \\\\subitem "
322 .TP 30
323 \fBitem_2\fR <string>
324 "\\n \\\\subsubitem "
325 .TP 30
326 \fBitem_3\fR <string>
327 "\\n \\\\subsubsubitem "
328 .TP 30
329 \fBitem_4\fR <string>
330 "\\n \\\\subsubsubsubitem "
331 .RS
332 Command sequence inserted between two primary, two secondary, etc. level entries.
333 .RE
334 .TP 30
335 \fBitem_01\fR <string>
336 "\\n \\\\subitem "
337 .TP 30
338 \fBitem_12\fR <string>
339 "\\n \\\\subsubitem "
340 .TP 30
341 \fBitem_23\fR <string>
342 "\\n \\\\subsubsubitem "
343 .TP 30
344 \fBitem_34\fR <string>
345 "\\n \\\\subsubsubsubitem "
346 .RS
347 Command sequence inserted between primaly and secondary, secondary and tertiary, etc. level entries.
348 .RE
349 .TP 30
350 \fBitem_x1\fR <string>
351 "\\n \\\\subitem "
352 .TP 30
353 \fBitem_x2\fR <string>
354 "\\n \\\\subsubitem "
355 .TP 30
356 \fBitem_x3\fR <string>
357 "\\n \\\\subsubsubitem "
358 .TP 30
359 \fBitem_x4\fR <string>
360 "\\n \\\\subsubsubsubitem "
361 .RS
362 Command sequence inserted between primary and secondary, secondary and tertiary, etc. level entries
363 when the higher level entry does not have page number.
364 .RE
365 .TP 30
366 \fBdelim_0\fR <string>
367 ", "
368 .TP 30
369 \fBdelim_1\fR <string>
370 ", "
371 .TP 30
372 \fBdelim_2\fR <string>
373 ", "
374 .TP 30
375 \fBdelim_3\fR <string>
376 ", "
377 .TP 30
378 \fBdelim_4\fR <string>
379 ", "
380 .RS
381 Delimiter string between primary, secondary, etc. level entry and first page number.
382 .RE
383 .TP 30
384 \fBdelim_n\fR <string>
385 ", "
386 .RS
387 Delimiter string between page numbers
388 commonly used for any entry level.
389 .RE
390 .TP 30
391 \fBdelim_r\fR <string>
392 "--"
393 .RS
394 Delimiter string between pages to show page range.
395 .RE
396 .TP 30
397 \fBdelim_t\fR <string>
398 ""
399 .RS
400 Delimiter string output at the end of page number list.
401 .RE
402 .TP 30
403 \fBsuffix_2p\fR <string>
404 ""
405 .RS
406 String to be inserted in place of \fBdelim_n\fR and the next page
407 number when the two pages are contiguous.
408 .RE
409 It works only when the parameter is defined.
410 .RE
411 .TP 30
412 \fBsuffix_3p\fR <string>
413 ""
414 .RS
415 String to be inserted in place of \fBdelim_r\fR and the third page
416 number when the three pages are contiguous.
417 The parameter is prior to \fBsuffix_mp\fR.
418 .RE
419 It works only when the parameter is defined.
420 .RE
421 .TP 30
422 \fBsuffix_mp\fR <string>
423 ""
424 .RS
425 String to be inserted in place of \fBdelim_r\fR and the last page
426 number when the three or more pages are contiguous.
427 .RE
428 It works only when the parameter is defined.
429 .RE
430 .TP 30
431 \fBencap_prefix\fR <string>
432 "\\\\"
433 .RS
434 Prefix for an encapsulating command
435 when the encapsulating command is added to the page number.
436 .RE
437 .TP 30
438 \fBencap_infix\fR <string>
439 "{"
440 .RS
441 Prefix just before the page number
442 when the encapsulating command is added to the page number.
443 .RE
444 .TP 30
445 \fBencap_suffix\fR <string>
446 "}".
447 .RS
448 Suffix after the page number
449 when the encapsulating command is added to the page number.
450 .RE
451 .TP 30
452 \fBline_max\fR <number>
453 72
454 .RS
455 Maximum number of one line.
456 If exceed the number, lines are folded.
457 .RE
458 .TP 30
459 \fBindent_space\fR <string>
460 "\t\t"
461 .RS
462 Space for indent which inserted to
463 top of folded line.
464 .RE
465 .TP 30
466 \fBindent_length\fR <number>
467 16
468 .RS
469 Length of space for indent which inserted to top of folded line.
470 .RE
471 .TP 30
472 \fBsymhead_positive\fR <string>
473 "Symbols"
474 .RS
475 Strings to output as heading letter for symbols
476 when lethead_flag or heading_flag or headings_flag is positive number.
477 .RE
478 .TP 30
479 \fBsymhead_negative\fR <string>
480 "symbols"
481 .RS
482 Strings to output as heading letter for symbols
483 when lethead_flag or heading_flag or headings_flag is negative number.
484 .RE
485 .TP 30
486 \fBsymbol\fR <string>
487 ""
488 .RS
489 Strings to output as heading letter for symbols
490 when symbol_flag is non zero.
491 .RE
492 If specified, the option is prior to symhead_positive and symhead_negative.
493 (Extended by (up)mendex)
494 .RE
495 .TP 30
496 \fBnumhead_positive\fR <string>
497 "Numbers"
498 .RS
499 Strings to output as heading letter for numbers
500 when lethead_flag or heading_flag or headings_flag is positive number and symbol_flag is 2.
501 .RE
502 .TP 30
503 \fBnumhead_negative\fR <string>
504 "numbers"
505 .RS
506 Strings to output as heading letter for numbers
507 when lethead_flag or heading_flag or headings_flag is negative number and symbol_flag is 2.
508 .RE
509 .TP 30
510 \fBsymbol_flag\fR <number>
511 1
512 .RS
513 Flag to output of symbol. If \'0\', do not output headings for symbols and numbers.
514 If \'1\', output symbols and numbers as a group of symbols.
515 If \'2\', output symbols and numbers separately.
516 (Extended by (up)mendex)
517 .RE
518 .TP 30
519 \fBletter_head\fR <number>
520 1
521 .RS
522 Flag of heading letter for Japanese Kana.
523 If \'1\' and \'2\', Katakana and Hiragana is used, respectively.
524 (Extended by (up)mendex)
525 .RE
526 .TP 30
527 \fBpriority\fR <number>
528 0
529 .RS
530 Flag of sorting method for index words composed of
531 Japanese and non-Japanese (ex. Latin scripts).
532 If non zero, one space (U+0020) is inserted between
533 Japanese sequence and non-Japanese sequence in sorting procedure.
534 (Extended by (up)mendex)
535 .RE
536 .TP 30
537 \fBcharacter_order\fR <string>
538 "SNLGCJKHDbpgotukmsTlah"
539 .RS
540 Order of scripts and symbols.
541 \'S\', \'N\', \'L\', \'G\', \'C\', \'J\', \'K\', \'H\', \'D\', \'b\', \'p\', \'g\',
542 \'o\', \'t\', \'u\', \'k\', \'m\', \'s\', \'T\', \'l\', \'a\' and \'h\' respectively
543 denotes symbol, number, Latin, Greek, Cyrillic, Japanese Kana, Korean Hangul, Hanzi,
544 Devanagari, Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada, Malayalam,
545 Sinhala, Thai, Lao, Arabic and Hebrew script.
546 \'@\' denotes scripts which are not explicitly designated and the order are
547 configured by icu_rules or icu_locale.
548 Please make sure that \'S\' and \'N\' are next to each other if symbol_flag=1,
549 since numbers are classified as a part of symbol.
550 (Extended by upmendex)
551 .RE
552 .TP 30
553 \fBscript_preamble\fR <string 1> <string 2>
554 ""
555 .RS
556 Preamble of script block in output file, specified by string 2.
557 One of script names must be specified in the string 1:
558 \'latin\', \'cyrillic\', \'greek\', \'kana\', \'hangul\', \'hanzi\',
559 \'devanagari\', \'bengali\', \'gurmukhi\', \'gujarati\', \'oriya\',
560 \'tamil\', \'telugu\', \'kannada\', \'malayalam\', \'sinhala\',
561 \'thai\', \'lao\', \'arabic\', or \'hebrew\'.
562 (Extended by upmendex)
563 .RE
564 .TP 30
565 \fBscript_postamble\fR <string 1> <string 2>
566 ""
567 .RS
568 Postamble of script block in output file, specified by string 2.
569 One of script names must be specified in the string 1:
570 \'latin\', \'cyrillic\', \'greek\', \'kana\', \'hangul\', \'hanzi\',
571 \'devanagari\', \'bengali\', \'gurmukhi\', \'gujarati\', \'oriya\',
572 \'tamil\', \'telugu\', \'kannada\', \'malayalam\', \'sinhala\',
573 \'thai\', \'lao\', \'arabic\', or \'hebrew\'.
574 (Extended by upmendex)
575 .RE
576 .TP 30
577 \fBicu_locale\fR <string>
578 ""
579 .RS
580 Locale in ICU collator.
581 By default, "root sort order" is set.
582 (Extended by upmendex)
583 .RE
584 .TP 30
585 \fBicu_rules\fR <string>
586 ""
587 .RS
588 Customized collation rules in ICU collator.
589 Unicode characters in UTF-8 encoding and following escape sequences are accepted:
590 \fB\\Uhhhhhhhh\fR (8-digit hexadecimal [0-9A-Fa-f]), \fB\\uhhhh\fR (4-digit hexadecimal),
591 \fB\\xhh\fR (2-digit hexadecimal), \fB\\x{h...}\fR (1..8-digit hexadecimal), and
592 \fB\\ooo\fR (3-digit octal [0-7]).
593 If icu_rules and icu_locale are simultaneously specified, collation rules specified
594 by icu_rules are added on collation rules specified by icu_locale.
595 By default, locale is used.
596 (Extended by upmendex)
597 .RE
598 Ref. <https://unicode-org.github.io/icu/userguide/collation/customization/>,
599 <http://www.unicode.org/reports/tr35/tr35-collation.html#Rules>
600 .RE
601 .TP 30
602 \fBicu_attributes\fR <string>
603 ""
604 .RS
605 Attributes in ICU collator.
606 Followings are available:
607 "alternate:shifted", "alternate:non-ignorable",
608 "strength:primary", "strength:secondary", "strength:tertiary",
609 "strength:quaternary", "strength:identical",
610 "french-collation:on", "french-collation:off",
611 "case-first:off", "case-first:upper-first", "case-first:lower-first",
612 "case-level:on", "case-level:off",
613 "normalization-mode:on", "normalization-mode:off",
614 "numeric-ordering:on", "numeric-ordering:off"
615 (Extended by upmendex)
616 .RE
617 Ref. <https://unicode-org.github.io/icu/userguide/collation/customization/#default-options>,
618 <http://www.unicode.org/reports/tr35/tr35-collation.html#Setting_Options>
619 .RE
620 .PP
621 .SH ABOUT JAPANESE PROCESSING
622 .PP
623 \fIupmendex\fR has an additional feature to simplify the procedure of handling
624 Japanese indexes, compared to \fImakeindex\fR. Users can save the effort
625 of manually specifying a reading for every kanji word.
626 .RE
627 Japanese kanji words are usually sorted by the syllables of their readings
628 (\fI\'Yomi\'\fR), which can be represented by kana (Hiragana, Katakana) scripts.
629 \fIupmendex\fR accepts index words specified in kana expression directly on
630 an input file, and also accepts conversion from index words in Kanji or symbols
631 to phonogram scripts by referring to Japanese dictionaries.
632 .RE
633
634 .LP
635 Examples of internal simplification of syllables are shown below.
636 .PP
637 .RS
638 .br
639 かぶしきがいしゃ かふしきかいしや
640 .br
641 マッキントッシュ まつきんとつしゆ
642 .br
643 ワープロ わあふろ
644 .RE
645 .LP
646 The dictionary file consists of list with <\'index_word\' \'reading\'>.
647 The index word can be written in any scripts (kanji, kana, etc),
648 and the reading can be in any phonograms such as Hiragana or Katakana scripts.
649 The delimiter between the index word and its reading is one or more tab(s) or space(s).
650 .RE
651 An example of a Japanese dictionary is shown below.
652 .PP
653 .RS
654 .br
655 漢字 かんじ
656 .br
657 読み よみ
658 .br
659 環境 かんきょう
660 .br
661 $ ドル
662 .RE
663 .LP
664 Here, each index word is allowed to have only one Yomi.
665 Though some kanji words (ex. 「表」) may have more than one Yomi\'s
666 (ex. 「ひょう」 and 「おもて」), only one of them can be registered in the dictionary.
667 When some different Yomi\'s are needed, they should be specified explicitly
668 in kana expression (ex. \\index{ひょう@表} or \\index{おもて@表}) on the input file.
669 .RE
670 Moreover, a dictionary file is automatically referred
671 by setting the file name at an environment variable \fIINDEXDEFAULTDICTIONARY\fR.
672 The dictionary set by the environment variable can be used
673 together with file(s) specified by \fI-d\fR option.
674 .PP
675 .SH ABOUT SORTING PROCEDURE
676 .PP
677 \fIupmendex\fR sorts indexes as is (\'sort by word order\') by default.
678 Setting \fI-l\fR option, spaces between words in an index are truncated prior to
679 sorting procedure (\'sort by character order\').
680 .RE
681 Even when sort by character order, the index at output remains the original sequence
682 without the truncation.
683 .RE
684 Follows show an example.
685 .PP
686 .RS
687 \fIsort by word order sort by character order\fR
688 .br
689 X Window Xlib
690 .br
691 Xlib XView
692 .br
693 XView X Window
694 .RE
695 .LP
696 In addition, two sorting methods can be applied for indexes
697 which contains both Japanese kana and other scripts (e.g. Latin script).
698 By setting \fIpriority\fR 0 (default) and 1 at a style file,
699 a space between Japanese Kana and other scripts is inserted and
700 not inserted respectively, prior to the sorting procedure.
701 .RE
702 Follows show an example.
703 .PP
704 .RS
705 \fIpriority=0 priority=1\fR
706 .br
707 index sort indファイル
708 .br
709 indファイル index sort
710 .RE
711 .PP
712 .SH ENVIRONMENT VARIABLES
713 \fIupmendex\fR refers environment variables as follows.
714 .PP
715 .TP 10
716 \fIINDEXSTYLE\fR
717 Directory where index style files exist.
718 .TP 10
719 \fIINDEXDEFAULTSTYLE\fR
720 Index style file to be referred to as default.
721 .TP 10
722 \fIINDEXDICTIONARY\fR
723 Directory where dictionary files exist.
724 .TP 10
725 \fIINDEXDEFAULTDICTIONARY\fR
726 Dictionary file which is automatically read.
727 .PP
728 .SH DETAIL
729 Detailed specification is compatible with \fImakeindex\fR.
730 .PP
731 .SH KNOWN ISSUES
732 When plural page number expression is used, \fI.idx\fR files should be
733 specified along with the order of page numbers. Otherwise,
734 wrong page numbers might be output.
735 .PP
736 .SH "SEE ALSO"
737 .BR tex(1),
738 .BR latex(1),
739 .BR makeindex(1),
740 .BR mendex(1).
741 .br
742 International Components for Unicode (ICU):
743 <http://icu.unicode.org/>,
744 <https://unicode-org.github.io/icu/>
745 .SH AUTHOR
746 This manual page was written by Takuji Tanaka
747 based on the mendex manual page written by Japanese \*(TX Development Community.