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 --cite-as-record
78 Treat "\citation" as an ignored record.
79 --no-cite-as-record
81 Don't check for instances of "\citation" in the .aux file
82 (default).
83 --warn-non-bib-fields
85 Warn if internal non-bib fields are found in the .bib file.
86 --no-warn-non-bib-fields
88 Don't warn if internal non-bib fields are found in the .bib file.
89 The use of these internal fields can cause unexpected results, so
90 only use this option if you have taken appropriate precautions.
91 --warn-unknown-entry-types
93 Warn if any unknown entry types are found in the .bib file.
94 --no-warn-unknown-entry-types
96 Don't warn if any unknown entry types are found in the .bib file.
97 --merge-wrglossary-records
99 Merge an entry's wrglossary records for the same page locations.
100 (For use with the indexcounter package option.)
101 --no-merge-wrglossary-records
103 Don't merge an entry's wrglossary records.
104 --collapse-same-location-range
106 Collapse an explicit range that has a duplicate start and end
107 location into a normal record (default).
108 --no-collapse-same-location-range
110 Don't collapse an explicit range that has a duplicate start and end
111 location into a normal record.
112 --retain-formats list
114 Indicates which location formats should always be retained even if
115 it causes a partial duplicate. Only exact duplicates will be
116 merged.
117 --no-retain-formats
119 Normal location merging rules apply (default).
120 --merge-nameref-on rule
122 Rule for merging locations created with the record=nameref package
123 option (requires glossaries-extra.sty version 1.37+). The rule may
124 be one of: hcounter, href, title or location.
125 --force-cross-resource-refs or -x
127 Force cross-resource referencing mode on.
128 --no-force-cross-resource-refs
130 Don't force cross-resource referencing mode on (default).
131 --support-unicode-script
133 Text superscript ("\textsuperscript") or subscripts
134 ("\textsubscript") will use Unicode superscript/subscript
135 characters if available. For example, "\textsuperscript{2}" will
136 be converted to U+00B2 (superscript two).
137 --no-support-unicode-script
139 Text superscript ("\textsuperscript") or subscripts
140 ("\textsubscript") won't be converted to Unicode
141 superscript/subscript characters. For example,
142 "\textsuperscript{2}" will be converted to "<sup>2</sup>" and the
143 markup will be stripped leaving just the character 2.
144 --packages list (or -p list)
146 Instruct the TeX parser library to pretend the packages listed in
147 list have been used by the document. Note that there's only a
148 limited number of packages supported by the TeX parser library.
149 This option has a cumulative action so --packages wasysym,pifont is
150 the same as --packages wasysym --packages pifont.
151 You can find out the list of supported packages with
153 --list-known-packages.
154 --custom-packages list
156 Instruct the TeX parser library to attempt to parse the packages
157 listed in list. This is intended for simple custom packages that
158 don't contain complex code.
159 --ignore-packages list (or -k list)
161 Don't parse the log file for the packages listed in list. Note that
162 --packages overrides this option, so if the same package is listed
163 in both --ignore-packages and --packages then the interpreter will
164 check if it's supported. This option has a cumulative action. Only
165 known packages may be included in list.
166 --list-known-packages
168 Lists all the packages that have are known to the TeX parser
169 library and then exits (with exit code 0). Any of the listed
170 packages may be used in --packages or --ignore-packages.
171 --mfirstuc-protection fields|all (or -u fields|all)
173 Insert an empty group if fields start with certain problematic
174 commands to protect against case-changing commands like "\Gls".
175 The default is to do this for all fields. To do this for only a
177 subset of fields, set fields to a comma-separated list of fields
178 (e.g. name,short,long). The keyword all indicates all fields.
179 If mfirstuc v2.08+, glossaries v4.50+ and glossaries-extra v1.49+
181 are detected, the default will be --no-mfirstuc-protection as there
182 should no longer be any need for this protection.
183 --no-mfirstuc-protection
185 Switch off the auto-insertion of an empty group for all fields.
186 --mfirstuc-math-protection
188 Switch on the auto-insertion of an empty group for math-shift
189 ("$").
190 If mfirstuc v2.08+, glossaries v4.50+ and glossaries-extra v1.49+
192 are detected, the default will be --no-mfirstuc-math-protection as
193 there should no longer be any need for this protection.
194 --no-mfirstuc-math-protection
196 Switch off the auto-insertion of an empty group for math-shift
197 ("$").
198 --nested-link-check list|none
200 Check each field listed in list for potentially problematic nested
201 link text. (Default list: name, text, plural, first, firstplural,
202 short, shortplural, long, longplural, symbol).
203 If none, disable check.
205 --no-nested-link-check
207 Don't check for potentially problematic nested link text.
208 (Equivalent to --nested-link-check none)
209 --shortcuts option
211 Check for the shortcut commands when searching for dependencies.
212 Permitted values of option: acronyms (or acro), ac, abbreviations
213 (or abbr), all (or true), none (or false). This overrides the
214 setting given in auxfile.
215 --map-format key:value[,key:value]* (or -m key:value[,key:value]*)
217 Set location format mappings.
218 --group or -g
220 Add group field to entries.
221 --no-group
223 Don't add group field to entries (default).
224 --record-count-rule rule or -r rule
226 Sets the rule used by --record-count and --record-count-unit. This
227 option automatically implements --record-count.
228 The rule may be: "all" or "a" (count all records), "non-ignored" or
230 "n" (count all non-ignored records), "f/"regex"/" (only count
231 records where the format matches the regular expression regex),
232 "c/"regex"/" (only count records where the counter name matches the
233 regular expression regex), or "f/"regex1"/c/"regex2"/"op (only
234 count records where the format matches the regular expression
235 regex1 and/or the counter name matches the regular expression
236 regex2). The op part is optional. If present it may be one of:
237 "and" (format AND counter must match), "or" (format OR counter must
238 match). If op is omitted, AND is assumed.
239 --record-count or -c
241 Add record count fields to entries.
242 --no-record-count
244 Don't add record count field to entries (default). This option
245 automatically implements --no-record-count-unit.
246 --record-count-unit or -n
248 Add unit record count fields to entries. This option automatically
249 implements --record-count.
250 --no-record-count-unit
252 Don't add unit record count field to entries (default).
253 --trim-fields
255 Trim leading and trailing spaces from all fields. This option
256 cancels --trim-only-fields and --no-trim-fields.
257 --trim-only-fields list
259 Trim leading and trailing spaces from only the listed fields. This
260 option is cumulative but is cancelled by --trim-fields and
261 --no-trim-fields. This option may not be used with
262 --trim-except-fields.
263 --trim-except-fields list
265 Trim leading and trailing spaces from all fields except those
266 listed. This option is cumulative but is cancelled by
267 --trim-fields and --no-trim-fields. This option may not be used
268 with --trim-only-fields.
269 --no-trim-fields
271 Don't trim leading and trailing spaces from fields (default). This
272 option cancels --trim-only-fields and --trim-fields.
273 --expand-fields
275 Don't write "\glsnoexpandfields" to the .glstex file.
276 --no-expand-fields
278 Write "\glsnoexpandfields" to the .glstex file (default).
279 --provide-glossaries
281 Write "\provideignoredglossary*" to the .glstex file to provide
282 unknown glossaries.
283 --no-provide-glossaries
285 Don't write "\provideignoredglossary*" to the .glstex file to
286 provide unknown glossaries except in documented situations (master,
287 secondary and trigger-type resource options). This setting is the
288 default.
289 --replace-quotes
291 Replace single and double quote characters ("'" and """) with
292 "\bibglsaposchar" and "\bibglsdoublequotechar" in field values and
293 group information written to the .glstex file.
294 --no-replace-quotes
296 Don't replace quote characters (default).
297
299 Java 7 or later and a TeX distribution.
300
302 License GPLv3+: GNU GPL version 3 or later
303 <http://gnu.org/licenses/gpl.html> This is free software: you are free
304 to change and redistribute it. There is NO WARRANTY, to the extent
305 permitted by law.
306
308 The bib2gls manual:
309 texdoc bib2gls
311 The glossaries-extra manual:
313 texdoc glossaries-extra
315 The glossaries manual:
317 texdoc glossaries
319
321 Nicola L. C. Talbot, <https://www.dickimaw-books.com/>
322perl v5.34.1 2022-10-09 BIB2GLS(1)