{ "content": [ { "type": "text", "text": "# makeindex (man)\n\n## NAME\n\nmakeindex - a general purpose, formatter-independent index processor\n\n## SYNOPSIS\n\nmakeindex [-c] [-g] [-i] [-l] [-o ind] [-p num] [-q] [-r] [-s sfile] [-t log] [-L] [-T] [idx0\nidx1 idx2...]\n\n## DESCRIPTION\n\nThe program makeindex is a general purpose hierarchical index generator; it accepts one or\nmore input files (often produced by a text formatter such as TeX (tex(1L)) or troff(1), sorts\nthe entries, and produces an output file which can be formatted. The index can have up to\nthree levels (0, 1, and 2) of subitem nesting. The way in which words are flagged for index‐\ning within the main document is specific to the formatter used; makeindex does not automate\nthe process of selecting these words. As the output index is hierarchical, makeindex can be\nconsidered complementary to the awk(1)-based make.index(1L) system of Bentley and Kernighan,\nwhich is specific to troff(1), generates non-hierarchical indices, and employs a much simpler\nsyntax for indicating index entries. For illustration of use with troff and TeX, see the\nsection EXAMPLES below.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (12 subsections)\n- **STYLE FILE**\n- **EXAMPLES** (3 subsections)\n- **ORDERING**\n- **SPECIAL EFFECTS**\n- **FILES**\n- **SEE ALSO**\n- **AUTHOR**\n- **ACKNOWLEDGMENTS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "makeindex", "section": "", "mode": "man", "summary": "makeindex - a general purpose, formatter-independent index processor", "synopsis": "makeindex [-c] [-g] [-i] [-l] [-o ind] [-p num] [-q] [-r] [-s sfile] [-t log] [-L] [-T] [idx0\nidx1 idx2...]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-c", "long": null, "arg": null, "description": "default, blanks in the index key are retained." }, { "flag": "-g", "long": null, "arg": null, "description": "5007. By default, makeindex employs a word ordering in which precedence is: sym‐ bols, numbers, uppercase letters, lowercase letters. The sequence in German word ordering is: symbols, lowercase letters, uppercase letters, numbers. Additionally, this option enables makeindex to recognize the German TeX-commands {\"a, \"o, \"u and \"s} as {ae, oe, ue and ss} during the sorting of the entries. The quote character must be redefined in a style file (for example, redefine quote as '+'). If the quote character is not redefined, makeindex will produce an error message and abort." }, { "flag": "-o", "long": null, "arg": null, "description": "written to stdout." }, { "flag": "-l", "long": null, "arg": null, "description": "" }, { "flag": "-o", "long": null, "arg": null, "description": "pending the extension .ind to the base name of the first input file (idx0)." }, { "flag": "-p", "long": null, "arg": null, "description": "index file is to be formatted separately). The argument num may be numerical or one of the following: any The starting page is the last source page number plus 1. odd The starting page is the first odd page following the last source page number. even The starting page is the first even page following the last source page number. The last source page is obtained by searching backward in the log file for the first instance of a number included within paired square brackets ([...]). If a page number is missing or the log file is not found, no attempt will be made to set the starting page number. The source log file name is determined by appending the extension .log to the base name of the first input file (idx0)." }, { "flag": "-q", "long": null, "arg": null, "description": "are sent to stderr as well as to the transcript file." }, { "flag": "-r", "long": null, "arg": null, "description": "plicit range operators; see SPECIAL EFFECTS below. By default, three or more suc‐ cessive pages are automatically abbreviated as a range (e.g. 1—5)." }, { "flag": "-s", "long": null, "arg": null, "description": "fines the path where the style file should be found." }, { "flag": "-t", "long": null, "arg": null, "description": "ing the extension .ilg to the base name of the first input file (idx0)." }, { "flag": "-L", "long": null, "arg": null, "description": "" }, { "flag": "-T", "long": null, "arg": null, "description": "" } ], "examples": [ "The following example shows a style file called book.ist, which defines an index for a book", "which can be formatted independently of the main source:", "preamble", "\"\\\\documentstyle[12pt]{book}", "\\\\begin{document}", "\\\\begin{theindex}", "{\\\\small\\n\"", "postamble", "\"\\n\\n}", "\\\\end{theindex}", "\\\\end{document}\\n\"", "Assuming that a particular book style requires the index (as well as any chapters) to start", "from an odd page number, and that the input file is named foo.idx, the following command line", "produces output in file footmp.ind:", "makeindex -s book.ist -o footmp.ind -p odd foo", "Here a non-default output file name is used to avoid clobbering the output for the book it‐", "self (presumably foo.dvi, which would have been the default name for the index output file!).", "TROFF EXAMPLE", "A sample control file for creating an index, which we will assume resides in the file sam‐", "ple.ist:", "keyword \"IX:\"", "preamble", "\".\\\\\\\" start of index output", "\\\".\\\\\\\" enter two column mode", ".2C", ".SH", ".ce", "INDEX", ".XS", "INDEX", ".XE", ".R", ".ps 9p", ".vs 11p", ".sp", ".de I1", ".ti 0.25i", "..", ".de I2", ".ti 0.5i", "..\"", "postamble \"\\n.\\\\\\\" end of index output\"", "setpageprefix \"\\n.nr % \"", "setpagesuffix \"\"", "groupskip \"\\n.sp 1.0\"", "headingsflag 1", "headingprefix \"\\n.IS\\n\"", "headingsuffix \"\\n.IE\"", "item0 \"\\n.br\\n\"", "item1 \"\\n.I1\\n\"", "item2 \"\\n.I2\\n\"", "item01 \"\\n.I1\\n\"", "itemx1 \"\\n.I1\\n\"", "item12 \"\\n.I2\\n\"", "itemx2 \"\\n.I2\\n\"", "delim0 \", \"", "delim1 \", \"", "delim2 \", \"", "delimr \"-\"", "delimt \".\"", "encapprefix \"\\\\fB\"", "encapinfix \"\"", "encapsuffix \"\\\\fP\"", "indentspace \"\"", "indentlength 0", "The local macro package may require modification, as in this example of an extension to the", "same name):", ".de IX", ".ie '\\\\n(.z'' .tm IX: \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN}", ".el \\\\!.IX \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN}", "..", "(note that the string {\\\\n(PN} is separated from the rest of the line by a tab. If your lo‐", "cal macro package does not contain this extension, just include those lines at the beginning", "of your file. Here is a simple troff(1) input file, which we will assume is named sam‐", "ple.txt:", "This is a sample file to test the \\fImakeindex\\fP(1L)", "program, and see", ".IX {indexing!programs!C language}", ".IX {makeindex@\\fImakeindex\\fP(1L)}", ".bp", ".rs", ".IX {Knuth}", ".IX {typesetting!computer-aided}", "how well it functions in the \\fItroff\\fP(1) environment.", "Note that index entries are indicated by the .IX macro, which causes the following text to be", "written to stdout along with the current page number.", "CREATING THE INDEX FILE IN THE BOURNE SHELL", "To create an input file for makeindex, in the Bourne shell environment, do the equivalent at", "your site of the command:", "psroff -ms -Tpsc -t sample.txt > /dev/null 2> sample.tmp", "Some sites will require ditroff instead of psroff. To filter out any genuine error messages,", "invoke grep(1):", "grep '^IX: ' sample.tmp > sample.idx", "With UCSF Enhanced troff/TRANSCRIPT, the -I option of psroff(1L) can produce both formatter", "output and an index file:", "psroff -ms -I sample.inp -Tpsc sample.txt", "If it is wished to suppress the formatter output:", "psroff -ms -I sample.inp -Tpsc -t sample.txt > /dev/null", "COMPLETING THE INDEX", "Any of the above procedures leaves the input for makeindex in sample.inp. The next step is", "to invoke makeindex:", "makeindex -s sample.ist sample.idx", "This leaves troff(1)-ready output in the file sample.ind." ], "see_also": [ { "name": "ditroff", "section": "1L", "url": "https://www.chedong.com/phpMan.php/man/ditroff/1L/json" }, { "name": "latex", "section": "1L", "url": "https://www.chedong.com/phpMan.php/man/latex/1L/json" }, { "name": "qsort", "section": "3", "url": "https://www.chedong.com/phpMan.php/man/qsort/3/json" }, { "name": "tex", "section": "1L", "url": "https://www.chedong.com/phpMan.php/man/tex/1L/json" }, { "name": "troff", "section": "1L", "url": "https://www.chedong.com/phpMan.php/man/troff/1L/json" }, { "name": "19", "section": "9", "url": "https://www.chedong.com/phpMan.php/man/19/9/json" }, { "name": "1", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/1/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 26, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-c", "lines": 2, "flag": "-c" }, { "name": "-g", "lines": 9, "flag": "-g" }, { "name": "-i -o", "lines": 2, "flag": "-o" }, { "name": "-l", "lines": 1, "flag": "-l" }, { "name": "-o _", "lines": 2, "flag": "-o" }, { "name": "-p _", "lines": 17, "flag": "-p" }, { "name": "-q", "lines": 2, "flag": "-q" }, { "name": "-r", "lines": 3, "flag": "-r" }, { "name": "-s _", "lines": 2, "flag": "-s" }, { "name": "-t _", "lines": 2, "flag": "-t" }, { "name": "-L", "lines": 1, "flag": "-L" }, { "name": "-T", "lines": 1, "flag": "-T" } ] }, { "name": "STYLE FILE", "lines": 186, "subsections": [] }, { "name": "EXAMPLES", "lines": 1, "subsections": [ { "name": "TeX EXAMPLE", "lines": 73 }, { "name": "-ms", "lines": 37 }, { "name": "CREATING THE INDEX FILE USING UCSF ENHANCED TROFF/TRANSCRIPT", "lines": 17 } ] }, { "name": "ORDERING", "lines": 22, "subsections": [] }, { "name": "SPECIAL EFFECTS", "lines": 219, "subsections": [] }, { "name": "FILES", "lines": 8, "subsections": [] }, { "name": "SEE ALSO", "lines": 19, "subsections": [] }, { "name": "AUTHOR", "lines": 4, "subsections": [] }, { "name": "ACKNOWLEDGMENTS", "lines": 11, "subsections": [] } ], "sections": { "NAME": { "content": "makeindex - a general purpose, formatter-independent index processor\n", "subsections": [] }, "SYNOPSIS": { "content": "makeindex [-c] [-g] [-i] [-l] [-o ind] [-p num] [-q] [-r] [-s sfile] [-t log] [-L] [-T] [idx0\nidx1 idx2...]\n", "subsections": [] }, "DESCRIPTION": { "content": "The program makeindex is a general purpose hierarchical index generator; it accepts one or\nmore input files (often produced by a text formatter such as TeX (tex(1L)) or troff(1), sorts\nthe entries, and produces an output file which can be formatted. The index can have up to\nthree levels (0, 1, and 2) of subitem nesting. The way in which words are flagged for index‐\ning within the main document is specific to the formatter used; makeindex does not automate\nthe process of selecting these words. As the output index is hierarchical, makeindex can be\nconsidered complementary to the awk(1)-based make.index(1L) system of Bentley and Kernighan,\nwhich is specific to troff(1), generates non-hierarchical indices, and employs a much simpler\nsyntax for indicating index entries. For illustration of use with troff and TeX, see the\nsection EXAMPLES below.\n\nThe formats of the input and output files are specified in a style file; by default, input is\nassumed to be a .idx file, as generated by LaTeX.\n\nUnless specified explicitly, the base name of the first input file (idx0) is used to deter‐\nmine the names of other files. For each input file name specified, a file of that name is\nsought. If this file is not found and the file name has no extension, the extension .idx is\nappended. If no file with this name is found, makeindex aborts.\n\nIf exactly one input file was given and no explicit style file was specified using -s,\nmakeindex uses a file with the extension .mst as default style file (when present).\n\nFor important notes on how to select index keywords, see the document by Lamport cited below.\nAs an issue separate from selecting index keywords, a systematic mechanism for placing index\nterms in a document is suggested in Index Preparation and Processing, a paper cited below.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-c", "content": "default, blanks in the index key are retained.\n", "flag": "-c" }, { "name": "-g", "content": "5007. By default, makeindex employs a word ordering in which precedence is: sym‐\nbols, numbers, uppercase letters, lowercase letters. The sequence in German word\nordering is: symbols, lowercase letters, uppercase letters, numbers. Additionally,\nthis option enables makeindex to recognize the German TeX-commands {\"a, \"o, \"u and\n\"s} as {ae, oe, ue and ss} during the sorting of the entries. The quote character\nmust be redefined in a style file (for example, redefine quote as '+'). If the\nquote character is not redefined, makeindex will produce an error message and\nabort.\n", "flag": "-g" }, { "name": "-i -o", "content": "written to stdout.\n", "flag": "-o" }, { "name": "-l", "content": "", "flag": "-l" }, { "name": "-o _", "content": "pending the extension .ind to the base name of the first input file (idx0).\n", "flag": "-o" }, { "name": "-p _", "content": "index file is to be formatted separately). The argument num may be numerical or\none of the following:\n\nany The starting page is the last source page number plus 1.\n\nodd The starting page is the first odd page following the last source page\nnumber.\n\neven The starting page is the first even page following the last source page\nnumber.\n\nThe last source page is obtained by searching backward in the log file for the\nfirst instance of a number included within paired square brackets ([...]). If a\npage number is missing or the log file is not found, no attempt will be made to set\nthe starting page number. The source log file name is determined by appending the\nextension .log to the base name of the first input file (idx0).\n", "flag": "-p" }, { "name": "-q", "content": "are sent to stderr as well as to the transcript file.\n", "flag": "-q" }, { "name": "-r", "content": "plicit range operators; see SPECIAL EFFECTS below. By default, three or more suc‐\ncessive pages are automatically abbreviated as a range (e.g. 1—5).\n", "flag": "-r" }, { "name": "-s _", "content": "fines the path where the style file should be found.\n", "flag": "-s" }, { "name": "-t _", "content": "ing the extension .ilg to the base name of the first input file (idx0).\n", "flag": "-t" }, { "name": "-L", "content": "", "flag": "-L" }, { "name": "-T", "content": "", "flag": "-T" } ] }, "STYLE FILE": { "content": "The style file informs makeindex about the format of the .idx input files and the intended\nformat of the final output file; examples appear below. This file can reside anywhere in the\npath defined by the environment variable INDEXSTYLE. The style file contains a list of\n pairs. There are two types of specifiers: input and output. Pairs do\nnot have to appear in any particular order. A line begun by `%' is a comment. In the fol‐\nlowing list of specifiers and arguments, is an arbitrary string delimited by double\nquotes (\"...\"), is a single letter embraced by single quotes ('...'), and is\na nonnegative integer. The maximum length of a is 2048. A literal backslash or\nquote must be escaped (by a backslash). Anything not specified in the style file will be as‐\nsigned a default value, which is shown at the head of the rightmost column.\n\nINPUT STYLE SPECIFIERS\nactual ´@´\nSymbol indicating that the next entry is to appear in the output\nfile.\n\nargclose ´}´\nClosing delimiter for the index entry argument.\n\nargopen ´{´\nOpening delimiter for the index entry argument.\n\nencap ´|´\nSymbol indicating that the rest of the argument list is to be used\nas the encapsulating command for the page number.\n\nescape ´\\\\´\nSymbol which escapes the following letter, unless its preceding let‐\nter is escape. Note: quote is used to escape the letter which imme‐\ndiately follows it, but if it is preceded by escape, it is treated\nas a ordinary character. These two symbols must be distinct.\n\nkeyword \"\\\\indexentry\"\nCommand which tells makeindex that its argument is an index entry.\n\nlevel ´!´\nDelimiter denoting a new level of subitem.\n\npagecompositor \"-\"\nDelimiter separating parts of a composite page number (see SPECIAL\nEFFECTS below).\n\nquote ´\"´\nNote: quote is used to escape the letter which immediately follows\nit, but if it is preceded by escape, it is treated as a ordinary\ncharacter. These two symbols must be distinct.\n\nrangeclose ´)´\nClosing delimiter indicating the end of an explicit page range.\n\nrangeopen ´(´\nOpening delimiter indicating the beginning of an explicit page\nrange.\n\nOUTPUT STYLE SPECIFIERS\npreamble \"\\\\begin{theindex}\\n\"\nPreamble of output file.\n\npostamble \"\\n\\n\\\\end{theindex}\\n\"\nPostamble of output file.\n\nsetpageprefix \"\\n \\\\setcounter{page}{\"\nPrefix of command which sets the starting page number.\n\nsetpagesuffix \"}\\n\"\nSuffix of command which sets the starting page number.\n\ngroupskip \"\\n\\n \\\\indexspace\\n\"\nVertical space to be inserted before a new group begins.\n\nheadingsflag 0\nFlag indicating treatment of new group headers, which are inserted\nwhen before a new group (symbols, numbers, and the 26 letters): pos‐\nitive values cause an uppercase letter to be inserted between prefix\nand suffix, and negative values cause a lowercase letter to be in‐\nserted (default is 0, which produces no header).\n\nheadingprefix \"\"\nLetter heading prefix to be inserted before a new letter begins.\n\nheadingsuffix \"\"\nLetter heading suffix to be inserted when a new letter begins.\n\nsymheadpositive \n\"Symbols\"\nHeading for symbols to be inserted if headingsflag is positive.\n\nsymheadnegative \n\"symbols\"\nHeading for symbols to be inserted if headingsflag is negative.\n\nnumheadpositive \n\"Numbers\"\nHeading for numbers to be inserted if headingsflag is positive.\n\nnumheadnegative \n\"numbers\"\nHeading for numbers to be inserted if headingsflag is negative.\n\nitem0 \"\\n \\\\item \"\nCommand to be inserted between two primary (level 0) items.\n\nitem1 \"\\n \\\\subitem \"\nCommand to be inserted between two secondary (level 1) items.\n\nitem2 \"\\n \\\\subsubitem \"\nCommand to be inserted between two level 2 items.\n\nitem01 \"\\n \\\\subitem \"\nCommand to be inserted between a level 0 item and a level 1 item.\n\nitemx1 \"\\n \\\\subitem \"\nCommand to be inserted between a level 0 item and a level 1 item,\nwhere the level 0 item does not have associated page numbers.\n\nitem12 \"\\n \\\\subsubitem \"\nCommand to be inserted between a level 1 item and a level 2 item.\n\nitemx2 \"\\n \\\\subsubitem \"\nCommand to be inserted between a level 1 item and a level 2 item,\nwhere the level 1 item does not have associated page numbers.\n\ndelim0 \", \"\nDelimiter to be inserted between a level 0 key and its first page\nnumber (default: comma followed by a blank).\n\ndelim1 \", \"\nDelimiter to be inserted between a level 1 key and its first page\nnumber (default: comma followed by a blank).\n\ndelim2 \", \"\nDelimiter to be inserted between a level 2 key and its first page\nnumber (default: comma followed by a blank).\n\ndelimn \", \"\nDelimiter to be inserted between two page numbers for the same key\nin any level (default: comma followed by a blank).\n\ndelimr \"--\"\nDelimiter to be inserted between the starting and ending page num‐\nbers of a range.\n\ndelimt \"\"\nDelimiter to be inserted at the end of a page list. This delimiter\nhas no effect on entries which have no associated page list.\n\nencapprefix \"\\\\\"\nFirst part of prefix for the command which encapsulates the page\nnumber.\n\nencapinfix \"{\"\nSecond part of prefix for the command which encapsulates the page\nnumber.\n\nencapsuffix \"}\".\nSuffix for the command which encapsulates the page number.\n\npageprecedence \"rnaRA\".\nPage type precedence order. The default specifies: lowercase roman,\nnumeric/arabic, lowercase alphabetic, uppercase roman, uppercase al‐\nphabetic.\n\nlinemax 72\nMaximum length of a line in the output, beyond which a line wraps.\n\nindentspace \"\\t\\t\"\nSpace to be inserted in front of a wrapped line (default: two tabs).\n\nindentlength 16\nLength of indentspace (default: 16, equivalent to 2 tabs).\n\nsuffix2p \"\"\nDelimiter to replace the range delimiter and the second page number\nof a two page list. When present, it overrides delimr. Example:\n\"f.\".\n\nsuffix3p \"\"\nDelimiter to replace the range delimiter and the second page number\nof a three page list. When present, it overrides delimr and suf‐\nfixmp. Example: \"ff.\".\n\nsuffixmp \"\"\nDelimiter to replace the range delimiter and the second page number\nof a multiple page list (three or more pages). When present, it\noverrides delimr. Example: \"f.\".\n", "subsections": [] }, "EXAMPLES": { "content": "", "subsections": [ { "name": "TeX EXAMPLE", "content": "The following example shows a style file called book.ist, which defines an index for a book\nwhich can be formatted independently of the main source:\n\npreamble\n\"\\\\documentstyle[12pt]{book}\n\\\\begin{document}\n\\\\begin{theindex}\n{\\\\small\\n\"\npostamble\n\"\\n\\n}\n\\\\end{theindex}\n\\\\end{document}\\n\"\n\nAssuming that a particular book style requires the index (as well as any chapters) to start\nfrom an odd page number, and that the input file is named foo.idx, the following command line\nproduces output in file footmp.ind:\n\nmakeindex -s book.ist -o footmp.ind -p odd foo\n\nHere a non-default output file name is used to avoid clobbering the output for the book it‐\nself (presumably foo.dvi, which would have been the default name for the index output file!).\n\nTROFF EXAMPLE\nA sample control file for creating an index, which we will assume resides in the file sam‐\nple.ist:\n\nkeyword \"IX:\"\npreamble\n\".\\\\\\\" start of index output\n\\\".\\\\\\\" enter two column mode\n.2C\n.SH\n.ce\nINDEX\n.XS\nINDEX\n.XE\n.R\n.ps 9p\n.vs 11p\n.sp\n.de I1\n.ti 0.25i\n..\n.de I2\n.ti 0.5i\n..\"\npostamble \"\\n.\\\\\\\" end of index output\"\nsetpageprefix \"\\n.nr % \"\nsetpagesuffix \"\"\ngroupskip \"\\n.sp 1.0\"\nheadingsflag 1\nheadingprefix \"\\n.IS\\n\"\nheadingsuffix \"\\n.IE\"\nitem0 \"\\n.br\\n\"\nitem1 \"\\n.I1\\n\"\nitem2 \"\\n.I2\\n\"\nitem01 \"\\n.I1\\n\"\nitemx1 \"\\n.I1\\n\"\nitem12 \"\\n.I2\\n\"\nitemx2 \"\\n.I2\\n\"\ndelim0 \", \"\ndelim1 \", \"\ndelim2 \", \"\ndelimr \"-\"\ndelimt \".\"\nencapprefix \"\\\\fB\"\nencapinfix \"\"\nencapsuffix \"\\\\fP\"\nindentspace \"\"\nindentlength 0\n\nThe local macro package may require modification, as in this example of an extension to the" }, { "name": "-ms", "content": "same name):\n\n.\n.de IX\n.ie '\\\\n(.z'' .tm IX: \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN}\n.el \\\\!.IX \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN}\n..\n\n(note that the string {\\\\n(PN} is separated from the rest of the line by a tab. If your lo‐\ncal macro package does not contain this extension, just include those lines at the beginning\nof your file. Here is a simple troff(1) input file, which we will assume is named sam‐\nple.txt:\n\nThis is a sample file to test the \\fImakeindex\\fP(1L)\nprogram, and see\n.IX {indexing!programs!C language}\n.IX {makeindex@\\fImakeindex\\fP(1L)}\n.bp\n.rs\n.IX {Knuth}\n.IX {typesetting!computer-aided}\nhow well it functions in the \\fItroff\\fP(1) environment.\n\nNote that index entries are indicated by the .IX macro, which causes the following text to be\nwritten to stdout along with the current page number.\n\nCREATING THE INDEX FILE IN THE BOURNE SHELL\nTo create an input file for makeindex, in the Bourne shell environment, do the equivalent at\nyour site of the command:\n\npsroff -ms -Tpsc -t sample.txt > /dev/null 2> sample.tmp\n\nSome sites will require ditroff instead of psroff. To filter out any genuine error messages,\ninvoke grep(1):\n\ngrep '^IX: ' sample.tmp > sample.idx\n" }, { "name": "CREATING THE INDEX FILE USING UCSF ENHANCED TROFF/TRANSCRIPT", "content": "With UCSF Enhanced troff/TRANSCRIPT, the -I option of psroff(1L) can produce both formatter\noutput and an index file:\n\npsroff -ms -I sample.inp -Tpsc sample.txt\n\nIf it is wished to suppress the formatter output:\n\npsroff -ms -I sample.inp -Tpsc -t sample.txt > /dev/null\n\nCOMPLETING THE INDEX\nAny of the above procedures leaves the input for makeindex in sample.inp. The next step is\nto invoke makeindex:\n\nmakeindex -s sample.ist sample.idx\n\nThis leaves troff(1)-ready output in the file sample.ind.\n" } ] }, "ORDERING": { "content": "By default, makeindex assumes word ordering; if the -l option is in effect, letter ordering\nis used. In word ordering, a blank precedes any letter in the alphabet, whereas in letter\nordering, it does not count at all. This is illustrated by the following example:\n\nword order letter order\nsea lion seal\nseal sea lion\n\nNumbers are always sorted in numeric order. For instance,\n\n9 (nine), 123\n10 (ten), see Derek, Bo\n\nLetters are first sorted without regard to case; when words are identical, the uppercase ver‐\nsion precedes its lowercase counterpart.\n\nA special symbol is defined here to be any character not appearing in the union of digits and\nthe English alphabetic characters. Patterns starting with special symbols precede numbers,\nwhich precede patterns starting with letters. As a special case, a string starting with a\ndigit but mixed with non-digits is considered to be a pattern starting with a special charac‐\nter.\n", "subsections": [] }, "SPECIAL EFFECTS": { "content": "Entries such as\n\n\\indexentry{alpha}{1}\n\\indexentry{alpha!beta}{3}\n\\indexentry{alpha!beta!gamma}{10}\n\nin the input file will be converted to\n\n\\item alpha, 1\n\\subitem beta, 3\n\\subsubitem gamma, 10\n\nin the output index file. Notice that the level symbol (`!') is used above to delimit hier‐\narchical levels.\n\nIt is possible to make an item appear in a designated form by using the actual (`@') opera‐\ntor. For instance,\n\n\\indexentry{alpha@{\\it alpha\\/}}{1}\n\nwill become\n\n\\item {\\it alpha\\/}, 1\n\nafter processing. The pattern preceding `@' is used as sort key, whereas the one following\nit is written to the output file. Note that two appearances of the same key, one with and\none without the actual operator, are regarded as distinct entries.\n\nThe item, subitem, and subsubitem fields may have individual sort keys:\n\n\\indexentry{aa@{\\it aa\\/}!bb@{\\it bb\\/}!cc@{\\it cc\\/}}{1}\n\nThis will be converted to\n\n\\item {\\it aa}, 1\n\\subitem {\\it bb}, 3\n\\subsubitem {\\it cc}, 10\n\nIt is possible to encapsulate a page number with a designated command using the encap (`|')\noperator:\n\n\\indexentry{alpha|bold}{1}\n\nwill be converted to\n\n\\item alpha, \\bold{1}\n\nwhere, with a suitable definition for TeX, \\bold{n} will expand to {\\bf n}. In this example,\nthe three output attributes associated with page encapsulation encapprefix, encapinfix, and\nencapsuffix, correspond to backslash, left brace, and right brace, respectively. This mech‐\nanism allows page numbers to be set in different fonts. For example, the page where the def‐\ninition of a keyword appears can be in one font, the location of a primary example can be in\nanother font, and other appearances in yet a third font.\n\nThe encap operator can also be used to create cross references in the index:\n\n\\indexentry{alpha|see{beta}}{1}\n\nwill become\n\n\\item alpha, \\see{beta}{1}\n\nin the output file, where\n\n\\see{beta}{1}\n\nwill expand to\n\n{\\it see\\/} beta\n\nNote that in a cross reference like this the page number disappears.\n\nA pair of encap concatenated with rangeopen (`|(') and rangeclose (`|)') creates an ex‐\nplicit page range:\n\n\\indexentry{alpha|(}{1}\n\\indexentry{alpha|)}{5}\n\nwill become\n\n\\item alpha, 1—5\n\nIntermediate pages indexed by the same key will be merged into the range implicitly. This is\nespecially useful when an entire section about a particular subject is to be indexed, in\nwhich case only the range opening and closing operators need to be inserted at the beginning\nand end of the section. Explicit page range formation can also include an extra command to\nset the page range in a designated font:\n\n\\indexentry{alpha|(bold}{1}\n\\indexentry{alpha|)}{5}\n\nwill become\n\n\\item alpha, \\bold{1--5}\n\nSeveral potential problems are worth mentioning. First, entries like\n\n\\indexentry{alpha|(}{1}\n\\indexentry{alpha|bold}{3}\n\\indexentry{alpha|)}{5}\n\nwill be interpreted as\n\n\\item alpha, \\bold{3}, 1--5\n\nbut with a warning message in the transcript about encountering an inconsistent page encapsu‐\nlator. An explicit range beginning in a Roman page number and ending in Arabic is also con‐\nsidered an error. In this instance, (if possible) the range is broken into two subranges,\none in Roman and the other in Arabic. For instance,\n\n\\indexentry{alpha|(}{i}\n\\indexentry{alpha}{iv}\n\\indexentry{alpha}{3}\n\\indexentry{alpha|)}{7}\n\nwill be turned into\n\n\\item alpha, i--iv, 3--7\n\nwith a warning message in the transcript file complaining about an illegal range formation.\n\nEvery special symbol mentioned in this section may be escaped by the quote operator (`\"').\nThus\n\n\\indexentry{alpha\"@beta}{1}\n\nwill actually become\n\n\\item alpha@beta, 1\n\nas a result of executing makeindex. The quoting power of quote is eliminated if it is imme‐\ndiately preceded by escape (`\\'). For example,\n\n\\indexentry{f\\\"ur}{1}\n\nbecomes\n\n\\item f\\\"ur, 1\n\nwhich represents an umlaut-accented `u' to the TeX family of processors.\n\nA page number can be a composite of one or more fields separated by the delimiter bound to\npagecompositor (`-'), e.g., II-12 for page 12 of Chapter II. Page numbers may contain up to\nten fields.\n\nSince version 2.11 of makeindex, the quote operator may quote any character in the range 1\n... 255. Character 0 is excluded because it is used internally in the makeindex source code\nas a string terminator. With this change, sort keys can be created for all eight-bit charac‐\nters except 0. The sorting order is\n\npunctuation characters (in ASCII order),\ndigits,\ncontrol characters (1 ... 31),\nspace (32),\nletters (ignoring case),\ncharacters 127 ... 255.\n\nHere is an example showing the indexing of all printable ASCII characters other than letters\nand digits, assuming the default TeX format. For convenience, the page number references are\nthe corresponding ASCII ordinal values.\n\n\\indexentry{\" @\" (space)}{32}\n\\indexentry{\"!@\"! (exclamation point)}{33}\n\\indexentry{\"\"@\"\" (quotation mark)}{34}\n\\indexentry{\"#@\"\\# (sharp sign)}{35}\n\\indexentry{\"$@\"\\$ (dollar sign)}{36}\n\\indexentry{\"%@\"\\% (percent sign)}{37}\n\\indexentry{\"&@\"\\& (ampersand)}{38}\n\\indexentry{\"<@\"$<$ (left angle bracket)}{60}\n\\indexentry{\"=@\"= (equals)}{61}\n\\indexentry{\">@\"$>$ (right angle bracket)}{62}\n\\indexentry{\"?@\"? (query)}{63}\n\\indexentry{\"@@\"@ (at sign)}{64}\n\\indexentry{\"[@\"[ (left square bracket)}{91}\n\\indexentry{\"\\@\"\\verb=\\= (backslash)}{92}\n\\indexentry{\"]@\"] (right square bracket)}{93}\n\\indexentry{\"^@\"\\verb=^= (caret)}{94}\n\\indexentry{\"@\"\\verb== (underscore)}{95}\n\\indexentry{\"`@\"\\verb=~= (grave accent)}{96}\n\\indexentry{\"{@\"\\\"{ (left brace)}{123}\n\\indexentry{\"|@\"\\verb=\"|= (vertical bar)}{124}\n\\indexentry{\"}@\"\\\"} (right brace)}{125}\n\\indexentry{\"~@\"\\verb=~= (tilde)}{126}\n\nCharacters in the actual fields following the `@' character which have special significance\nto TeX must be represented as control sequences, or as math mode characters. Note particu‐\nlarly how the entries for the at sign, left and right braces, and the vertical bar, are\ncoded. The index file output by makeindex for this example looks like this:\n\n\\begin{theindex}\n\n\\item ! (exclamation point), 33\n\\item \" (quotation mark), 34\n\\item \\# (sharp sign), 35\n\\item \\$ (dollar sign), 36\n\\item \\% (percent sign), 37\n\\item \\& (ampersand), 38\n\\item $<$ (left angle bracket), 60\n\\item = (equals), 61\n\\item $>$ (right angle bracket), 62\n\\item ? (query), 63\n\\item @ (at sign), 64\n\\item [ (left square bracket), 91\n\\item \\verb=\\= (backslash), 92\n\\item ] (right square bracket), 93\n\\item \\verb=^= (caret), 94\n\\item \\verb== (underscore), 95\n\\item \\verb=~= (grave accent), 96\n\\item \\{ (left brace), 123\n\\item \\verb=|= (vertical bar), 124\n\\item \\} (right brace), 125\n\\item \\verb=~= (tilde), 126\n\n\\indexspace\n\n\\item (space), 32\n\n\\end{theindex}\n", "subsections": [] }, "FILES": { "content": "makeindex executable file\n\n$TEXMFMAIN/tex/plain/makeindex/idxmac.tex\nTeX macro file used by makeindex\n\n$TEXMFMAIN/tex/latex/base/makeidx.sty\nTeX macro file used by makeindex\n", "subsections": [] }, "SEE ALSO": { "content": "ditroff(1L), latex(1L), make.index (1L), qsort(3), tex(1L), troff(1L)\n\nUCSF Enhanced troff/TRANSCRIPT — An Overview, R. P. C. Rodgers and Conrad Huang, LSMB Techni‐\ncal Report 90-2, UCSF School of Pharmacy, San Francisco, 1990.\n\nIndex Preparation and Processing, Pehong Chen and Michael A. Harrison, Software: Practice and\nExperience, 19(9), 897–915, September 1988.\n\nAutomating Index Preparation, Pehong Chen and Michael A. Harrison. Technical Report 87/347,\nComputer Science Division, University of California, Berkeley, 1987 (a LaTeX document sup‐\nplied with makeindex).\n\nMakeIndex: An Index Processor for LaTeX, Leslie Lamport, February 1987 (a LaTeX document sup‐\nplied with makeindex).\n\nTools for Printing Indices, Jon L. Bentley and Brian W. Kernighan, Electronic Publishing —\nOrigination, Dissemination, and Design, 1(1), 3–18, June 1988 (also available as: Computing\nScience Technical Report No. 128, AT&T Bell Laboratories, Murray Hill, NJ 07974, 1986).\n", "subsections": [] }, "AUTHOR": { "content": "Pehong Chen, Chen & Harrison International Systems, Inc. Palo Alto, California, USA.\nManual page extensively revised and corrected, and troff(1) examples created by Rick P. C.\nRodgers, UCSF School of Pharmacy.\n", "subsections": [] }, "ACKNOWLEDGMENTS": { "content": "Leslie Lamport contributed significantly to the design of MakeIndex. Michael Harrison pro‐\nvided valuable comments and suggestions. Nelson Beebe improved on the portable version, and\nmaintained the source distribution for the TeX Users Group for many years. Andreas Brosig\ncontributed to the German word ordering. The modification to the -ms macros was derived from\na method proposed by Ravi Sethi of AT&T Bell Laboratories. The LOG and CONTRIB files in the\nmakeindex source distribution record other contributions.\n\nmakeindex is currently maintained as part of the TeX Live distribution\n(http://tug.org/texlive); please send bug reports to tex-k@tug.org.\n\nTeX Live 12 November 2014 MAKEINDEX(1)", "subsections": [] } } } }