.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "MAKEGLOSSARIES 1"
.TH MAKEGLOSSARIES 1 2024-11-09 "perl v5.40.0" "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\-e\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\-e\fR 4
.IX Item "-e"
Don\*(Aqt attempt to repair multiple encaps or illegal page number (\fBmakeindex\fR only).
.IP \fB\-c\fR 4
.IX Item "-c"
Compress intermediate blanks (\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\-g\fR 4
.IX Item "-g"
Employ German word ordering (\fBmakeindex\fR only).
.IP \fB\-k\fR 4
.IX Item "-k"
Don\*(Aqt try forking with piped redirection. (Lessens the
effect of \-q)
.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\-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\*(Aqt on the operating system\*(Aqs path.
.IP \fB\-n\fR 4
.IX Item "-n"
Print the commands that would normally be executed but don\*(Aqt 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\-p\fR \fInum\fR" 4
.IX Item "-p num"
Sets the starting page number to be \fInum\fR (\fBmakeindex\fR only).
.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\-r\fR 4
.IX Item "-r"
.PD 0
.IP "\fB\-s\fR \fIfile\fR" 4
.IX Item "-s file"
.PD
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.
.Sp
Disable implicit page range formation (\fBmakeindex\fR only).
.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\*(Aqt on the operating system\*(Aqs 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 NO WARRANTY.
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