home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / useful / dist / text / tex / pastex / man / makeindex.hlp < prev    next >
Text File  |  1991-10-01  |  34KB  |  1,057 lines
  1.  
  2.  
  3.  
  4. MAKEINDEX(1L)     MISC. REFERENCE MANUAL PAGES      MAKEINDEX(1L)
  5.  
  6.  
  7.  
  8. NAME
  9.      makeindex - a general purpose,  formatter-independent  index
  10.      processor
  11.  
  12. SYNOPSIS
  13.      makeindex [-c] [-g] [-i] [-l] [-o ind] [-p  num]  [-q]  [-r]
  14.      [-s sfile] [-t log] [idx0 idx1 idx2...]
  15.  
  16. DESCRIPTION
  17.      The program makeindex  is  a  general  purpose  hierarchical
  18.      index  generator;  it accepts one or more input files (often
  19.      produced by a  text  formatter  such  as  TeX  (tex(1L))  or
  20.      troff(1),  sorts  the  entries,  and produces an output file
  21.      which can be formatted.  The index can have up to three lev-
  22.      els  (0,  1,  and  2)  of subitem nesting.  The way in which
  23.      words are flagged for indexing within the main  document  is
  24.      specific  to the formatter used; makeindex does not automate
  25.      the process of selecting these words.  As the  output  index
  26.      is  hierarchical,  makeindex can be considered complimentary
  27.      to the awk(1)-based make.index(1L)  system  of  Bentley  and
  28.      Kernighan,  which  is  specific  to troff(1), generates non-
  29.      hierarchical indices, and employs a much simpler syntax  for
  30.      indicating  index  entries.   For  illustration  of use with
  31.      troff and TeX, see the section EXAMPLES below.
  32.  
  33.      The formats of the input and output files are specified in a
  34.      style  file; by default, input is assumed to be a .idx file,
  35.      as generated by LaTeX.
  36.  
  37.      Unless specified explicitly, the  base  name  of  the  first
  38.      input  file  (idx0)  is used to determine the names of other
  39.      files.  For each input file name specified, a file  of  that
  40.      name is sought.  If this file is not found and the file name
  41.      has no extension, the extension .idx  is  appended.   If  no
  42.      file with this name is found, makeindex aborts.
  43.  
  44.      For important notes on how to select index keywords, see the
  45.      document  by Lamport cited below.  As an issue separate from
  46.      selecting index keywords, a systematic mechanism for placing
  47.      index  terms in a document is suggested in Index Preparation
  48.      and Processing, a paper cited below.
  49.  
  50. OPTIONS
  51.      -c        Compress intermediate blanks (ignoring leading and
  52.                trailing  blanks and tabs).  By default, blanks in
  53.                the index key are retained.
  54.  
  55.      -g        Employ German  word  ordering  in  the  index,  in
  56.                accord  with  rules  set  forth  in  DIN 5007.  By
  57.                default, makeindex  employs  a  word  ordering  in
  58.                which  precedence  is: symbols, numbers, uppercase
  59.                letters,  lowercase  letters.   The  sequence   in
  60.  
  61.  
  62.  
  63. Sun Release 4.1   Last change: 01 October 1991                  1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MAKEINDEX(1L)     MISC. REFERENCE MANUAL PAGES      MAKEINDEX(1L)
  71.  
  72.  
  73.  
  74.                German   word   ordering  is:  symbols,  lowercase
  75.                letters, uppercase  letters,  numbers.   Addition-
  76.                ally,  this  option enables makeindex to recognize
  77.                the German TeX-commands {"a, "o,  "u  and  "s}  as
  78.                {ae,  oe,  ue  and  ss}  during the sorting of the
  79.                entries.  The quote character must be redefined in
  80.                a style file (for example, redefine quote as '+').
  81.                If the quote character is not redefined, makeindex
  82.                will produce an error message and abort.
  83.  
  84.      -i        Take input from stdin.  When this option is speci-
  85.                fied and -o is not, output is written to stdout.
  86.  
  87.      -l        Letter ordering; by default, word ordering is used
  88.                (see the ORDERING section).
  89.  
  90.      -o ind    Employ ind as the output index file.  By  default,
  91.                the  file  name is created by appending the exten-
  92.                sion .ind to the base name of the first input file
  93.                (idx0).
  94.  
  95.      -p num    Set the starting page number of the  output  index
  96.                file  to  be num (useful when the index file is to
  97.                be formatted separately).  The argument num may be
  98.                numerical or one of the following:
  99.  
  100.                any       The starting page  is  the  last  source
  101.                          page number plus 1.
  102.  
  103.                odd       The starting page is the first odd  page
  104.                          following the last source page number.
  105.  
  106.                even      The starting page is the first even page
  107.                          following the last source page number.
  108.  
  109.                The last source  page  is  obtained  by  searching
  110.                backward in the log file for the first instance of
  111.                a number included within  paired  square  brackets
  112.                ([...]).   If  a page number is missing or the log
  113.                file is not found, no attempt will be made to  set
  114.                the  starting  page  number.   The source log file
  115.                name is determined by appending the extension .log
  116.                to the base name of the first input file (idx0).
  117.  
  118.      -q        Quiet  mode;  send  no  messages  to  stderr.   By
  119.                default,  progress  and error messages are sent to
  120.                stderr as well as to the transcript file.
  121.  
  122.      -r        Disable implicit page range formation; page ranges
  123.                must be created by using explicit range operators;
  124.                see SPECIAL EFFECTS below.  By default,  three  or
  125.                more    successive    pages    are   automatically
  126.  
  127.  
  128.  
  129. Sun Release 4.1   Last change: 01 October 1991                  2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MAKEINDEX(1L)     MISC. REFERENCE MANUAL PAGES      MAKEINDEX(1L)
  137.  
  138.  
  139.  
  140.                abbreviated as a range (e.g. 1-5).
  141.  
  142.      -s sty    Employ sty as the style file  (no  default).   The
  143.                environment  variable  INDEXSTYLE defines the path
  144.                where the style file should be found.
  145.  
  146.      -t log    Employ log as the transcript  file.   By  default,
  147.                the  file  name is created by appending the exten-
  148.                sion .ilg to the base name of the first input file
  149.                (idx0).
  150.  
  151. STYLE FILE
  152.      The style file informs makeindex about  the  format  of  the
  153.      .idx input files and the intended format of the final output
  154.      file; examples appear below.  This file can reside  anywhere
  155.      in  the path defined by the environment variable INDEXSTYLE.
  156.      The style file contains a  list  of  <specifier,  attribute>
  157.      pairs.  There are two types of specifiers: input and output.
  158.      Pairs do not have to appear in any particular order.  A line
  159.      begun by `%' is a comment.  In the following list of specif-
  160.      iers and arguments, <string> is an arbitrary  string  delim-
  161.      ited  by  double  quotes  ("..."), <char> is a single letter
  162.      embraced by single quotes ('...'), and <number> is a  nonne-
  163.      gative  integer.   The maximum length of a <string> is 2048.
  164.      A  literal  backslash  or  quote  must  be  escaped  (by   a
  165.      backslash).   Anything  not specified in the style file will
  166.      be assigned a default value, which is shown at the  head  of
  167.      the rightmost column.
  168.  
  169.   INPUT STYLE SPECIFIERS
  170.      actual <char>            '@'
  171.                               Symbol  indicating  that  the  next
  172.                               entry  is  to  appear in the output
  173.                               file.
  174.  
  175.      arg_close <char>         '}'
  176.                               Closing  delimiter  for  the  index
  177.                               entry argument.
  178.  
  179.      arg_open <char>          '{'
  180.                               Opening  delimiter  for  the  index
  181.                               entry argument.
  182.  
  183.      encap <char>             '|'
  184.                               Symbol indicating that the rest  of
  185.                               the  argument list is to be used as
  186.                               the encapsulating command  for  the
  187.                               page number.
  188.  
  189.      escape <char>            '\\'
  190.                               Symbol which escapes the  following
  191.                               letter, unless its preceding letter
  192.  
  193.  
  194.  
  195. Sun Release 4.1   Last change: 01 October 1991                  3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MAKEINDEX(1L)     MISC. REFERENCE MANUAL PAGES      MAKEINDEX(1L)
  203.  
  204.  
  205.  
  206.