summaryrefslogtreecommitdiff
path: root/indexing/upmendex/man/upmendex.1
diff options
context:
space:
mode:
Diffstat (limited to 'indexing/upmendex/man/upmendex.1')
-rw-r--r--indexing/upmendex/man/upmendex.199
1 files changed, 71 insertions, 28 deletions
diff --git a/indexing/upmendex/man/upmendex.1 b/indexing/upmendex/man/upmendex.1
index b46ab922de..21c89844fa 100644
--- a/indexing/upmendex/man/upmendex.1
+++ b/indexing/upmendex/man/upmendex.1
@@ -53,9 +53,9 @@ and ignore leading and trailing blank(s).
By default, blanks in the index key are retained.
.TP 10
\fB-g\fR
-Make Japanese index head \fIA\fR-line (\fIA, Ka, Sa, ...\fR) of the gojuon table (Japanese
-syllabary). By default, all the characters in the gojuon table
-are used.
+Make Japanese index head \fIA\fR-line (\fIA, Ka, Sa, ...\fR; 10 characters)
+of the \fIgojuon\fR table (Japanese syllabary). By default, all 48 characters
+in the \fIgojuon\fR table are used.
.TP 10
\fB-f\fR
Force to output characters even if the scripts are not supported by \fIupmendex\fR.
@@ -88,6 +88,7 @@ Show summary of options.
.TP 10
\fB--\fR
Arguments after \fB--\fR are not taken as options.
+This is useful when the input file name starts with '-'.
.SH "STYLE FILE"
The style file informs \fIupmendex\fR about the format of the
@@ -106,7 +107,7 @@ A line begun by \'%\' is a comment.
\fBkeyword\fR <string>
"\\\\indexentry"
.RS
-Command with an argument of index entry.
+Command with an argument of index entry which is going to be processed.
.RE
.TP 30
\fBarg_open\fR <char>
@@ -220,7 +221,7 @@ Prefix of heading for newly appeared heading letter.
\fBheading_prefix\fR <string>
""
.RS
-Same as \fBlethead_prefix\fR.
+Same as \fBlethead_prefix\fR. (compatible with makeindex)
.RE
.TP 30
\fBlethead_suffix\fR <string>
@@ -232,7 +233,7 @@ Suffix of heading for newly appeared heading letter.
\fBheading_suffix\fR <string>
""
.RS
-Same as \fBlethead_suffix\fR.
+Same as \fBlethead_suffix\fR. (compatible with makeindex)
.RE
.TP 30
\fBlethead_flag\fR <number>
@@ -246,7 +247,13 @@ lowercase and titlecase.
\fBheading_flag\fR <number>
0
.RS
-Same as \fBlethead_flag\fR.
+Same as \fBlethead_flag\fR. (Note: makeindex uses a different name \fBheadings_flag\fR)
+.RE
+.TP 30
+\fBheadings_flag\fR <number>
+0
+.RS
+Same as \fBlethead_flag\fR. (compatible with makeindex)
.RE
.TP 30
\fBkana_head\fR <string>
@@ -448,31 +455,47 @@ Length of space for indent which inserted to top of folded line.
\fBsymhead_positive\fR <string>
"Symbols"
.RS
-Strings to output as heading letter for numbers and symbols
-when lethead_flag or heading_flag is positive number.
+Strings to output as heading letter for symbols
+when lethead_flag or heading_flag or headings_flag is positive number.
.RE
.TP 30
\fBsymhead_negative\fR <string>
"symbols"
.RS
-Strings to output as heading letter for numbers and symbols
-when lethead_flag or heading_flag is negative number.
+Strings to output as heading letter for symbols
+when lethead_flag or heading_flag or headings_flag is negative number.
.RE
.TP 30
\fBsymbol\fR <string>
""
.RS
-Strings to output as heading letter for numbers and symbols
+Strings to output as heading letter for symbols
when symbol_flag is non zero.
.RE
If specified, the option is prior to symhead_positive and symhead_negative.
(Extended by (up)mendex)
.RE
.TP 30
+\fBnumhead_positive\fR <string>
+"Numbers"
+.RS
+Strings to output as heading letter for numbers
+when lethead_flag or heading_flag or headings_flag is positive number and symbol_flag is 2.
+.RE
+.TP 30
+\fBnumhead_negative\fR <string>
+"numbers"
+.RS
+Strings to output as heading letter for numbers
+when lethead_flag or heading_flag or headings_flag is negative number and symbol_flag is 2.
+.RE
+.TP 30
\fBsymbol_flag\fR <number>
1
.RS
-Flag to output of symbol. If \'0\', do not output.
+Flag to output of symbol. If \'0\', do not output headings for symbols and numbers.
+If \'1\', output symbols and numbers as a group of symbols.
+If \'2\', output symbols and numbers separately.
(Extended by (up)mendex)
.RE
.TP 30
@@ -495,14 +518,34 @@ Japanese sequence and non-Japanese sequence in sorting procedure.
.RE
.TP 30
\fBcharacter_order\fR <string>
-"SNLGCJKHDT"
+"SNLGCJKHDTah"
.RS
Order of scripts and symbols.
-\'S\', \'N\', \'L\', \'G\', \'C\', \'J\', \'K\', \'H\', \'D\' and \'T\' respectively
-denotes symbol, number, Latin, Greek, Cyrillic, Japanese Kana, Korean Hangul, Hanja,
-Devanagari and Thai script.
-Please make sure that \'S\' and \'N\' are next to each other,
-since \fBupmendex\fR considers numbers as a part of symbol.
+\'S\', \'N\', \'L\', \'G\', \'C\', \'J\', \'K\', \'H\', \'D\', \'T\', \'a\' and \'h\'
+respectively denotes symbol, number, Latin, Greek, Cyrillic, Japanese Kana, Korean Hangul, Hanja,
+Devanagari, Thai, Arabic and Hebrew script.
+Please make sure that \'S\' and \'N\' are next to each other if symbol_flag=1,
+since numbers are classified as a part of symbol.
+(Extended by upmendex)
+.RE
+.TP 30
+\fBscript_preamble\fR <string 1> <string 2>
+""
+.RS
+Preamble of script block in output file, specified by string 2.
+One of script names must be specified in the string 1:
+\'latin\', \'cyrillic\', \'greek\', \'kana\', \'hangul\', \'hanzi\', \'devanagari\',
+\'thai\', \'arabic\', or \'hebrew\'.
+(Extended by upmendex)
+.RE
+.TP 30
+\fBscript_postamble\fR <string 1> <string 2>
+""
+.RS
+Postamble of script block in output file, specified by string 2.
+One of script names must be specified in the string 1:
+\'latin\', \'cyrillic\', \'greek\', \'kana\', \'hangul\', \'hanzi\', \'devanagari\',
+\'thai\', \'arabic\', or \'hebrew\'.
(Extended by upmendex)
.RE
.TP 30
@@ -522,11 +565,12 @@ Unicode characters in UTF-8 encoding and following escape sequences are accepted
\fB\\Uhhhhhhhh\fR (8-digit hexadecimal [0-9A-Fa-f]), \fB\\uhhhh\fR (4-digit hexadecimal),
\fB\\xhh\fR (2-digit hexadecimal), \fB\\x{h...}\fR (1..8-digit hexadecimal), and
\fB\\ooo\fR (3-digit octal [0-7]).
+If icu_rules and icu_locale are simultaneously specified, collation rules specified
+by icu_rules are added on collation rules specified by icu_locale.
By default, locale is used.
(Extended by upmendex)
.RE
-Ref. <http://userguide.icu-project.org/collation/customization>,
-<https://unicode-org.github.io/icu/userguide/collation/customization/>,
+Ref. <https://unicode-org.github.io/icu/userguide/collation/customization/>,
<http://www.unicode.org/reports/tr35/tr35-collation.html#Rules>
.RE
.TP 30
@@ -545,8 +589,7 @@ Followings are available:
"numeric-ordering:on", "numeric-ordering:off"
(Extended by upmendex)
.RE
-Ref. <http://userguide.icu-project.org/collation/customization>,
-<https://unicode-org.github.io/icu/userguide/collation/customization/#default-options>,
+Ref. <https://unicode-org.github.io/icu/userguide/collation/customization/#default-options>,
<http://www.unicode.org/reports/tr35/tr35-collation.html#Setting_Options>
.RE
.PP
@@ -559,8 +602,8 @@ of manually specifying a reading for every kanji word.
Japanese kanji words are usually sorted by the syllables of their readings
(\fI\'Yomi\'\fR), which can be represented by kana (Hiragana, Katakana) scripts.
\fIupmendex\fR accepts index words specified in kana expression directly on
-an input file, and also accepts conversion from index words to kana scripts
-by referring to Japanese dictionaries.
+an input file, and also accepts conversion from index words in Kanji or symbols
+to phonogram scripts by referring to Japanese dictionaries.
.RE
.LP
@@ -577,7 +620,7 @@ Examples of internal simplification of syllables are shown below.
.LP
The dictionary file consists of list with <\'index_word\' \'reading\'>.
The index word can be written in any scripts (kanji, kana, etc),
-and the reading must be in Hiragana or Katakana scripts.
+and the reading can be in any phonograms such as Hiragana or Katakana scripts.
The delimiter between the index word and its reading is one or more tab(s) or space(s).
.RE
An example of a Japanese dictionary is shown below.
@@ -590,7 +633,7 @@ An example of a Japanese dictionary is shown below.
.br
環境 かんきょう
.br
-α アルファ
+$ ドル
.RE
.LP
Here, each index word is allowed to have only one Yomi.
@@ -672,7 +715,7 @@ wrong page numbers might be output.
.BR mendex(1).
.br
International Components for Unicode (ICU):
-<http://site.icu-project.org/>,
+<http://icu.unicode.org/>,
<https://unicode-org.github.io/icu/>
.SH AUTHOR
This manual page was written by Takuji Tanaka