makeglossaries(1)

1MAKEGLOSSARIES(1)         makeglossaries Perl Script         MAKEGLOSSARIES(1)
2
3
4

NAME

6       makeglossaries  - Calls makeindex/xindy for LaTeX documents using
7       glossaries package
8

SYNOPSIS

10       makeglossaries [-o file] [-q] [-Q] [-k] [-n] [-s file] [-t file] [-L
11       language] [-c] [-g] [-l] [-p num] [-r] [-d aux dir] [-m file] [-x file]
12       [-e] [--version] [--help] basename
13

DESCRIPTION

15       makeglossaries is designed for use with LaTeX documents that use the
16       glossaries package. The mandatory argument basename should be the name
17       of the LaTeX document without the .tex extension.  makeglossaries will
18       read the auxiliary file to determine whether makeindex or xindy should
19       be called. All the information required to be passed to the relevant
20       indexing application should also be contained in the auxiliary file,
21       but may be overridden by the option arguments to makeglossaries.
22

OPTIONS

24       -e  Don't attempt to repair multiple encaps or illegal page number
25           (makeindex only).
26
27       -c  Compress intermediate blanks (makeindex only).
28
29       -d aux dir
30           Specify the directory the .aux, .glo etc files are located.
31           Defaults to the parent directory of the base file filename.
32
33       -g  Employ German word ordering (makeindex only).
34
35       -k  Don't try forking with piped redirection. (Lessens the effect of
36           -q)
37
38       -l  Letter ordering.
39
40       -L language
41           This option only has an effect if xindy is called. Sets the
42           language. See xindy documentation for further details.
43
44       -m file
45           Specify the full path name for makeindex to file in the event that
46           makeindex isn't on the operating system's path.
47
48       -n  Print the commands that would normally be executed but don't run
49           them.
50
51       -o file
52           Use file as the output file. (Only suitable for documents
53           containing a single glossary, otherwise each glossary will be
54           overridden.)
55
56       -p num
57           Sets the starting page number to be num (makeindex only).
58
59       -q  Quiet mode. Reduces chatter to standard output.
60
61       -Q  Silences warning about being unable to fork.
62
63       -r
64       -s file
65           Use file as the style file. Note that if you use this option, you
66           need to know whether makeindex or xindy will be called, as they
67           have different style files.
68
69       -t file
70           Use file as the transcript file.
71
72           Disable implicit page range formation (makeindex only).
73
74       -x file
75           Specify the full path name for xindy to file in the event that
76           xindy isn't on the operating system's path.
77
78       --version
79           Prints version number and exits.
80
81       --help
82           Prints help message and exits.
83

REQUIRES

85       Perl, Getopt::Std, and makeindex or xindy (depending on glossaries
86       package options).
87

LICENSE

89       This is free software distributed under the LaTeX Project Public
90       License. There is NO WARRANTY.  See
91       <http://www.latex-project.org/lppl.txt> for details.
92

AUTHOR

94       Nicola L. C. Talbot, <http://www.dickimaw-books.com/>
95