summaryrefslogtreecommitdiff
path: root/Build/source/texk/mendexk/mendex.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-02-25 19:22:25 +0000
committerKarl Berry <karl@freefriends.org>2021-02-25 19:22:25 +0000
commitad547a6b5986815fda458221149728d9d9ab1d87 (patch)
tree16296910eb3eca724371474ea9aea3994dc69614 /Build/source/texk/mendexk/mendex.1
parent947b43de3dd21d58ccc2ffadefc4441ea1c2a813 (diff)
restore Build,TODO from r57911
git-svn-id: svn://tug.org/texlive/trunk@57915 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/texk/mendexk/mendex.1')
-rw-r--r--Build/source/texk/mendexk/mendex.1586
1 files changed, 586 insertions, 0 deletions
diff --git a/Build/source/texk/mendexk/mendex.1 b/Build/source/texk/mendexk/mendex.1
new file mode 100644
index 00000000000..36b4f4da603
--- /dev/null
+++ b/Build/source/texk/mendexk/mendex.1
@@ -0,0 +1,586 @@
+.TH MENDEX 1
+\"=====================================================================
+.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
+.if n .ds TX TeX
+.\" LX definition must follow TX so LX can use TX
+.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
+.if n .ds LX LaTeX
+\"=====================================================================
+.SH NAME
+mendex \- Japanese index processor
+.SH SYNOPSIS
+\fBmendex\fR [-ilqrcgfEJSU] [\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-I\fI enc\fR] [\fB--help\fR] [\fB--\fR] [\fI idx0 idx1 idx2 ...\fR]
+.SH DESCRIPTION
+.PP
+The program \fImendex\fR is a general purpose hierarchical index generator;
+it accepts one or more input files (\fI.idx\fR; often produced by a text
+formatter such as \*(LX), sorts the entries, and produces an output file
+which can be formatted. It is almost compatible with \fImakeindex\fR, and
+additional feature for handling readings of kanji words is also available.
+.RE
+The formats of the input and output files are specified in a style file.
+The readings of kanji words can be specified in a dictionary file.
+.RE
+The index can have up to three levels (0, 1, and 2) of subitem nesting.
+.SH OPTIONS
+.PP
+.TP 10
+\fB-i\fR
+Take input from stdin, even when index files are specified.
+.TP 10
+\fB-l\fR
+Set \'sort by character order\'. By default, \'sort by word order\' is used.
+Details are described below.
+.TP 10
+\fB-q\fR
+Quiet mode; send no message to \fIstderr\fR, except error
+messages and warnings.
+.TP 10
+\fB-r\fR
+Disable implicit page range formation. By default, three or
+more successive pages are automatically abbreviated as a range
+(e.g. 1\(en5).
+.TP 10
+\fB-c\fR
+Compress sequence of intermediate blanks (space(s) and/or tab(s)) into a space
+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.
+.TP 10
+\fB-f\fR
+Force to output Kanji characters even non-existent in dictionaries.
+.TP 10
+\fB-s\fI sty\fR
+Employ \fIsty\fR as the style file.
+.TP 10
+\fB-d\fI dic\fR
+Employ \fIdic\fR as the dictionary file. The dictionary file is
+composed of lists of <\fIindex_word\fR\ \fIreading\fR>.
+.TP 10
+\fB-o\fI ind\fR
+Employ \fIind\fR as the output index file. By default, the file
+name is created by appending the extension \fIind\fR to the base
+name of the first input file.
+.TP 10
+\fB-t\fI log\fR
+Employ \fIlog\fR as the transcript file. By default, the file name
+is created by appending the extension \fIilg\fR to the base name
+of the first input file.
+.TP 10
+\fB-p\fI no\fR
+Set the starting page number of the output index list to be
+\fIno\fR. The argument \fIno\fR may be numerical or one of
+the following: \fIany\fR (the next page to the end of contents), \fIodd\fR
+(the next odd page to the end of contents), \fIeven\fR (the next even page to the end of contents).
+.TP 10
+\fB-E\fR
+Set input/output character encoding to EUC-JP.
+.TP 10
+\fB-J\fR
+Set input/output character encoding to JIS (ISO-2022-JP).
+.TP 10
+\fB-S\fR
+Set input/output character encoding to Shift_JIS.
+.TP 10
+\fB-U\fR
+Set input/output character encoding to UTF-8.
+.TP 10
+\fB-I\fI enc\fR
+Set internal character encoding to \fIenc\fR. The argument \fIenc\fR
+may be \fIeuc\fR (EUC-JP) or \fIutf8\fR (UTF-8).
+The default is set to \fIutf8\fR.
+.TP 10
+\fB--help\fR
+Show summary of options.
+.TP 10
+\fB--\fR
+Arguments after \fB--\fR are not taken as options.
+
+.SH "STYLE FILE"
+The style file informs \fImendex\fR about the format of the
+\fIidx\fR input files and the intended format of the final
+output file. The format is upper compatible with the one for
+\fImakeindex\fR. The style file contains a list of
+<\fIspecifier\fR\ \fIattribute\fR> pairs.
+There are two types of specifiers: input and output.
+Pairs do not have to appear in any particular order.
+A line begun by \'%\' is a comment.
+
+.PP
+\fBInput file style parameter\fR
+.TP 30
+\fBkeyword\fR <string>
+"\\\\indexentry"
+.RS
+Command with an argument of index entry.
+.RE
+.TP 30
+\fBarg_open\fR <char>
+\'{\'
+.RS
+Opening delimiter which shows the beginning of index entry.
+.RE
+.TP 30
+\fBarg_close\fR <char>
+\'}\'
+.RS
+Closing delimiter which shows the end of index entry.
+.RE
+.TP 30
+\fBrange_open\fR <char>
+\'(\'
+.RS
+Opening delimiter which shows the beginning of page range.
+.RE
+.TP 30
+\fBrange_close\fR <char>
+\')\'
+.RS
+Closing delimiter which shows the end of page range.
+.RE
+.TP 30
+\fBlevel\fR <char>
+\'!\'
+.RS
+Delimiter which shows lower level.
+.RE
+.TP 30
+\fBactual\fR <char>
+\'@\'
+.RS
+Symbol which shows the next sequence is to appear as index strings
+in the output file.
+.RE
+.TP 30
+\fBencap\fR <char>
+\'|\'
+.RS
+Symbol which shows the next sequence is to be used as command name
+attached to the page number.
+.RE
+.TP 30
+\fBpage_compositor\fR <string>
+"-"
+.RS
+Separator between page levels for a style with multi-levels of page numbers.
+.RE
+.TP 30
+\fBpage_precedence\fR <string>
+"rnaRA"
+.RS
+Priority of expression for page number.
+\'R\' and \'r\' correspond to Roman. \'n\' corresponds to arabic numeral.
+\'A\' and \'a\' correspond to Latin alphabet.
+.RE
+.TP 30
+\fBquote\fR <char>
+\'"\'
+.RS
+Escape character for \fImendex\fR parameters.
+.RE
+.TP 30
+\fBescape\fR <char>
+\'\\\\\'
+.RS
+Escape character for general scripts.
+.RE
+
+\fBOutput file style parameter\fR
+.TP 30
+\fBpreamble\fR <string>
+"\\\\begin{theindex}\\n"
+.RS
+Preamble of output file.
+.RE
+.TP 30
+\fBpostamble\fR <string>
+"\\n\\n\\\\end{theindex}\\n"
+.RS
+Postamble of output file.
+.RE
+.TP 30
+\fBsetpage_prefix\fR <string>
+"\\n \\\\setcounter{page}{"
+.RS
+Prefix of page number if start page is designated.
+.RE
+.TP 30
+\fBsetpage_suffix\fR <string>
+"}\\n"
+.RS
+Suffix of page number if start page is designated.
+.RE
+.TP 30
+\fBgroup_skip\fR <string>
+"\\n\\n \\\\indexspace\\n"
+.RS
+Strings to insert vertical space before new section of index.
+.RE
+.TP 30
+\fBlethead_prefix\fR <string>
+""
+.RS
+Prefix of heading for newly appeared heading letter.
+.RE
+.TP 30
+\fBheading_prefix\fR <string>
+""
+.RS
+Same as \fBlethead_prefix\fR.
+.RE
+.TP 30
+\fBlethead_suffix\fR <string>
+""
+.RS
+Suffix of heading for newly appeared heading letter.
+.RE
+.TP 30
+\fBheading_suffix\fR <string>
+""
+.RS
+Same as \fBlethead_suffix\fR.
+.RE
+.TP 30
+\fBlethead_flag\fR <number>
+0
+.RS
+Flag to control output of heading letters.
+\'0\', \'1\' and \'-1\' respectively denotes no output, uppercase and lowercase.
+.RE
+.TP 30
+\fBheading_flag\fR <number>
+0
+.RS
+Same as \fBlethead_flag\fR.
+.RE
+.TP 30
+\fBitem_0\fR <string>
+"\\n \\\\item "
+.RS
+Command sequence inserted between primary level entries.
+.RE
+.TP 30
+\fBitem_1\fR <string>
+"\\n \\\\subitem "
+.RS
+Command sequence inserted between sub level entries.
+.RE
+.TP 30
+\fBitem_2\fR <string>
+"\\n \\\\subsubitem "
+.RS
+Command sequence inserted between subsub level entries.
+.RE
+.TP 30
+\fBitem_01\fR <string>
+"\\n \\\\subitem "
+.RS
+Command sequence inserted between primaly and sub level entries.
+.RE
+.TP 30
+\fBitem_x1\fR <string>
+"\\n \\\\subitem "
+.RS
+Command sequence inserted between primary and sub level entries
+when main entry does not have page number.
+.RE
+.TP 30
+\fBitem_12\fR <string>
+"\\n \\\\subsubitem "
+.RS
+Command sequence inserted between sub and subsub level entries.
+.RE
+.TP 30
+\fBitem_x2\fR <string>
+"\\n \\\\subsubitem "
+.RS
+Command sequence inserted between sub and subsub level entries
+when sub level entry does not have page number.
+.RE
+.TP 30
+\fBdelim_0\fR <string>
+", "
+.RS
+Delimiter string between primary level entry and first page number.
+.RE
+.TP 30
+\fBdelim_1\fR <string>
+", "
+.RS
+Delimiter string between sub level entry and first page number.
+.RE
+.TP 30
+\fBdelim_2\fR <string>
+", "
+.RS
+Delimiter string between subsub level entry and first page number.
+.RE
+.TP 30
+\fBdelim_n\fR <string>
+", "
+.RS
+Delimiter string between page numbers
+commonly used for any entry level.
+.RE
+.TP 30
+\fBdelim_r\fR <string>
+"--"
+.RS
+Delimiter string between pages to show page range.
+.RE
+.TP 30
+\fBdelim_t\fR <string>
+""
+.RS
+Delimiter string output at the end of page number list.
+.RE
+.TP 30
+\fBsuffix_2p\fR <string>
+""
+.RS
+String to be inserted in place of \fBdelim_n\fR and the next page
+number when the two pages are contiguous.
+.RE
+It works only when the parameter is defined.
+.RE
+.TP 30
+\fBsuffix_3p\fR <string>
+""
+.RS
+String to be inserted in place of \fBdelim_r\fR and the third page
+number when the three pages are contiguous.
+The parameter is prior to \fBsuffix_mp\fR.
+.RE
+It works only when the parameter is defined.
+.RE
+.TP 30
+\fBsuffix_mp\fR <string>
+""
+.RS
+String to be inserted in place of \fBdelim_r\fR and the last page
+number when the three or more pages are contiguous.
+.RE
+It works only when the parameter is defined.
+.RE
+.TP 30
+\fBencap_prefix\fR <string>
+"\\\\"
+.RS
+Prefix for an encapsulating command
+when the encapsulating command is added to the page number.
+.RE
+.TP 30
+\fBencap_infix\fR <string>
+"{"
+.RS
+Prefix just before the page number
+when the encapsulating command is added to the page number.
+.RE
+.TP 30
+\fBencap_suffix\fR <string>
+"}".
+.RS
+Suffix after the page number
+when the encapsulating command is added to the page number.
+.RE
+.TP 30
+\fBline_max\fR <number>
+72
+.RS
+Maximum number of one line.
+If exceed the number, lines are folded.
+.RE
+.TP 30
+\fBindent_space\fR <string>
+"\t\t"
+.RS
+Space for indent which inserted to
+top of folded line.
+.RE
+.TP 30
+\fBindent_length\fR <number>
+16
+.RS
+Length of space for indent which inserted to top of folded line.
+.RE
+.TP 30
+\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.
+.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.
+.RE
+.TP 30
+\fBsymbol\fR <string>
+""
+.RS
+Strings to output as heading letter for numbers and symbols
+when symbol_flag is non zero.
+.RE
+If specified, the option is prior to symhead_positive and symhead_negative.
+(Extended by mendex)
+.RE
+.TP 30
+\fBsymbol_flag\fR <number>
+1
+.RS
+Flag to output of symbol. If \'0\', do not output.
+(Extended by mendex)
+.RE
+.TP 30
+\fBletter_head\fR <number>
+1
+.RS
+Flag of heading letter for Japanese Kana.
+If \'1\' and \'2\', Katakana and Hiragana is used, respectively.
+(Extended by mendex)
+.RE
+.TP 30
+\fBpriority\fR <number>
+0
+.RS
+Flag of sorting method for index words composed of
+Japanese and non-Japanese (ex. Latin scripts).
+If non zero, one space (U+20) is inserted between
+Japanese sequence and non-Japanese sequence in sorting procedure.
+(Extended by mendex)
+.RE
+.TP 30
+\fBcharacter_order\fR <string>
+"SEJ"
+.RS
+Order of scripts and symbols.
+\'S\', \'E\' and \'J\' respectively denotes symbol, English and Japanese.
+(Extended by mendex)
+.RE
+.PP
+.SH ABOUT JAPANESE PROCESSING
+.PP
+\fImendex\fR has an additional feature to simplify the procedure of handling
+Japanese indexes, compared to \fImakeindex\fR. Users can save the effort
+of manually specifying a reading for every kanji word.
+.RE
+Japanese kanji words are usually sorted by the syllables of their readings
+(\fI\'Yomi\'\fR), which can be represented by kana (Hiragana, Katakana) scripts.
+\fImendex\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.
+.RE
+
+.LP
+Examples of internal simplification of syllables are shown below.
+.PP
+.RS
+.br
+かぶしきがいしゃ かふしきかいしや
+.br
+マッキントッシュ まつきんとつしゆ
+.br
+ワープロ わあふろ
+.RE
+.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.
+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.
+.PP
+.RS
+.br
+漢字 かんじ
+.br
+読み よみ
+.br
+環境 かんきょう
+.br
+α アルファ
+.RE
+.LP
+Here, each index word is allowed to have only one Yomi.
+Though some kanji words (ex. 「表」) may have more than one Yomi\'s
+(ex. 「ひょう」 and 「おもて」), only one of them can be registered in the dictionary.
+When some different Yomi\'s are needed, they should be specified explicitly
+in kana expression (ex. \\index{ひょう@表} or \\index{おもて@表}) on the input file.
+.RE
+Moreover, a dictionary file is automatically referred
+by setting the file name at an environment variable \fIINDEXDEFAULTDICTIONARY\fR.
+The dictionary set by the environment variable can be used
+together with file(s) specified by \fI-d\fR option.
+.PP
+.SH ABOUT SORTING PROCEDURE
+.PP
+\fImendex\fR sorts indexes as is (\'sort by word order\') by default.
+Setting \fI-l\fR option, spaces between words in an index are truncated prior to
+sorting procedure (\'sort by character order\').
+.RE
+Even when sort by character order, the index at output remains the original sequence
+without the truncation.
+.RE
+Follows show an example.
+.PP
+.RS
+\fIsort by word order sort by character order\fR
+.br
+X Window Xlib
+.br
+Xlib XView
+.br
+XView X Window
+.RE
+.LP
+In addition, two sorting methods can be applied for indexes
+which contains both Japanese kana and other scripts (e.g. Latin script).
+By setting \fIpriority\fR 0 (default) and 1 at a style file,
+a space between Japanese Kana and other scripts is inserted and
+not inserted respectively, prior to the sorting procedure.
+.RE
+Follows show an example.
+.PP
+.RS
+\fIpriority=0 priority=1\fR
+.br
+index sort indファイル
+.br
+indファイル index sort
+.RE
+.PP
+.SH ENVIRONMENT VARIABLES
+\fImendex\fR refers environment variables as follows.
+.PP
+.TP 10
+\fIINDEXSTYLE\fR
+Directory where index style files exist.
+.TP 10
+\fIINDEXDEFAULTSTYLE\fR
+Index style file to be referred to as default.
+.TP 10
+\fIINDEXDICTIONARY\fR
+Directory where dictionary files exist.
+.TP 10
+\fIINDEXDEFAULTDICTIONARY\fR
+Dictionary file which is automatically read.
+.PP
+.SH DETAIL
+Detailed specification is compatible with \fImakeindex\fR.
+.PP
+.SH KNOWN ISSUES
+When plural page number expression is used, \fI.idx\fR files should be
+specified along with the order of page numbers. Otherwise,
+wrong page numbers might be output.
+.PP
+.SH "SEE ALSO"
+tex(1), latex(1), makeindex(1)
+.SH AUTHOR
+This manual page was written by Japanese \*(TX Development Community.