Debian Codegraph @

texmf-dist/doc/man/man1/makeglossaries.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "MAKEGLOSSARIES 1"
61 .TH MAKEGLOSSARIES 1 2026-04-24 "perl v5.42.2" "makeglossaries Perl Script"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 makeglossaries \- Calls makeindex/xindy for LaTeX documents using glossaries package
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 \&\fBmakeglossaries\fR [\fB\-o\fR \fIfile\fR] [\fB\-q\fR] [\fB\-Q\fR] [\fB\-k\fR] [\fB\-n\fR]
71 [\fB\-s\fR \fIfile\fR] [\fB\-t\fR \fIfile\fR] [\fB\-L\fR \fIlanguage\fR] [\fB\-c\fR] [\fB\-g\fR] [\fB\-l\fR]
72 [\fB\-p\fR \fInum\fR] [\fB\-r\fR] [\fB\-d\fR \fIaux dir\fR] [\fB\-m\fR \fIfile\fR] [\fB\-x\fR \fIfile\fR]
73 [\fB\-e\fR] [\fB\-\-version\fR] [\fB\-\-help\fR] \fIfilename\fR
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBmakeglossaries\fR is designed for use with LaTeX documents that
77 use the glossaries package.
78 .PP
79 The mandatory argument \fIfilename\fR should be the name of the aux
80 file. The \fB.aux\fR extension may be omitted but is best included where the
81 filename includes additional dots in its name to avoid ambiguity.
82 .PP
83 Alternatively, the \fIfilename\fR may be the name of a
84 specific glossary file if only one glossary should be processed (for
85 example, when working on a draft document). In this case, the aux
86 file is still expected to exist and is inferred from the basename of
87 \&\fIfilename\fR.
88 .PP
89 \&\fBmakeglossaries\fR will read the auxiliary file to determine whether
90 \&\fBmakeindex\fR or \fBxindy\fR should be called. All the information
91 required to be passed to the relevant indexing application should
92 also be contained in the auxiliary file, but may be overridden by
93 the option arguments to \fBmakeglossaries\fR.
94 .SH OPTIONS
95 .IX Header "OPTIONS"
96 .IP \fB\-e\fR 4
97 .IX Item "-e"
98 Don\*(Aqt attempt to repair multiple encaps or illegal page number (\fBmakeindex\fR only).
99 .IP \fB\-c\fR 4
100 .IX Item "-c"
101 Compress intermediate blanks (\fBmakeindex\fR only).
102 .IP "\fB\-d\fR \fIaux dir\fR" 4
103 .IX Item "-d aux dir"
104 Specify the directory the .aux, .glo etc files are located.
105 Defaults to the parent directory of the base file \fIfilename\fR.
106 .IP \fB\-g\fR 4
107 .IX Item "-g"
108 Employ German word ordering (\fBmakeindex\fR only).
109 .IP \fB\-k\fR 4
110 .IX Item "-k"
111 Don\*(Aqt try forking with piped redirection. (Lessens the
112 effect of \-q)
113 .IP \fB\-l\fR 4
114 .IX Item "-l"
115 Letter ordering.
116 .IP "\fB\-L\fR \fIlanguage\fR" 4
117 .IX Item "-L language"
118 This option only has an effect if \fBxindy\fR is called. Sets the
119 language. See \fBxindy\fR documentation for further details.
120 .IP "\fB\-m\fR \fIfile\fR" 4
121 .IX Item "-m file"
122 Specify the full path name for \fBmakeindex\fR to \fIfile\fR in the
123 event that \fBmakeindex\fR isn\*(Aqt on the operating system\*(Aqs path.
124 .IP \fB\-n\fR 4
125 .IX Item "-n"
126 Print the commands that would normally be executed but don\*(Aqt run them.
127 .IP "\fB\-o\fR \fIfile\fR" 4
128 .IX Item "-o file"
129 Use \fIfile\fR as the output file. (Only suitable for documents
130 containing a single glossary, otherwise each glossary will be
131 overridden.)
132 .IP "\fB\-p\fR \fInum\fR" 4
133 .IX Item "-p num"
134 Sets the starting page number to be \fInum\fR (\fBmakeindex\fR only).
135 .IP \fB\-q\fR 4
136 .IX Item "-q"
137 Quiet mode. Reduces chatter to standard output.
138 .IP \fB\-Q\fR 4
139 .IX Item "-Q"
140 Silences warning about being unable to fork.
141 .IP \fB\-r\fR 4
142 .IX Item "-r"
143 .PD 0
144 .IP "\fB\-s\fR \fIfile\fR" 4
145 .IX Item "-s file"
146 .PD
147 Use \fIfile\fR as the style file. Note that if you use this option,
148 you need to know whether \fBmakeindex\fR or \fBxindy\fR will be called, as
149 they have different style files.
150 .IP "\fB\-t\fR \fIfile\fR" 4
151 .IX Item "-t file"
152 Use \fIfile\fR as the transcript file.
153 .Sp
154 Disable implicit page range formation (\fBmakeindex\fR only).
155 .IP "\fB\-x\fR \fIfile\fR" 4
156 .IX Item "-x file"
157 Specify the full path name for \fBxindy\fR to \fIfile\fR in the
158 event that \fBxindy\fR isn\*(Aqt on the operating system\*(Aqs path.
159 .IP \fB\-\-version\fR 4
160 .IX Item "--version"
161 Prints version number and exits.
162 .IP \fB\-\-help\fR 4
163 .IX Item "--help"
164 Prints help message and exits.
165 .SH REQUIRES
166 .IX Header "REQUIRES"
167 Perl, Getopt::Std, and makeindex or xindy (depending on glossaries
168 package options).
169 .SH LICENSE
170 .IX Header "LICENSE"
171 This is free software distributed under the LaTeX Project Public
172 License. There is NO WARRANTY.
173 See <http://www.latex\-project.org/lppl.txt> for details.
174 .SH AUTHOR
175 .IX Header "AUTHOR"
176 Nicola L. C. Talbot,
177 <http://www.dickimaw\-books.com/>
178 .SH "RECOMMENDED READING"
179 .IX Header "RECOMMENDED READING"
180 The glossaries manual:
181 .PP
182 .Vb 1
183 \& texdoc glossaries
184 .Ve