Debian Codegraph @

texmf-dist/doc/man/man1/makeglossaries-lite.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-LITE 1"
61 .TH MAKEGLOSSARIES-LITE 1 2026-04-24 "perl v5.42.2" "makeglossaries-lite Lua 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\-lite \- 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\-n\fR]
71 [\fB\-s\fR \fIfile\fR] [\fB\-t\fR \fIfile\fR] [\fB\-L\fR \fIlanguage\fR] [\fB\-c\fR] [\fB\-g\fR]
72 [\fB\-l\fR] [\fB\-p\fR \fInum\fR] [\fB\-r\fR] [\fB\-m\fR \fIfile\fR] [\fB\-x\fR \fIfile\fR]
73 [\fB\-\-version\fR] [\fB\-\-help\fR] \fIfilename\fR
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBmakeglossaries\-lite\fR is cut\-down Lua alternative to the
77 \&\fBmakeglossaries\fR Perl script. It\*(Aqs designed for use with LaTeX documents that
78 use the glossaries package. Some options that are available to
79 \&\fBmakeglossaries\fR aren\*(Aqt available with \fBmakeglossaries\-lite\fR.
80 .PP
81 The mandatory argument \fIfilename\fR should be the name of the aux
82 file. The \fB.aux\fR extension may be omitted except where the
83 filename includes additional dots in its name.
84 .PP
85 Alternatively, the \fIfilename\fR may be the name of a
86 specific glossary file if only one glossary should be processed (for
87 example, when working on a draft document). In this case, the aux
88 file is still expected to exist and is inferred from the basename of
89 \&\fIfilename\fR.
90 .PP
91 \&\fBmakeglossaries\-lite\fR will read the auxiliary file to determine whether
92 \&\fBmakeindex\fR or \fBxindy\fR should be called. All the information
93 required to be passed to the relevant indexing application should
94 also be contained in the auxiliary file, but may be overridden by
95 the option arguments to \fBmakeglossaries\-lite\fR.
96 .SH OPTIONS
97 .IX Header "OPTIONS"
98 .IP \fB\-q\fR 4
99 .IX Item "-q"
100 Quiet mode. Reduces chatter to standard output.
101 .IP \fB\-n\fR 4
102 .IX Item "-n"
103 Print the commands that would normally be executed but don\*(Aqt run
104 them.
105 .IP "\fB\-o\fR \fIfile\fR" 4
106 .IX Item "-o file"
107 Use \fIfile\fR as the output file. (Only suitable for documents
108 containing a single glossary, otherwise each glossary will be
109 overridden.)
110 .IP "\fB\-s\fR \fIfile\fR" 4
111 .IX Item "-s file"
112 Use \fIfile\fR as the style file. Note that if you use this option,
113 you need to know whether \fBmakeindex\fR or \fBxindy\fR will be called, as
114 they have different style files.
115 .IP "\fB\-t\fR \fIfile\fR" 4
116 .IX Item "-t file"
117 Use \fIfile\fR as the transcript file.
118 .IP \fB\-l\fR 4
119 .IX Item "-l"
120 Letter ordering.
121 .IP "\fB\-L\fR \fIlanguage\fR" 4
122 .IX Item "-L language"
123 This option only has an effect if \fBxindy\fR is called. Sets the
124 language. See \fBxindy\fR documentation for further details.
125 .IP \fB\-c\fR 4
126 .IX Item "-c"
127 Compress intermediate blanks (\fBmakeindex\fR only).
128 .IP \fB\-g\fR 4
129 .IX Item "-g"
130 Employ German word ordering (\fBmakeindex\fR only).
131 .IP "\fB\-p\fR \fInum\fR" 4
132 .IX Item "-p num"
133 Sets the starting page number to be \fInum\fR (\fBmakeindex\fR only).
134 .IP \fB\-r\fR 4
135 .IX Item "-r"
136 Disable implicit page range formation (\fBmakeindex\fR only).
137 .IP "\fB\-m\fR \fIfile\fR" 4
138 .IX Item "-m file"
139 Specify the full path name for \fBmakeindex\fR to \fIfile\fR in the
140 event that \fBmakeindex\fR isn\*(Aqt on the operating system\*(Aqs path.
141 .IP "\fB\-x\fR \fIfile\fR" 4
142 .IX Item "-x file"
143 Specify the full path name for \fBxindy\fR to \fIfile\fR in the
144 event that \fBxindy\fR isn\*(Aqt on the operating system\*(Aqs path.
145 .IP \fB\-\-version\fR 4
146 .IX Item "--version"
147 Prints version number and exits.
148 .IP \fB\-\-help\fR 4
149 .IX Item "--help"
150 Prints help message and exits.
151 .SH REQUIRES
152 .IX Header "REQUIRES"
153 texlua and makeindex or xindy (depending on glossaries package options).
154 .SH LICENSE
155 .IX Header "LICENSE"
156 This is free software distributed under the LaTeX Project Public
157 License. There is NO WARRANTY.
158 See <http://www.latex\-project.org/lppl.txt> for details.
159 .SH AUTHOR
160 .IX Header "AUTHOR"
161 Nicola L. C. Talbot,
162 <http://www.dickimaw\-books.com/>
163 .SH "RECOMMENDED READING"
164 .IX Header "RECOMMENDED READING"
165 The glossaries manual:
166 .PP
167 .Vb 1
168 \& texdoc glossaries
169 .Ve