File indexing completed on 2024-11-24 04:34:44
0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 0002 <html> 0003 <!-- This document is an unofficial reference manual for LaTeX, a 0004 document preparation system, version of November 2018. 0005 0006 This manual was originally translated from LATEX.HLP v1.0a in the 0007 VMS Help Library. The pre-translation version was written by 0008 George D. Greenwade of Sam Houston State University. The 0009 LaTeX 2.09 version was written by Stephen Gilmore. The 0010 LaTeX2e version was adapted from this by Torsten Martinsen. Karl 0011 Berry made further updates and additions, and gratefully acknowledges 0012 using Hypertext Help with LaTeX, by Sheldon Green, and 0013 LaTeX Command Summary (for LaTeX 2.09) by 0014 L. Botway and C. Biemesderfer (published by the TeX Users 0015 Group as TeXniques number 10), as reference material. We also 0016 gratefully acknowledge additional material appearing in 0017 latex2e-reference by Martin Herbert Dietze. (From these references no 0018 text was directly copied.) 0019 0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 0021 2014, 2015, 2016, 2017, 2018 Karl Berry. 0022 0023 Copyright 1988, 1994, 2007 Stephen Gilmore. 0024 0025 Copyright 1994, 1995, 1996 Torsten Martinsen. 0026 0027 Permission is granted to make and distribute verbatim copies of 0028 this manual provided the copyright notice and this permission notice 0029 are preserved on all copies. 0030 0031 0032 Permission is granted to copy and distribute modified versions of this 0033 manual under the conditions for verbatim copying, provided that the entire 0034 resulting derived work is distributed under the terms of a permission 0035 notice identical to this one. 0036 0037 Permission is granted to copy and distribute translations of this manual 0038 into another language, under the above conditions for modified versions. --> 0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 0040 <head> 0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 0042 <title>makeindex (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="makeindex (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="makeindex (LaTeX2e unofficial reference manual (November 2018))"> 0046 <meta name="resource-type" content="document"> 0047 <meta name="distribution" content="global"> 0048 <meta name="Generator" content="makeinfo"> 0049 <link href="index.html#Top" rel="start" title="Top"> 0050 <link href="IndexDocument.html#Index" rel="index" title="Index"> 0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 0052 <link href="Indexes.html#Indexes" rel="up" title="Indexes"> 0053 <link href="_005cprintindex.html#g_t_005cprintindex" rel="next" title="\printindex"> 0054 <link href="_005cindex.html#g_t_005cindex" rel="prev" title="\index"> 0055 <style type="text/css"> 0056 <!-- 0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $ 0058 Minor css for latexrefman. Public domain. 0059 Originally written by Jim Hefferon and Karl Berry, 2018. */ 0060 0061 /* So you can style for yourself */ 0062 @import url("/css/latexreflocal.css"); 0063 0064 0065 0066 a.summary-letter {text-decoration: none} 0067 blockquote.indentedblock {margin-right: 0em} 0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 0069 blockquote.smallquotation {font-size: smaller} 0070 div.display {margin-left: 3.2em} 0071 div.example {margin-left: 3.2em} 0072 div.lisp {margin-left: 3.2em} 0073 div.smalldisplay {margin-left: 3.2em} 0074 div.smallexample {margin-left: 3.2em} 0075 div.smalllisp {margin-left: 3.2em} 0076 kbd {font-style: oblique} 0077 pre.display {font-family: inherit} 0078 pre.format {font-family: inherit} 0079 pre.menu-comment {font-family: serif} 0080 pre.menu-preformatted {font-family: serif} 0081 pre.smalldisplay {font-family: inherit; font-size: smaller} 0082 pre.smallexample {font-size: smaller} 0083 pre.smallformat {font-family: inherit; font-size: smaller} 0084 pre.smalllisp {font-size: smaller} 0085 span.nolinebreak {white-space: nowrap} 0086 span.roman {font-family: initial; font-weight: normal} 0087 span.sansserif {font-family: sans-serif; font-weight: normal} 0088 ul.no-bullet {list-style: none} 0089 BODY { 0090 margin-top: 1em; 0091 margin-left: 1em; /* auto results in two-digit <ol> lost off left */ 0092 margin-right: 1em; 0093 margin-bottom: 1em; 0094 /* the idea is to use the whole window, unless it is ridiculously 0095 wide, probably with too-small fonts, too. */ 0096 max-width: 64em; 0097 } 0098 0099 /* Because we want @math{... @code ...} to be upright, not slanted, 0100 and Texinfo won't fix it. */ 0101 code {font-style:normal; font-family:monospace; } 0102 0103 /* We put a link to our own home page at the bottom. */ 0104 div.referenceinfo {font-size:small;} 0105 0106 --> 0107 </style> 0108 0109 0110 </head> 0111 0112 <body lang="en"> 0113 <a name="makeindex"></a> 0114 <div class="header"> 0115 <p> 0116 Next: <a href="_005cprintindex.html#g_t_005cprintindex" accesskey="n" rel="next">\printindex</a>, Previous: <a href="_005cindex.html#g_t_005cindex" accesskey="p" rel="prev">\index</a>, Up: <a href="Indexes.html#Indexes" accesskey="u" rel="up">Indexes</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p> 0117 </div> 0118 <hr> 0119 <a name="makeindex-1"></a> 0120 <h4 class="subsection">25.2.2 <code>makeindex</code></h4> 0121 0122 <a name="index-index_002c-processing"></a> 0123 <a name="index-makeindex"></a> 0124 <a name="index-makeindex-program"></a> 0125 <a name="index-_002eind-file"></a> 0126 <a name="index-_002eidx-file-1"></a> 0127 0128 <p>Synopsis, one of: 0129 </p> 0130 <div class="example"> 0131 <pre class="example">makeindex <var>filename</var> 0132 makeindex -s <var>style-file</var> <var>filename</var> 0133 makeindex <var>options</var> <var>filename0</var> ... 0134 </pre></div> 0135 0136 <p>Sort, and otherwise process, the index information in the auxiliary file 0137 <var>filename</var>. This is a command line program. It takes one or more 0138 raw index files, <samp><var>filename</var>.idx</samp> files, and produces the 0139 actual index file, the <samp><var>filename</var>.ind</samp> file that is input by 0140 <code>\printindex</code> (see <a href="_005cprintindex.html#g_t_005cprintindex">\printindex</a>). 0141 </p> 0142 <a name="index-_002eisty-file"></a> 0143 <a name="index-index_002c-style-file"></a> 0144 <a name="index-makeindex_002c-style-file"></a> 0145 <p>The first form of the command suffices for many uses. The second allows 0146 you to format the index by using an <em>index style file</em>, a 0147 <samp>.isty</samp> file. The third form is the most general; see the full 0148 documentation on CTAN. 0149 </p> 0150 <p>This is a simple <samp>.isty</samp> file. 0151 </p> 0152 <div class="example"> 0153 <pre class="example">% book.isty 0154 % $ makeindex -s book.isty -p odd book.idx 0155 % creates the index as book.ind, starting on an odd page. 0156 preamble 0157 "\\pagestyle{empty} 0158 \\small 0159 \\begin{theindex} 0160 \\thispagestyle{empty}" 0161 0162 postamble 0163 "\n 0164 \\end{theindex}" 0165 </pre></div> 0166 0167 <p>The description here covers only some of the index formatting 0168 possibilities in <var>style-file</var>. For a full list see the documentation 0169 on CTAN. 0170 </p> 0171 <p>A style file consists of a list of pairs: <var>specifier</var> and 0172 <var>attribute</var>. These can appear in the file in any order. All of the 0173 <var>attributes</var> are strings, except where noted. Strings are 0174 surrounded with double quotes, <code>"</code>, and the maximum length of a 0175 string is 144 characters. The <code>\n</code> is for a newline and <code>\t</code> 0176 is for a tab. Backslashes are escaped with another backslash, 0177 <code>\\</code>. If a line begins with a percent sign, <code>%</code>, then it is a 0178 comment. 0179 </p> 0180 <dl compact="compact"> 0181 <dd><a name="makeindex-preamble"></a></dd> 0182 <dt><code>preamble</code> 0183 <a name="index-preamble"></a> 0184 </dt> 0185 <dd><p>Preamble of the output file. Defines the context in which the index is 0186 formatted. Default: <code>"\\begin{theindex}\n"</code>. 0187 </p> 0188 <a name="makeindex-postamble"></a></dd> 0189 <dt><code>postamble</code> 0190 <a name="index-postamble"></a> 0191 </dt> 0192 <dd><p>Postamble of the output file. Default: <code>"\n\n\\end{theindex}\n"</code>. 0193 </p> 0194 <a name="makeindex-group-skip"></a></dd> 0195 <dt><code>group_skip</code> 0196 <a name="index-group_005fskip"></a> 0197 </dt> 0198 <dd><a name="index-_005cindexspace"></a> 0199 <p>Traditionally index items are broken into groups, typically a group for 0200 entries starting with ‘<samp>a</samp>’, etc. This specifier gives what is 0201 inserted when a new group begins. Default: <code>"\n\n \\indexspace\n"</code> 0202 (<code>\indexspace</code> is a rubber length with default value <code>10pt 0203 plus5pt minus3pt</code>). 0204 </p> 0205 <a name="makeindex-letheadflag"></a></dd> 0206 <dt><code>lethead_flag</code> 0207 <a name="index-lethead_005fflag"></a> 0208 </dt> 0209 <dd><p>An integer. It governs what is inserted for a new group or letter. If 0210 it is 0 (which is the default) then other than <code>group_skip</code> nothing 0211 will be inserted before the group. If it is positive then at a new 0212 letter the <code>lethead_prefix</code> and <code>lethead_suffix</code> will be 0213 inserted, with that letter in uppercase between them. If it is negative 0214 then what will be inserted is the letter in lowercase. The default 0215 is 0. 0216 </p> 0217 <a name="makeindex-lethead-prefix"></a></dd> 0218 <dt><code>lethead_prefix</code> 0219 <a name="index-lethead_005fprefix"></a> 0220 </dt> 0221 <dd><p>If a new group begins with a different letter then this is the prefix 0222 inserted before the new letter header. Default: <code>""</code> 0223 </p> 0224 <a name="makeindex-lethead-suffix"></a></dd> 0225 <dt><code>lethead_suffix</code> 0226 <a name="index-lethead_005fsuffix"></a> 0227 </dt> 0228 <dd><p>If a group begins with a different letter then this is the suffix 0229 inserted after the new letter header. Default: <code>""</code>. 0230 </p> 0231 <a name="makeindex-item-0"></a></dd> 0232 <dt><code>item_0</code> 0233 <a name="index-item_005f0"></a> 0234 </dt> 0235 <dd><p>What is put between two level 0 items. Default: <code>"\n \\item 0236 "</code>. 0237 </p> 0238 <a name="makeindex-item-1"></a></dd> 0239 <dt><code>item_1</code> 0240 <a name="index-item_005f1"></a> 0241 </dt> 0242 <dd><p>Put between two level 1 items. Default: <code>"\n \\subitem "</code>. 0243 </p> 0244 <a name="makeindex-item-2"></a></dd> 0245 <dt><code>item_2</code> 0246 <a name="index-item_005f2"></a> 0247 </dt> 0248 <dd><p>put between two level 2 items. Default: <code>"\n \\subsubitem "</code>. 0249 </p> 0250 <a name="makeindex-item-01"></a></dd> 0251 <dt><code>item_01</code> 0252 <a name="index-item_005f01"></a> 0253 </dt> 0254 <dd><p>What is put between a level 0 item and a level 1 item. 0255 Default: <code>"\n \\subitem "</code>. 0256 </p> 0257 <a name="makeindex-item-x1"></a></dd> 0258 <dt><code>item_x1</code> 0259 <a name="index-item_005fx1"></a> 0260 </dt> 0261 <dd><p>What is put between a level 0 item and a level 1 item in the 0262 case that the level 0 item doesn’t have any page numbers (as in 0263 <code>\index{aaa|see{bbb}}</code>). Default: <code>"\n \\subitem "</code>. 0264 </p> 0265 <a name="makeindex-item-12"></a></dd> 0266 <dt><code>item_12</code> 0267 <a name="index-item_005f12"></a> 0268 </dt> 0269 <dd><p>What is put between a level 1 item and a level 2 item. 0270 Default: <code>"\n \\subsubitem "</code>. 0271 </p> 0272 <a name="makeindex-item-x2"></a></dd> 0273 <dt><code>item_x2</code> 0274 <a name="index-item_005fx2"></a> 0275 </dt> 0276 <dd><p>What is put between a level 1 item and a level 2 item, if the 0277 level 1 item doesn’t have page numbers. Default: <code>"\n 0278 \\subsubitem "</code>. 0279 </p> 0280 <a name="makeindex-delim-0"></a></dd> 0281 <dt><code>delim_0</code> 0282 <a name="index-delim_005f0"></a> 0283 </dt> 0284 <dd><p>Delimiter put between a level 0 key and its first page 0285 number. Default: a comma followed by a blank, <code>", "</code>. 0286 </p> 0287 <a name="makeindex-delim-1"></a></dd> 0288 <dt><code>delim_1</code> 0289 <a name="index-delim_005f1"></a> 0290 </dt> 0291 <dd><p>Delimiter put between a level 1 key and its first page 0292 number. Default: a comma followed by a blank, <code>", "</code>. 0293 </p> 0294 <a name="makeindex-delim-2"></a></dd> 0295 <dt><code>delim_2</code> 0296 <a name="index-delim_005f2"></a> 0297 </dt> 0298 <dd><p>Delimiter between a level 2 key and its first page number. Default: 0299 a comma followed by a blank, <code>", "</code>. 0300 </p> 0301 <a name="makeindex-delim-n"></a></dd> 0302 <dt><code>delim_n</code> 0303 <a name="index-delim_005fn"></a> 0304 </dt> 0305 <dd><p>Delimiter between two page numbers for the same key (at any 0306 level). Default: a comma followed by a blank, <code>", "</code>. 0307 </p> 0308 <a name="makeindex-delim-r"></a></dd> 0309 <dt><code>delim_r</code> 0310 <a name="index-delim_005fr"></a> 0311 </dt> 0312 <dd><p>What is put between the starting and ending page numbers of a range. 0313 Default: <code>"--"</code>. 0314 </p> 0315 <a name="makeindex-line-max"></a></dd> 0316 <dt><code>line_max</code> 0317 <a name="index-line_005fmax"></a> 0318 </dt> 0319 <dd><p>An integer. Maximum length of an index entry’s line in the output, 0320 beyond which the line wraps. Default: <code>72</code>. 0321 </p> 0322 <a name="makeindex-indent-space"></a></dd> 0323 <dt><code>indent_space</code> 0324 <a name="index-indent_005fspace"></a> 0325 </dt> 0326 <dd><p>What is inserted at the start of a wrapped line. Default: 0327 <code>"\t\t"</code>. 0328 </p> 0329 <a name="makeindex-indent-length"></a></dd> 0330 <dt><code>indent_length</code> 0331 <a name="index-indent_005flength"></a> 0332 </dt> 0333 <dd><p>A number. The length of the wrapped line indentation. The default 0334 <code>indent_space</code> is two tabs and each tab is eight spaces so the 0335 default here is <code>16</code>. 0336 </p> 0337 <a name="makeindex-page-precedence"></a></dd> 0338 <dt><code>page_precedence</code> 0339 <a name="index-page_005fprecedence"></a> 0340 </dt> 0341 <dd><p>A document may have pages numbered in different ways. For example, a 0342 book may have front matter pages numbered in lowercase roman while main 0343 matter pages are in arabic. This string specifies the order in which 0344 they will appear in the index. The <code>makeindex</code> command supports 0345 five different types of numerals: lowercase roman <code>r</code>, and numeric 0346 or arabic <code>n</code>, and lowercase alphabetic <code>a</code>, and uppercase 0347 roman <code>R</code>, and uppercase alphabetic <code>A</code>. Default: 0348 <code>"rnaRA"</code>. 0349 </p> 0350 </dd> 0351 </dl> 0352 0353 <a name="index-xindy"></a> 0354 <a name="index-xindy-program"></a> 0355 <p>There are a number of other programs that do the job 0356 <code>makeindex</code> does. One is <code>xindy</code>, which does 0357 internationalization and can process indexes for documents marked up 0358 using LaTeX and a number of other languages. It is highly 0359 configurable, both in markup terms and in terms of the collating order 0360 of the text, as described in its documentation. 0361 </p> 0362 0363 0364 0365 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0366 </body> 0367 </html>