.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .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 .\" .\" 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 "2021-09-23" "perl v5.32.1" "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 for details. .SH "AUTHOR" .IX Header "AUTHOR" Nicola L. C. Talbot, .SH "RECOMMENDED READING" .IX Header "RECOMMENDED READING" The glossaries manual: .PP .Vb 1 \& texdoc glossaries .Ve