1BIB2GLS(1) bib2gls BIB2GLS(1)
2
6 bib2gls [option]+ auxfile
7
9 bib2gls is designed to work with the glossaries-extra LaTeX package.
10 (The record package option is required.) The application performs two
11 functions in one: (1) selects entries from .bib files according to
12 information found in the auxfile (similar to bibtex); (2)
13 hierarchically sorts entries and collates location lists (similar to
14 makeindex and xindy). The .aux extension may be omitted from auxfile.
15 The auxfile (and corresponding .log file) should either be in the
17 current directory or in the directory specified by --dir. Bib files can
18 either be relative to the directory the auxfile is in or in a location
19 that can be found by kpsewhich.
20
22 --help or -h
23 Display help message and exit.
24 --version or -v
26 Display version information and exit.
27 --debug [level]
29 Switch on the debug mode (optionally at the given level, which
30 should be a non-negative integer). If level is 0 then the debug
31 mode is switched off.
32 --no-debug (or --nodebug)
34 Switch off debug mode. (Equivalent to --debug 0)
35 --verbose
37 Switch on verbose mode.
38 --no-verbose (or --noverbose)
40 Switch off verbose mode. (Some messages will still be written to
41 STDOUT.)
42 --silent
44 Only display error messages. All other messages are just written to
45 the transcript file.
46 --locale lang (or -l lang)
48 Use language resource file for lang (which should be an IETF locale
49 tag).
50 --log-file file (or -t <file>)
52 Set the transcript file.
53 --dir directory (or -d <directory>)
55 Files are relative to directory. (This doesn't change the current
56 working directory.)
57 --tex-encoding name
59 Set the character encoding for the output files. This overrides the
60 setting given in auxfile.
61 --interpret
63 Use the TeX parser library to interpret known (La)TeX commands
64 (default).
65 --no-interpret
67 Don't try interpreting (La)TeX commands.
68 --break-space
70 Interpret "~" (tilde) character and "\nobreakspace" as a normal
71 space.
72 --no-break-space
74 Interpret "~" (tilde) and "\nobreakspace" as a non-breaking space
75 (default).
76 --obey-aux-catcode
78 Obey known category code changing commands encountered in the aux
79 file.
80 --no-obey-aux-catcode
82 Ignore category code changing commands encountered in the aux file.
83 --cite-as-record
85 Treat "\citation" as an ignored record.
86 --no-cite-as-record
88 Don't check for instances of "\citation" in the .aux file
89 (default).
90 --warn-non-bib-fields
92 Warn if internal non-bib fields are found in the .bib file.
93 --no-warn-non-bib-fields
95 Don't warn if internal non-bib fields are found in the .bib file.
96 The use of these internal fields can cause unexpected results, so
97 only use this option if you have taken appropriate precautions.
98 --warn-unknown-entry-types
100 Warn if any unknown entry types are found in the .bib file.
101 --no-warn-unknown-entry-types
103 Don't warn if any unknown entry types are found in the .bib file.
104 --merge-wrglossary-records
106 Merge an entry's wrglossary records for the same page locations.
107 (For use with the indexcounter package option.)
108 --no-merge-wrglossary-records
110 Don't merge an entry's wrglossary records.
111 --collapse-same-location-range
113 Collapse an explicit range that has a duplicate start and end
114 location into a normal record (default).
115 --no-collapse-same-location-range
117 Don't collapse an explicit range that has a duplicate start and end
118 location into a normal record.
119 --retain-formats list
121 Indicates which location formats should always be retained even if
122 it causes a partial duplicate. Only exact duplicates will be
123 merged.
124 --no-retain-formats
126 Normal location merging rules apply (default).
127 --merge-nameref-on rule
129 Rule for merging locations created with the record=nameref package
130 option (requires glossaries-extra.sty version 1.37+). The rule may
131 be one of: hcounter, href, title or location.
132 --force-cross-resource-refs or -x
134 Force cross-resource referencing mode on.
135 --no-force-cross-resource-refs
137 Don't force cross-resource referencing mode on (default).
138 --support-unicode-script
140 Text superscript ("\textsuperscript") or subscripts
141 ("\textsubscript") will use Unicode superscript/subscript
142 characters if available. For example, "\textsuperscript{2}" will
143 be converted to U+00B2 (superscript two).
144 --no-support-unicode-script
146 Text superscript ("\textsuperscript") or subscripts
147 ("\textsubscript") won't be converted to Unicode
148 superscript/subscript characters. For example,
149 "\textsuperscript{2}" will be converted to "<sup>2</sup>" and the
150 markup will be stripped leaving just the character 2.
151 --packages list (or -p list)
153 Instruct the TeX parser library to pretend the packages listed in
154 list have been used by the document. Note that there's only a
155 limited number of packages supported by the TeX parser library.
156 This option has a cumulative action so --packages wasysym,pifont is
157 the same as --packages wasysym --packages pifont.
158 You can find out the list of supported packages with
160 --list-known-packages.
161 --custom-packages list
163 Instruct the TeX parser library to attempt to parse the packages
164 listed in list. This is intended for simple custom packages that
165 don't contain complex code.
166 --ignore-packages list (or -k list)
168 Don't parse the log file for the packages listed in list. Note that
169 --packages overrides this option, so if the same package is listed
170 in both --ignore-packages and --packages then the interpreter will
171 check if it's supported. This option has a cumulative action. Only
172 known packages may be included in list.
173 --list-known-packages
175 Lists all the packages that have are known to the TeX parser
176 library and then exits (with exit code 0). Any of the listed
177 packages may be used in --packages or --ignore-packages.
178 --mfirstuc-protection fields|all (or -u fields|all)
180 Insert an empty group if fields start with certain problematic
181 commands to protect against case-changing commands like "\Gls".
182 The default is to do this for all fields. To do this for only a
184 subset of fields, set fields to a comma-separated list of fields
185 (e.g. name,short,long). The keyword all indicates all fields.
186 If mfirstuc v2.08+, glossaries v4.50+ and glossaries-extra v1.49+
188 are detected, the default will be --no-mfirstuc-protection as there
189 should no longer be any need for this protection.
190 --no-mfirstuc-protection
192 Switch off the auto-insertion of an empty group for all fields.
193 --mfirstuc-math-protection
195 Switch on the auto-insertion of an empty group for math-shift
196 ("$").
197 If mfirstuc v2.08+, glossaries v4.50+ and glossaries-extra v1.49+
199 are detected, the default will be --no-mfirstuc-math-protection as
200 there should no longer be any need for this protection.
201 --no-mfirstuc-math-protection
203 Switch off the auto-insertion of an empty group for math-shift
204 ("$").
205 --nested-link-check list|none
207 Check each field listed in list for potentially problematic nested
208 link text. (Default list: name, text, plural, first, firstplural,
209 short, shortplural, long, longplural, symbol).
210 If none, disable check.
212 --no-nested-link-check
214 Don't check for potentially problematic nested link text.
215 (Equivalent to --nested-link-check none)
216 --shortcuts option
218 Check for the shortcut commands when searching for dependencies.
219 Permitted values of option: acronyms (or acro), ac, abbreviations
220 (or abbr), all (or true), none (or false). This overrides the
221 setting given in auxfile.
222 --map-format key:value[,key:value]* (or -m key:value[,key:value]*)
224 Set location format mappings.
225 --group or -g
227 Add group field to entries.
228 --no-group
230 Don't add group field to entries (default).
231 --record-count-rule rule or -r rule
233 Sets the rule used by --record-count and --record-count-unit. This
234 option automatically implements --record-count.
235 The rule may be: "all" or "a" (count all records), "non-ignored" or
237 "n" (count all non-ignored records), "f/"regex"/" (only count
238 records where the format matches the regular expression regex),
239 "c/"regex"/" (only count records where the counter name matches the
240 regular expression regex), or "f/"regex1"/c/"regex2"/"op (only
241 count records where the format matches the regular expression
242 regex1 and/or the counter name matches the regular expression
243 regex2). The op part is optional. If present it may be one of:
244 "and" (format AND counter must match), "or" (format OR counter must
245 match). If op is omitted, AND is assumed.
246 --record-count or -c
248 Add record count fields to entries.
249 --no-record-count
251 Don't add record count field to entries (default). This option
252 automatically implements --no-record-count-unit.
253 --record-count-unit or -n
255 Add unit record count fields to entries. This option automatically
256 implements --record-count.
257 --no-record-count-unit
259 Don't add unit record count field to entries (default).
260 --trim-fields
262 Trim leading and trailing spaces from all fields. This option
263 cancels --trim-only-fields and --no-trim-fields.
264 --trim-only-fields list
266 Trim leading and trailing spaces from only the listed fields. This
267 option is cumulative but is cancelled by --trim-fields and
268 --no-trim-fields. This option may not be used with
269 --trim-except-fields.
270 --trim-except-fields list
272 Trim leading and trailing spaces from all fields except those
273 listed. This option is cumulative but is cancelled by
274 --trim-fields and --no-trim-fields. This option may not be used
275 with --trim-only-fields.
276 --no-trim-fields
278 Don't trim leading and trailing spaces from fields (default). This
279 option cancels --trim-only-fields and --trim-fields.
280 --expand-fields
282 Don't write "\glsnoexpandfields" to the .glstex file.
283 --no-expand-fields
285 Write "\glsnoexpandfields" to the .glstex file (default).
286 --provide-glossaries
288 Write "\provideignoredglossary*" to the .glstex file to provide
289 unknown glossaries.
290 --no-provide-glossaries
292 Don't write "\provideignoredglossary*" to the .glstex file to
293 provide unknown glossaries except in documented situations (master,
294 secondary and trigger-type resource options). This setting is the
295 default.
296 --replace-quotes
298 Replace single and double quote characters ("'" and """) with
299 "\bibglsaposchar" and "\bibglsdoublequotechar" in field values and
300 group information written to the .glstex file.
301 --no-replace-quotes
303 Don't replace quote characters (default).
304
306 Java 7 or later and a TeX distribution.
307
309 License GPLv3+: GNU GPL version 3 or later
310 <http://gnu.org/licenses/gpl.html> This is free software: you are free
311 to change and redistribute it. There is NO WARRANTY, to the extent
312 permitted by law.
313
315 The bib2gls manual:
316 texdoc bib2gls
318 The glossaries-extra manual:
320 texdoc glossaries-extra
322 The glossaries manual:
324 texdoc glossaries
326
328 Nicola L. C. Talbot, <https://www.dickimaw-books.com/>
329perl v5.34.1 2022-11-24 BIB2GLS(1)