Debian Codegraph @

texmf-dist/source/latex/glossaries/makeglossaries-lite.pod

raw
1 =head1 NAME
2
3 makeglossaries-lite - Calls makeindex/xindy for LaTeX documents using glossaries package
4
5 =head1 SYNOPSIS
6
7 B<makeglossaries> [B<-o> I<file>] [B<-q>] [B<-n>]
8 [B<-s> I<file>] [B<-t> I<file>] [B<-L> I<language>] [B<-c>] [B<-g>]
9 [B<-l>] [B<-p> I<num>] [B<-r>] [B<-m> I<file>] [B<-x> I<file>]
10 [B<--version>] [B<--help>] I<filename>
11
12 =head1 DESCRIPTION
13
14 B<makeglossaries-lite> is cut-down Lua alternative to the
15 B<makeglossaries> Perl script. It's designed for use with LaTeX documents that
16 use the glossaries package. Some options that are available to
17 B<makeglossaries> aren't available with B<makeglossaries-lite>.
18
19 The mandatory argument I<filename> should be the name of the aux
20 file. The B<.aux> extension may be omitted except where the
21 filename includes additional dots in its name.
22
23 Alternatively, the I<filename> may be the name of a
24 specific glossary file if only one glossary should be processed (for
25 example, when working on a draft document). In this case, the aux
26 file is still expected to exist and is inferred from the basename of
27 I<filename>.
28
29 B<makeglossaries-lite> will read the auxiliary file to determine whether
30 B<makeindex> or B<xindy> should be called. All the information
31 required to be passed to the relevant indexing application should
32 also be contained in the auxiliary file, but may be overridden by
33 the option arguments to B<makeglossaries-lite>.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-q>
40
41 Quiet mode. Reduces chatter to standard output.
42
43 =item B<-n>
44
45 Print the commands that would normally be executed but don't run
46 them.
47
48 =item B<-o> I<file>
49
50 Use I<file> as the output file. (Only suitable for documents
51 containing a single glossary, otherwise each glossary will be
52 overridden.)
53
54 =item B<-s> I<file>
55
56 Use I<file> as the style file. Note that if you use this option,
57 you need to know whether B<makeindex> or B<xindy> will be called, as
58 they have different style files.
59
60 =item B<-t> I<file>
61
62 Use I<file> as the transcript file.
63
64 =item B<-l>
65
66 Letter ordering.
67
68 =item B<-L> I<language>
69
70 This option only has an effect if B<xindy> is called. Sets the
71 language. See B<xindy> documentation for further details.
72
73 =item B<-c>
74
75 Compress intermediate blanks (B<makeindex> only).
76
77 =item B<-g>
78
79 Employ German word ordering (B<makeindex> only).
80
81 =item B<-p> I<num>
82
83 Sets the starting page number to be I<num> (B<makeindex> only).
84
85 =item B<-r>
86
87 Disable implicit page range formation (B<makeindex> only).
88
89 =item B<-m> I<file>
90
91 Specify the full path name for B<makeindex> to I<file> in the
92 event that B<makeindex> isn't on the operating system's path.
93
94 =item B<-x> I<file>
95
96 Specify the full path name for B<xindy> to I<file> in the
97 event that B<xindy> isn't on the operating system's path.
98
99 =item B<--version>
100
101 Prints version number and exits.
102
103 =item B<--help>
104
105 Prints help message and exits.
106
107 =back
108
109 =head1 REQUIRES
110
111 texlua and makeindex or xindy (depending on glossaries package options).
112
113 =head1 LICENSE
114
115 This is free software distributed under the LaTeX Project Public
116 License. There is NO WARRANTY.
117 See L<http://www.latex-project.org/lppl.txt> for details.
118
119 =head1 AUTHOR
120
121 Nicola L. C. Talbot,
122 L<http://www.dickimaw-books.com/>
123
124 =head1 RECOMMENDED READING
125
126 The glossaries manual:
127
128 texdoc glossaries
129 =cut