{
    "mode": "man",
    "parameter": "mendex",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/mendex/1/json",
    "generated": "2026-06-16T10:48:10Z",
    "synopsis": "mendex  [-ilqrcgfEJSU]  [-s  sty] [-d dic] [-o ind] [-t log] [-p no] [-I enc] [--help] [--] [\nidx0 idx1 idx2 ...]",
    "sections": {
        "NAME": {
            "content": "mendex - Japanese index processor\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "mendex  [-ilqrcgfEJSU]  [-s  sty] [-d dic] [-o ind] [-t log] [-p no] [-I enc] [--help] [--] [\nidx0 idx1 idx2 ...]\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "The program mendex is a general purpose hierarchical index generator; it accepts one or  more\ninput  files (.idx; often produced by a text formatter such as LaTeX), sorts the entries, and\nproduces an output file which can be formatted. It is almost compatible with  makeindex,  and\nadditional feature for handling readings of kanji words is also available.\nThe  formats  of  the  input and output files are specified in a style file.  The readings of\nkanji words can be specified in a dictionary file.\nThe index can have up to three levels (0, 1, and 2) of subitem nesting.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "-i        Take input from stdin, even when index files are specified.\n\n-l        Set 'sort by character order'. By default, 'sort by word order' is  used.   Details\nare described below.\n\n-q        Quiet mode; send no message to stderr, except error messages and warnings.\n\n-r        Disable  implicit  page range formation. By default, three or more successive pages\nare automatically abbreviated as a range (e.g. 1-5).\n\n-c        Compress sequence of intermediate blanks (space(s) and/or tab(s)) into a space  and\nignore  leading and trailing blank(s).  By default, blanks in the index key are re-\ntained.\n\n-g        Make Japanese index head A-line (A, Ka, Sa, ...; 10 characters) of the gojuon table\n(Japanese syllabary). By default, all 48 characters in the gojuon table are used.\n\n-f        Force to output Kanji characters even non-existent in dictionaries.\n\n-s sty    Employ sty as the style file.\n\n-d dic    Employ dic as the dictionary file. The dictionary file is composed of lists of <in-\ndexword reading>.\n\n-o ind    Employ ind as the output index file. By default, the file name is  created  by  ap-\npending the extension ind to the base name of the first input file.\n\n-t log    Employ  log as the transcript file. By default, the file name is created by append-\ning the extension ilg to the base name of the first input file.\n\n-p no     Set the starting page number of the output index list to be no. The argument no may\nbe  numerical  or one of the following: any (the next page to the end of contents),\nodd (the next odd page to the end of contents), even (the next even page to the end\nof contents).\n\n-E        Set input/output character encoding to EUC-JP.\n\n-J        Set input/output character encoding to JIS (ISO-2022-JP).\n\n-S        Set input/output character encoding to ShiftJIS.\n\n-U        Set input/output character encoding to UTF-8.\n\n-I enc    Set  internal  character  encoding  to enc. The argument enc may be euc (EUC-JP) or\nutf8 (UTF-8).  The default is set to utf8.\n\n--help    Show summary of options.\n\n--        Arguments after -- are not taken as options.  This is useful when  the  input  file\nname starts with '-'.\n",
            "subsections": []
        },
        "STYLE FILE": {
            "content": "The style file informs mendex about the format of the idx input files and the intended format\nof the final output file. The format is upper compatible with  the  one  for  makeindex.  The\nstyle  file  contains  a  list of <specifier attribute> pairs.  There are two types of speci-\nfiers: input and output.  Pairs do not have to appear in any particular order.  A line  begun\nby '%' is a comment.\n\nInput file style parameter\n\nkeyword  <string>             \"\\\\indexentry\"\nCommand  with  an  argument of index entry which is going to be\nprocessed.\n\nargopen  <char>              '{'\nOpening delimiter which shows the beginning of index entry.\n\nargclose  <char>             '}'\nClosing delimiter which shows the end of index entry.\n\nrangeopen  <char>            '('\nOpening delimiter which shows the beginning of page range.\n\nrangeclose  <char>           ')'\nClosing delimiter which shows the end of page range.\n\nlevel  <char>                 '!'\nDelimiter which shows lower level.\n\nactual  <char>                '@'\nSymbol which shows the next sequence  is  to  appear  as  index\nstrings in the output file.\n\nencap  <char>                 '|'\nSymbol  which  shows the next sequence is to be used as command\nname attached to the page number.\n\npagecompositor  <string>     \"-\"\nSeparator between page levels for a style with multi-levels  of\npage numbers.\n\npageprecedence  <string>     \"rnaRA\"\nPriority of expression for page number.  'R' and 'r' correspond\nto Roman. 'n' corresponds to arabic numeral.  'A' and 'a'  cor-\nrespond to Latin alphabet.\n\nquote  <char>                 '\"'\nEscape character for mendex parameters.\n\nescape  <char>                '\\\\'\nEscape character for general scripts.\n\nOutput file style parameter\n\npreamble  <string>            \"\\\\begin{theindex}\\n\"\nPreamble of output file.\n\npostamble  <string>           \"\\n\\n\\\\end{theindex}\\n\"\nPostamble of output file.\n\nsetpageprefix  <string>      \"\\n  \\\\setcounter{page}{\"\nPrefix of page number if start page is designated.\n\nsetpagesuffix  <string>      \"}\\n\"\nSuffix of page number if start page is designated.\n\ngroupskip  <string>          \"\\n\\n  \\\\indexspace\\n\"\nStrings to insert vertical space before new section of index.\n\nletheadprefix  <string>      \"\"\nPrefix of heading for newly appeared heading letter.\n\nheadingprefix  <string>      \"\"\nSame as letheadprefix. (compatible with makeindex)\n\nletheadsuffix  <string>      \"\"\nSuffix of heading for newly appeared heading letter.\n\nheadingsuffix  <string>      \"\"\nSame as letheadsuffix. (compatible with makeindex)\n\nletheadflag  <number>        0\nFlag  to  control output of heading letters.  '0', '1' and '-1'\nrespectively denotes no output, uppercase and lowercase.\n\nheadingflag  <number>        0\nSame as letheadflag. (Note: makeindex uses  a  different  name\nheadingsflag)\n\nitem0  <string>              \"\\n  \\\\item \"\nCommand sequence inserted between primary level entries.\n\nitem1  <string>              \"\\n     \\\\subitem \"\nCommand sequence inserted between sub level entries.\n\nitem2  <string>              \"\\n       \\\\subsubitem \"\nCommand sequence inserted between subsub level entries.\n\nitem01  <string>             \"\\n    \\\\subitem \"\nCommand  sequence  inserted  between  primaly and sub level en-\ntries.\n\nitemx1  <string>             \"\\n    \\\\subitem \"\nCommand sequence inserted between primary and sub level entries\nwhen main entry does not have page number.\n\nitem12  <string>             \"\\n    \\\\subsubitem \"\nCommand sequence inserted between sub and subsub level entries.\n\nitemx2  <string>             \"\\n    \\\\subsubitem \"\nCommand  sequence inserted between sub and subsub level entries\nwhen sub level entry does not have page number.\n\ndelim0  <string>             \", \"\nDelimiter string between primary level  entry  and  first  page\nnumber.\n\ndelim1  <string>             \", \"\nDelimiter string between sub level entry and first page number.\n\ndelim2  <string>             \", \"\nDelimiter string between subsub level entry and first page num-\nber.\n\ndelimn  <string>             \", \"\nDelimiter string between page numbers commonly used for any en-\ntry level.\n\ndelimr  <string>             \"--\"\nDelimiter string between pages to show page range.\n\ndelimt  <string>             \"\"\nDelimiter string output at the end of page number list.\n\nsuffix2p  <string>           \"\"\nString  to  be  inserted  in place of delimn and the next page\nnumber when the two pages are contiguous.\nIt works only when the parameter is defined.\n\nsuffix3p  <string>           \"\"\nString to be inserted in place of delimr and  the  third  page\nnumber  when  the three pages are contiguous.  The parameter is\nprior to suffixmp.\nIt works only when the parameter is defined.\n\nsuffixmp  <string>           \"\"\nString to be inserted in place of delimr  and  the  last  page\nnumber when the three or more pages are contiguous.\nIt works only when the parameter is defined.\n\nencapprefix  <string>        \"\\\\\"\nPrefix for an encapsulating command when the encapsulating com-\nmand is added to the page number.\n\nencapinfix  <string>         \"{\"\nPrefix just before the page number when the encapsulating  com-\nmand is added to the page number.\n\nencapsuffix  <string>        \"}\".\nSuffix  after the page number when the encapsulating command is\nadded to the page number.\n\nlinemax  <number>            72\nMaximum number of one line.  If exceed the  number,  lines  are\nfolded.\n\nindentspace  <string>        \"\"\nSpace for indent which inserted to top of folded line.\n\nindentlength  <number>       16\nLength  of  space  for  indent  which inserted to top of folded\nline.\n\nsymheadpositive  <string>    \"Symbols\"\nStrings to output as heading letter  for  numbers  and  symbols\nwhen letheadflag or headingflag is positive number.\n\nsymheadnegative  <string>    \"symbols\"\nStrings  to  output  as  heading letter for numbers and symbols\nwhen letheadflag or headingflag is negative number.\n\nsymbol  <string>              \"\"\nStrings to output as heading letter  for  numbers  and  symbols\nwhen symbolflag is non zero.\nIf  specified,  the  option  is prior to symheadpositive and symheadnegative.  (Extended by\nmendex)\n\nsymbolflag  <number>         1\nFlag to output of symbol. If '0', do not output.  (Extended  by\nmendex)\n\nletterhead  <number>         1\nFlag  of  heading  letter  for  Japanese Kana.  If '1' and '2',\nKatakana and Hiragana  is  used,  respectively.   (Extended  by\nmendex)\n\npriority  <number>            0\nFlag of sorting method for index words composed of Japanese and\nnon-Japanese (ex. Latin  scripts).   If  non  zero,  one  space\n(U+20)  is  inserted between Japanese sequence and non-Japanese\nsequence in sorting procedure.  (Extended by mendex)\n\ncharacterorder  <string>     \"SNEJ\"\nOrder of scripts and symbols.  'S', 'N', 'E'  and  'J'  respec-\ntively  denotes  symbol,  numbers,  English and Japanese.  (Ex-\ntended by mendex) Please make sure that 'S' and 'N' are next to\neach other, since mendex considers numbers as part of symbol.\n",
            "subsections": []
        },
        "ABOUT JAPANESE PROCESSING": {
            "content": "mendex has an additional feature to simplify the procedure of handling Japanese indexes, com-\npared to makeindex. Users can save the effort of manually  specifying  a  reading  for  every\nkanji word.\nJapanese  kanji  words  are usually sorted by the syllables of their readings ('Yomi'), which\ncan be represented by kana (Hiragana, Katakana) scripts.  mendex accepts index  words  speci-\nfied  in  kana  expression  directly on an input file, and also accepts conversion from index\nwords to kana scripts by referring to Japanese dictionaries.\n\nExamples of internal simplification of syllables are shown below.\n\nThe dictionary file consists of list with <'indexword' 'reading'>.  The index  word  can  be\nwritten  in  any  scripts (kanji, kana, etc), and the reading must be in Hiragana or Katakana\nscripts.  The delimiter between the index word and its reading  is  one  or  more  tab(s)  or\nspace(s).\nAn example of a Japanese dictionary is shown below.\n\n<alpha>\n\nHere,  each  index word is allowed to have only one Yomi.  Though some kanji words (ex. ) may\nhave more than one Yomi's (ex.  and ), only one of them can be registered in the  dictionary.\nWhen some different Yomi's are needed, they should be specified explicitly in kana expression\n(ex. \\index{@} or \\index{@}) on the input file.\nMoreover, a dictionary file is automatically referred by setting the file name at an environ-\nment  variable INDEXDEFAULTDICTIONARY.  The dictionary set by the environment variable can be\nused together with file(s) specified by -d option.\n",
            "subsections": []
        },
        "ABOUT SORTING PROCEDURE": {
            "content": "mendex sorts indexes as is ('sort by word order') by default.  Setting -l option, spaces  be-\ntween words in an index are truncated prior to sorting procedure ('sort by character order').\nEven  when sort by character order, the index at output remains the original sequence without\nthe truncation.\nFollows show an example.\n\nsort by word order       sort by character order\nX Window            Xlib\nXlib                XView\nXView                    X Window\n\nIn addition, two sorting methods can be applied for indexes which contains both Japanese kana\nand  other  scripts  (e.g.  Latin  script).  By setting priority 0 (default) and 1 at a style\nfile, a space between Japanese Kana and other scripts is inserted and  not  inserted  respec-\ntively, prior to the sorting procedure.\nFollows show an example.\n\npriority=0               priority=1\nindex sort               ind\nind            index sort\n",
            "subsections": []
        },
        "ENVIRONMENT VARIABLES": {
            "content": "mendex refers environment variables as follows.\n\nINDEXSTYLE\nDirectory where index style files exist.\n\nINDEXDEFAULTSTYLE\nIndex style file to be referred to as default.\n\nINDEXDICTIONARY\nDirectory where dictionary files exist.\n\nINDEXDEFAULTDICTIONARY\nDictionary file which is automatically read.\n",
            "subsections": []
        },
        "DETAIL": {
            "content": "Detailed specification is compatible with makeindex.\n",
            "subsections": []
        },
        "KNOWN ISSUES": {
            "content": "When plural page number expression is used, .idx files should be specified along with the or-\nder of page numbers. Otherwise, wrong page numbers might be output.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "tex(1), latex(1), makeindex(1)\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "This manual page was written by Japanese TeX Development Community.\n\nMENDEX(1)",
            "subsections": []
        }
    },
    "summary": "mendex - Japanese index processor",
    "flags": [],
    "examples": [],
    "see_also": [
        {
            "name": "tex",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/tex/1/json"
        },
        {
            "name": "latex",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/latex/1/json"
        },
        {
            "name": "makeindex",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/makeindex/1/json"
        }
    ]
}