1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MAKEGLOSSARIES 1"
.TH MAKEGLOSSARIES 1 "2018-06-01" "perl v5.26.2" "makeglossaries Perl Script"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
makeglossaries \- Calls makeindex/xindy for LaTeX documents using glossaries package
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBmakeglossaries\fR [\fB\-o\fR \fIfile\fR] [\fB\-q\fR] [\fB\-Q\fR] [\fB\-k\fR] [\fB\-n\fR]
[\fB\-s\fR \fIfile\fR] [\fB\-t\fR \fIfile\fR] [\fB\-L\fR \fIlanguage\fR] [\fB\-c\fR] [\fB\-g\fR] [\fB\-l\fR]
[\fB\-p\fR \fInum\fR] [\fB\-r\fR] [\fB\-d\fR \fIaux dir\fR] [\fB\-m\fR \fIfile\fR] [\fB\-x\fR \fIfile\fR]
[\fB\-\-version\fR] [\fB\-\-help\fR] \fIbasename\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBmakeglossaries\fR is designed for use with LaTeX documents that
use the glossaries package. The mandatory argument \fIbasename\fR should
be the name of the LaTeX document without the .tex extension.
\&\fBmakeglossaries\fR will read the auxiliary file to determine whether
\&\fBmakeindex\fR or \fBxindy\fR should be called. All the information
required to be passed to the relevant indexing application should
also be contained in the auxiliary file, but may be overridden by
the option arguments to \fBmakeglossaries\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-q\fR" 4
.IX Item "-q"
Quiet mode. Reduces chatter to standard output.
.IP "\fB\-Q\fR" 4
.IX Item "-Q"
Silences warning about being unable to fork.
.IP "\fB\-k\fR" 4
.IX Item "-k"
Don't try forking with piped redirection. (Lessens the
effect of \-q)
.IP "\fB\-n\fR" 4
.IX Item "-n"
Print the commands that would normally be executed but don't run them.
.IP "\fB\-o\fR \fIfile\fR" 4
.IX Item "-o file"
Use \fIfile\fR as the output file. (Only suitable for documents
containing a single glossary, otherwise each glossary will be
overridden.)
.IP "\fB\-s\fR \fIfile\fR" 4
.IX Item "-s file"
Use \fIfile\fR as the style file. Note that if you use this option,
you need to know whether \fBmakeindex\fR or \fBxindy\fR will be called, as
they have different style files.
.IP "\fB\-t\fR \fIfile\fR" 4
.IX Item "-t file"
Use \fIfile\fR as the transcript file.
.IP "\fB\-l\fR" 4
.IX Item "-l"
Letter ordering.
.IP "\fB\-L\fR \fIlanguage\fR" 4
.IX Item "-L language"
This option only has an effect if \fBxindy\fR is called. Sets the
language. See \fBxindy\fR documentation for further details.
.IP "\fB\-c\fR" 4
.IX Item "-c"
Compress intermediate blanks (\fBmakeindex\fR only).
.IP "\fB\-g\fR" 4
.IX Item "-g"
Employ German word ordering (\fBmakeindex\fR only).
.IP "\fB\-p\fR \fInum\fR" 4
.IX Item "-p num"
Sets the starting page number to be \fInum\fR (\fBmakeindex\fR only).
.IP "\fB\-r\fR" 4
.IX Item "-r"
Disable implicit page range formation (\fBmakeindex\fR only).
.IP "\fB\-d\fR \fIaux dir\fR" 4
.IX Item "-d aux dir"
Specify the directory the .aux, .glo etc files are located.
Defaults to the parent directory of the base file \fIfilename\fR.
.IP "\fB\-m\fR \fIfile\fR" 4
.IX Item "-m file"
Specify the full path name for \fBmakeindex\fR to \fIfile\fR in the
event that \fBmakeindex\fR isn't on the operating system's path.
.IP "\fB\-x\fR \fIfile\fR" 4
.IX Item "-x file"
Specify the full path name for \fBxindy\fR to \fIfile\fR in the
event that \fBxindy\fR isn't on the operating system's path.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Prints version number and exits.
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Prints help message and exits.
.SH "REQUIRES"
.IX Header "REQUIRES"
Perl, Getopt::Std, and makeindex or xindy (depending on glossaries
package options).
.SH "LICENSE"
.IX Header "LICENSE"
This is free software distributed under the LaTeX Project Public
License. There is \s-1NO WARRANTY.\s0
See <http://www.latex\-project.org/lppl.txt> for details.
.SH "AUTHOR"
.IX Header "AUTHOR"
Nicola L. C. Talbot,
<http://www.dickimaw\-books.com/>
.SH "RECOMMENDED READING"
.IX Header "RECOMMENDED READING"
The glossaries manual:
.PP
.Vb 1
\& texdoc glossaries
.Ve
|
