| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) |
| 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 "BIB2GLS 1" |
| 61 |
.TH BIB2GLS 1 2025-11-13 "perl v5.40.3" bib2gls |
| 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 SYNOPSIS |
| 67 |
.IX Header "SYNOPSIS" |
| 68 |
\&\fBbib2gls\fR [\fIoption\fR]+ \fIauxfile\fR |
| 69 |
.SH DESCRIPTION |
| 70 |
.IX Header "DESCRIPTION" |
| 71 |
\&\fBbib2gls\fR is designed to work with the \fBglossaries\-extra\fR LaTeX |
| 72 |
package. (The \fBrecord\fR package option is required.) The application |
| 73 |
performs two functions in one: (1) selects entries from .bib files |
| 74 |
according to information found in the \fIauxfile\fR (similar to |
| 75 |
\&\fBbibtex\fR); (2) hierarchically sorts entries and collates location |
| 76 |
lists (similar to \fBmakeindex\fR and \fBxindy\fR). The .aux extension may |
| 77 |
be omitted from \fIauxfile\fR. |
| 78 |
.PP |
| 79 |
The \fIauxfile\fR (and corresponding .log file) should either be in the |
| 80 |
current directory or in the directory specified by \fB\-\-dir\fR. Bib files can |
| 81 |
either be relative to the directory the \fIauxfile\fR is in |
| 82 |
or in a location that can be found by kpsewhich. |
| 83 |
.SH OPTIONS |
| 84 |
.IX Header "OPTIONS" |
| 85 |
.IP "\fB\-\-aux\-input\-action\fR \fIsetting\fR" 4 |
| 86 |
.IX Item "--aux-input-action setting" |
| 87 |
Determines what to do when \fBbib2gls\fR encounters \f(CW\*(C`\e@input\*(C'\fR in the |
| 88 |
\&\fIaux\fR file. The \fIsetting\fR may be one of: |
| 89 |
.RS 4 |
| 90 |
.IP \fBfollow\fR 4 |
| 91 |
.IX Item "follow" |
| 92 |
Follow the reference (that is, input the file as usual). |
| 93 |
.IP "\fBskip\-after\-bibglsaux\fR (or \fBskip after bibglsaux\fR)" 4 |
| 94 |
.IX Item "skip-after-bibglsaux (or skip after bibglsaux)" |
| 95 |
Follow the reference for each \f(CW\*(C`\e@input\*(C'\fR encountered until |
| 96 |
\&\f(CW\*(C`\e@bibgls@input\*(C'\fR is encountered, after which skip all remaining |
| 97 |
instances of \f(CW\*(C`\e@input\*(C'\fR (default). |
| 98 |
.IP \fBskip\fR 4 |
| 99 |
.IX Item "skip" |
| 100 |
Skip all instances of \f(CW\*(C`\e@input\*(C'\fR (but not \f(CW\*(C`\e@bibgls@input\*(C'\fR |
| 101 |
which is always followed). |
| 102 |
.RE |
| 103 |
.RS 4 |
| 104 |
.Sp |
| 105 |
The \f(CW\*(C`\e@bibgls@input\*(C'\fR command will be in the \fIaux\fR file if the package |
| 106 |
option \f(CW\*(C`bibglsaux\*(C'\fR has been used. |
| 107 |
.RE |
| 108 |
.IP \fB\-\-break\-space\fR 4 |
| 109 |
.IX Item "--break-space" |
| 110 |
Interpret \f(CW\*(C`~\*(C'\fR (tilde) character and \f(CW\*(C`\enobreakspace\*(C'\fR as a normal space. |
| 111 |
.IP \fB\-\-cite\-as\-record\fR 4 |
| 112 |
.IX Item "--cite-as-record" |
| 113 |
Treat \f(CW\*(C`\ecitation\*(C'\fR as an ignored record. |
| 114 |
.IP \fB\-\-collapse\-same\-location\-range\fR 4 |
| 115 |
.IX Item "--collapse-same-location-range" |
| 116 |
Collapse an explicit range that has a duplicate start and end |
| 117 |
location into a normal record (default). |
| 118 |
.IP "\fB\-\-custom\-packages\fR \fIlist\fR" 4 |
| 119 |
.IX Item "--custom-packages list" |
| 120 |
Instruct the TeX parser library to attempt to parse the |
| 121 |
packages listed in \fIlist\fR. This is intended for simple custom |
| 122 |
packages that don\*(Aqt contain complex code. |
| 123 |
.IP \fB\-\-datatool\-sort\-markers\fR 4 |
| 124 |
.IX Item "--datatool-sort-markers" |
| 125 |
The interpreter will use the \fIdatatool\-base.sty\fR marker commands to match their |
| 126 |
localised definitions within \f(CW\*(C`\eDTLsortwordlist\*(C'\fR (\fIdatatool\fR v3.0+). |
| 127 |
You will need a sort method that doesn\*(Aqt ignore the control |
| 128 |
characters used by those commands. |
| 129 |
.IP "\fB\-\-date\-in\-header\fR (or \fB\-D\fR)" 4 |
| 130 |
.IX Item "--date-in-header (or -D)" |
| 131 |
The header comment at the start of the \fI.glstex\fR file will include |
| 132 |
the file modification date. |
| 133 |
.IP "\fB\-\-debug\fR [\fIn\fR]" 4 |
| 134 |
.IX Item "--debug [n]" |
| 135 |
Switch on the debug mode at the given setting \fIn\fR, which |
| 136 |
should be a non\-negative integer. If \fIn\fR is \fB0\fR then the |
| 137 |
debug mode is switched off. If omitted, \fIn\fR is set to 1, which |
| 138 |
corresponds to \fB\-\-debug\-mode\fR \fBio\fR. Any positive number will |
| 139 |
enable all of \fBbib2gls\fR\*(Aqs debugging messages. The amount of |
| 140 |
TeX Parser Library debugging messages depends on bitwise operation of \fIn\fR. |
| 141 |
.IP "\fB\-\-debug\-mode\fR \fIsetting\fR" 4 |
| 142 |
.IX Item "--debug-mode setting" |
| 143 |
May be used instead of \fB\-\-debug\fR where the level number is |
| 144 |
difficult to remember. The \fIsetting\fR may be a comma\-separated list |
| 145 |
of any of the keywords: |
| 146 |
.RS 4 |
| 147 |
.IP \fBall\fR 4 |
| 148 |
.IX Item "all" |
| 149 |
Highest level (likely to result in a large transcript file). Equivalent to |
| 150 |
switching on all settings. |
| 151 |
.IP \fBcatcode\fR 4 |
| 152 |
.IX Item "catcode" |
| 153 |
TeX Parser category code changes. |
| 154 |
.IP \fBcs\fR 4 |
| 155 |
.IX Item "cs" |
| 156 |
TeX Parser command definitions. |
| 157 |
.IP \fBdecl\fR 4 |
| 158 |
.IX Item "decl" |
| 159 |
TeX Parser declarations. |
| 160 |
.IP \fBexpansion\fR 4 |
| 161 |
.IX Item "expansion" |
| 162 |
TeX Parser expansions (may result in a large transcript file). |
| 163 |
.IP \fBexpansion\-list\fR 4 |
| 164 |
.IX Item "expansion-list" |
| 165 |
TeX Parser stack expansions (may result in a large transcript file). |
| 166 |
.IP \fBexpansion\-once\fR 4 |
| 167 |
.IX Item "expansion-once" |
| 168 |
TeX Parser one\-level expansions. |
| 169 |
.IP \fBexpansion\-once\-list\fR 4 |
| 170 |
.IX Item "expansion-once-list" |
| 171 |
TeX Parser one\-level list expansions. |
| 172 |
.IP \fBio\fR 4 |
| 173 |
.IX Item "io" |
| 174 |
TeX Parser I/O operations (open, close and fetch token). |
| 175 |
.IP \fBpopped\fR 4 |
| 176 |
.IX Item "popped" |
| 177 |
TeX Parser stack popping. |
| 178 |
.IP \fBprocess\fR 4 |
| 179 |
.IX Item "process" |
| 180 |
TeX Parser macro process (may result in a large transcript file). |
| 181 |
.IP \fBprocess\-generic\-cs\fR 4 |
| 182 |
.IX Item "process-generic-cs" |
| 183 |
TeX Parser generic command process. |
| 184 |
.IP \fBprocess\-stack\fR 4 |
| 185 |
.IX Item "process-stack" |
| 186 |
TeX Parser stack process (may result in a large transcript file). |
| 187 |
.IP \fBprocess\-stack\-list\fR 4 |
| 188 |
.IX Item "process-stack-list" |
| 189 |
TeX Parser detailed stack process (may result in a large transcript file). |
| 190 |
.IP \fBread\fR 4 |
| 191 |
.IX Item "read" |
| 192 |
TeX Parser codepoint read from file (likely to result in a large |
| 193 |
transcript file). |
| 194 |
.IP \fBsty\-data\fR 4 |
| 195 |
.IX Item "sty-data" |
| 196 |
TeX Parser data (typically relates to internal objects that don\*(Aqt |
| 197 |
have an analogous TeX macro). This includes data gathered from the |
| 198 |
aux file. |
| 199 |
.RE |
| 200 |
.RS 4 |
| 201 |
.Sp |
| 202 |
For example: \f(CW\*(C`bib2gls \-\-debug\-mode io,catcode,sty\-data mydoc\*(C'\fR |
| 203 |
.RE |
| 204 |
.IP "\fB\-\-default\-encoding\fR \fIname\fR" 4 |
| 205 |
.IX Item "--default-encoding name" |
| 206 |
Set the default character encoding for input and output files. |
| 207 |
If omitted, the JVM default encoding is assumed. |
| 208 |
.IP "\fB\-\-dir\fR \fIdirectory\fR (or \fB\-d\fR <directory>)" 4 |
| 209 |
.IX Item "--dir directory (or -d <directory>)" |
| 210 |
Files are relative to \fIdirectory\fR. (This doesn\*(Aqt change the current |
| 211 |
working directory.) |
| 212 |
.IP \fB\-\-expand\-fields\fR 4 |
| 213 |
.IX Item "--expand-fields" |
| 214 |
Don\*(Aqt write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file. |
| 215 |
.IP "\fB\-\-force\-cross\-resource\-refs\fR or \fB\-x\fR" 4 |
| 216 |
.IX Item "--force-cross-resource-refs or -x" |
| 217 |
Force cross\-resource referencing mode on. |
| 218 |
.IP "\fB\-\-group\fR or \fB\-g\fR" 4 |
| 219 |
.IX Item "--group or -g" |
| 220 |
Add \fBgroup\fR field to entries. |
| 221 |
.IP "\fB\-\-help\fR or \fB\-h\fR" 4 |
| 222 |
.IX Item "--help or -h" |
| 223 |
Display help message and exit. |
| 224 |
.IP "\fB\-\-ignore\-packages\fR \fIlist\fR (or \fB\-k\fR \fIlist\fR)" 4 |
| 225 |
.IX Item "--ignore-packages list (or -k list)" |
| 226 |
Don\*(Aqt parse the log file for the packages listed in \fIlist\fR. Note |
| 227 |
that \fB\-\-packages\fR overrides this option, so if the same package is |
| 228 |
listed in both \fB\-\-ignore\-packages\fR and \fB\-\-packages\fR then the |
| 229 |
interpreter will check if it\*(Aqs supported. This option has a |
| 230 |
cumulative action. Only known packages may be included in |
| 231 |
\&\fIlist\fR. |
| 232 |
.IP \fB\-\-interpret\fR 4 |
| 233 |
.IX Item "--interpret" |
| 234 |
Use the TeX Parser Library to interpret known (La)TeX commands |
| 235 |
(default). |
| 236 |
.IP \fB\-\-list\-known\-packages\fR 4 |
| 237 |
.IX Item "--list-known-packages" |
| 238 |
Lists all the packages that have are known to the TeX parser |
| 239 |
library and then exits (with exit code 0). Any of the listed |
| 240 |
packages may be used in \fB\-\-packages\fR or \fB\-\-ignore\-packages\fR. |
| 241 |
.IP "\fB\-\-locale\fR \fIlang\fR (or \fB\-l\fR \fIlang\fR)" 4 |
| 242 |
.IX Item "--locale lang (or -l lang)" |
| 243 |
Use language resource file for \fIlang\fR (which should be an IETF |
| 244 |
locale tag). |
| 245 |
.IP "\fB\-\-log\-encoding\fR \fIname\fR" 4 |
| 246 |
.IX Item "--log-encoding name" |
| 247 |
Set the character encoding for the \fIlog\fR files (which may not be |
| 248 |
the same as the encoding for the document LaTeX files). |
| 249 |
.IP "\fB\-\-log\-file\fR \fIfile\fR (or \fB\-t\fR <file>)" 4 |
| 250 |
.IX Item "--log-file file (or -t <file>)" |
| 251 |
Set the transcript file. |
| 252 |
.IP "\fB\-\-merge\-nameref\-on\fR \fIrule\fR" 4 |
| 253 |
.IX Item "--merge-nameref-on rule" |
| 254 |
Rule for merging locations created with the \fBrecord=nameref\fR package option |
| 255 |
(requires \fIglossaries\-extra.sty\fR version 1.37+). The \fIrule\fR may be |
| 256 |
one of: \fBhcounter\fR, \fBhref\fR, \fBtitle\fR or \fBlocation\fR. |
| 257 |
.IP \fB\-\-merge\-wrglossary\-records\fR 4 |
| 258 |
.IX Item "--merge-wrglossary-records" |
| 259 |
Merge an entry\*(Aqs \fBwrglossary\fR records for the same page locations. |
| 260 |
(For use with the \fBindexcounter\fR package option.) |
| 261 |
.IP \fB\-\-mfirstuc\-math\-protection\fR 4 |
| 262 |
.IX Item "--mfirstuc-math-protection" |
| 263 |
Switch on the auto\-insertion of an empty group for math\-shift (\f(CW\*(C`$\*(C'\fR). |
| 264 |
.Sp |
| 265 |
If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries\-extra\fR v1.49+ |
| 266 |
are detected, the default will be \fB\-\-no\-mfirstuc\-math\-protection\fR |
| 267 |
as there should no longer be any need for this protection. |
| 268 |
.IP "\fB\-\-mfirstuc\-protection\fR \fIfields\fR|\fBall\fR (or \fB\-u\fR \fIfields\fR|\fBall\fR)" 4 |
| 269 |
.IX Item "--mfirstuc-protection fields|all (or -u fields|all)" |
| 270 |
Insert an empty group if fields start with certain problematic |
| 271 |
commands to protect against case\-changing commands like \f(CW\*(C`\eGls\*(C'\fR. |
| 272 |
.Sp |
| 273 |
The default is to do this for all fields. To do this for only a |
| 274 |
subset of fields, set \fIfields\fR to a comma\-separated list of fields |
| 275 |
(e.g. \fBname,short,long\fR). The keyword \fBall\fR indicates all fields. |
| 276 |
.Sp |
| 277 |
If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries\-extra\fR v1.49+ |
| 278 |
are detected, the default will be \fB\-\-no\-mfirstuc\-protection\fR |
| 279 |
as there should no longer be any need for this protection. |
| 280 |
.IP "\fB\-\-nested\-link\-check\fR \fIlist\fR|\fBnone\fR" 4 |
| 281 |
.IX Item "--nested-link-check list|none" |
| 282 |
Check each field listed in \fIlist\fR for potentially problematic |
| 283 |
nested link text. (Default list: name, text, plural, first, |
| 284 |
firstplural, short, shortplural, long, longplural, symbol). |
| 285 |
.Sp |
| 286 |
If \fBnone\fR, disable check. |
| 287 |
.IP \fB\-\-no\-break\-space\fR 4 |
| 288 |
.IX Item "--no-break-space" |
| 289 |
Interpret \f(CW\*(C`~\*(C'\fR (tilde) and \f(CW\*(C`\enobreakspace\*(C'\fR as a non\-breaking space (default). |
| 290 |
.IP \fB\-\-no\-cite\-as\-record\fR 4 |
| 291 |
.IX Item "--no-cite-as-record" |
| 292 |
Don\*(Aqt check for instances of \f(CW\*(C`\ecitation\*(C'\fR in the \fI.aux\fR file (default). |
| 293 |
.IP \fB\-\-no\-collapse\-same\-location\-range\fR 4 |
| 294 |
.IX Item "--no-collapse-same-location-range" |
| 295 |
Don\*(Aqt collapse an explicit range that has a duplicate start and end |
| 296 |
location into a normal record. |
| 297 |
.IP \fB\-\-no\-datatool\-sort\-markers\fR 4 |
| 298 |
.IX Item "--no-datatool-sort-markers" |
| 299 |
The interpreter will use the normal definition of the |
| 300 |
\&\fIdatatool\-base.sty\fR sort marker commands. |
| 301 |
.IP \fB\-\-no\-date\-in\-header\fR 4 |
| 302 |
.IX Item "--no-date-in-header" |
| 303 |
The header comment at the start of the \fI.glstex\fR file will not include |
| 304 |
the file modification date (default). |
| 305 |
.IP "\fB\-\-no\-debug\fR (or \fB\-\-nodebug\fR)" 4 |
| 306 |
.IX Item "--no-debug (or --nodebug)" |
| 307 |
Switch off debug mode. (Equivalent to \fB\-\-debug\fR \fB0\fR) |
| 308 |
.IP \fB\-\-no\-expand\-fields\fR 4 |
| 309 |
.IX Item "--no-expand-fields" |
| 310 |
Write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file (default). |
| 311 |
.IP \fB\-\-no\-force\-cross\-resource\-refs\fR 4 |
| 312 |
.IX Item "--no-force-cross-resource-refs" |
| 313 |
Don\*(Aqt force cross\-resource referencing mode on (default). |
| 314 |
.IP \fB\-\-no\-group\fR 4 |
| 315 |
.IX Item "--no-group" |
| 316 |
Don\*(Aqt add \fBgroup\fR field to entries (default). |
| 317 |
.IP \fB\-\-no\-interpret\fR 4 |
| 318 |
.IX Item "--no-interpret" |
| 319 |
Don\*(Aqt try interpreting (La)TeX commands. The TeX Parser Library will |
| 320 |
still be used to parse the \fIaux\fR and \fIbib\fR files. |
| 321 |
.IP \fB\-\-no\-merge\-wrglossary\-records\fR 4 |
| 322 |
.IX Item "--no-merge-wrglossary-records" |
| 323 |
Don\*(Aqt merge an entry\*(Aqs \fBwrglossary\fR records. |
| 324 |
.IP \fB\-\-no\-mfirstuc\-math\-protection\fR 4 |
| 325 |
.IX Item "--no-mfirstuc-math-protection" |
| 326 |
Switch off the auto\-insertion of an empty group for math\-shift (\f(CW\*(C`$\*(C'\fR). |
| 327 |
.IP \fB\-\-no\-mfirstuc\-protection\fR 4 |
| 328 |
.IX Item "--no-mfirstuc-protection" |
| 329 |
Switch off the auto\-insertion of an empty group for all fields. |
| 330 |
.IP \fB\-\-no\-nested\-link\-check\fR 4 |
| 331 |
.IX Item "--no-nested-link-check" |
| 332 |
Don\*(Aqt check for potentially problematic nested link text. |
| 333 |
(Equivalent to \fB\-\-nested\-link\-check\fR \fBnone\fR) |
| 334 |
.IP \fB\-\-no\-obey\-aux\-catcode\fR 4 |
| 335 |
.IX Item "--no-obey-aux-catcode" |
| 336 |
Ignore category code changing commands encountered in the aux file. |
| 337 |
.IP \fB\-\-no\-provide\-glossaries\fR 4 |
| 338 |
.IX Item "--no-provide-glossaries" |
| 339 |
Don\*(Aqt write \f(CW\*(C`\eprovideignoredglossary*\*(C'\fR to the \fI.glstex\fR file to |
| 340 |
provide unknown glossaries except in documented situations |
| 341 |
(\fBmaster\fR, \fBsecondary\fR and \fBtrigger\-type\fR resource options). |
| 342 |
This setting is the default. |
| 343 |
.IP \fB\-\-no\-record\-count\fR 4 |
| 344 |
.IX Item "--no-record-count" |
| 345 |
Don\*(Aqt add record count field to entries (default). |
| 346 |
This option automatically implements \fB\-\-no\-record\-count\-unit\fR. |
| 347 |
.IP \fB\-\-no\-record\-count\-unit\fR 4 |
| 348 |
.IX Item "--no-record-count-unit" |
| 349 |
Don\*(Aqt add unit record count field to entries (default). |
| 350 |
.IP \fB\-\-no\-replace\-quotes\fR 4 |
| 351 |
.IX Item "--no-replace-quotes" |
| 352 |
Don\*(Aqt replace quote characters (default). |
| 353 |
.IP \fB\-\-no\-retain\-formats\fR 4 |
| 354 |
.IX Item "--no-retain-formats" |
| 355 |
Normal location merging rules apply (default). |
| 356 |
.IP \fB\-\-no\-shift\-zero\-sections\fR 4 |
| 357 |
.IX Item "--no-shift-zero-sections" |
| 358 |
Don\*(Aqt check for locations ending with ".0" (default). |
| 359 |
.IP \fB\-\-no\-support\-unicode\-script\fR 4 |
| 360 |
.IX Item "--no-support-unicode-script" |
| 361 |
Text superscript (\f(CW\*(C`\etextsuperscript\*(C'\fR) or subscripts (\f(CW\*(C`\etextsubscript\*(C'\fR) |
| 362 |
won\*(Aqt be converted to Unicode superscript/subscript characters. |
| 363 |
For example, \f(CW\*(C`\etextsuperscript{2}\*(C'\fR will be converted to \f(CW\*(C`<sup>2</sup>\*(C'\fR |
| 364 |
and the markup will be stripped leaving just the character 2. |
| 365 |
.IP \fB\-\-no\-trim\-fields\fR 4 |
| 366 |
.IX Item "--no-trim-fields" |
| 367 |
Don\*(Aqt trim leading and trailing spaces from fields (default). |
| 368 |
This option cancels \fB\-\-trim\-only\-fields\fR and \fB\-\-trim\-fields\fR. |
| 369 |
.IP "\fB\-\-no\-verbose\fR (or \fB\-\-noverbose\fR)" 4 |
| 370 |
.IX Item "--no-verbose (or --noverbose)" |
| 371 |
Switch off verbose mode. (Some messages will still be written to |
| 372 |
STDOUT.) |
| 373 |
.IP \fB\-\-no\-warn\-non\-bib\-fields\fR 4 |
| 374 |
.IX Item "--no-warn-non-bib-fields" |
| 375 |
Don\*(Aqt warn if internal non\-bib fields are found in the \fI.bib\fR file. |
| 376 |
The use of these internal fields can cause unexpected results, so |
| 377 |
only use this option if you have taken appropriate precautions. |
| 378 |
.IP \fB\-\-no\-warn\-unknown\-entry\-types\fR 4 |
| 379 |
.IX Item "--no-warn-unknown-entry-types" |
| 380 |
Don\*(Aqt warn if any unknown entry types are found in the \fI.bib\fR file. |
| 381 |
.IP \fB\-\-obey\-aux\-catcode\fR 4 |
| 382 |
.IX Item "--obey-aux-catcode" |
| 383 |
Obey known category code changing commands encountered in the aux |
| 384 |
file. |
| 385 |
.IP "\fB\-\-packages\fR \fIlist\fR (or \fB\-p\fR \fIlist\fR)" 4 |
| 386 |
.IX Item "--packages list (or -p list)" |
| 387 |
Instruct the TeX parser library to pretend the packages listed |
| 388 |
in \fIlist\fR have been used by the document. Note that there\*(Aqs only a |
| 389 |
limited number of packages supported by the TeX parser library. |
| 390 |
This option has a cumulative action so \fB\-\-packages wasysym,pifont\fR |
| 391 |
is the same as \fB\-\-packages wasysym \-\-packages pifont\fR. |
| 392 |
.Sp |
| 393 |
You can find out the list of supported packages with |
| 394 |
\&\fB\-\-list\-known\-packages\fR. |
| 395 |
.IP \fB\-\-provide\-glossaries\fR 4 |
| 396 |
.IX Item "--provide-glossaries" |
| 397 |
Write \f(CW\*(C`\eprovideignoredglossary*\*(C'\fR to the \fI.glstex\fR file to provide |
| 398 |
unknown glossaries. |
| 399 |
.IP "\fB\-\-quiet\fR (or \fB\-q\fR)" 4 |
| 400 |
.IX Item "--quiet (or -q)" |
| 401 |
Only display error messages. All other messages are just written to |
| 402 |
the transcript file. |
| 403 |
.IP "\fB\-\-record\-count\fR or \fB\-c\fR" 4 |
| 404 |
.IX Item "--record-count or -c" |
| 405 |
Add record count fields to entries. |
| 406 |
.IP "\fB\-\-record\-count\-rule\fR \fIrule\fR or \fB\-r\fR \fIrule\fR" 4 |
| 407 |
.IX Item "--record-count-rule rule or -r rule" |
| 408 |
Sets the rule used by \fB\-\-record\-count\fR and \fB\-\-record\-count\-unit\fR. |
| 409 |
This option automatically implements \fB\-\-record\-count\fR. |
| 410 |
.Sp |
| 411 |
The \fIrule\fR may be: \f(CW\*(C`all\*(C'\fR or \f(CW\*(C`a\*(C'\fR (count all records), |
| 412 |
\&\f(CW\*(C`non\-ignored\*(C'\fR or \f(CW\*(C`n\*(C'\fR (count all non\-ignored records), |
| 413 |
\&\f(CW\*(C`f/\*(C'\fR\fIregex\fR\f(CW\*(C`/\*(C'\fR (only count records where the format |
| 414 |
matches the regular expression \fIregex\fR), |
| 415 |
\&\f(CW\*(C`c/\*(C'\fR\fIregex\fR\f(CW\*(C`/\*(C'\fR (only count records where the counter name |
| 416 |
matches the regular expression \fIregex\fR), |
| 417 |
or \f(CW\*(C`f/\*(C'\fR\fIregex1\fR\f(CW\*(C`/c/\*(C'\fR\fIregex2\fR\f(CW\*(C`/\*(C'\fR\fIop\fR (only count records where the format |
| 418 |
matches the regular expression \fIregex1\fR and/or the counter name |
| 419 |
matches the regular expression \fIregex2\fR). The \fIop\fR part is |
| 420 |
optional. If present it may be one of: \f(CW\*(C`and\*(C'\fR (format AND counter |
| 421 |
must match), \f(CW\*(C`or\*(C'\fR (format OR counter must match). If \fIop\fR is |
| 422 |
omitted, AND is assumed. |
| 423 |
.IP "\fB\-\-record\-count\-unit\fR or \fB\-n\fR" 4 |
| 424 |
.IX Item "--record-count-unit or -n" |
| 425 |
Add unit record count fields to entries. |
| 426 |
This option automatically implements \fB\-\-record\-count\fR. |
| 427 |
.IP \fB\-\-replace\-quotes\fR 4 |
| 428 |
.IX Item "--replace-quotes" |
| 429 |
Replace single and double quote characters (\f(CW\*(C`\*(Aq\*(C'\fR and \f(CW\*(C`"\*(C'\fR) with |
| 430 |
\&\f(CW\*(C`\ebibglsaposchar\*(C'\fR and \f(CW\*(C`\ebibglsdoublequotechar\*(C'\fR in field values |
| 431 |
and group information written to the \fI.glstex\fR file. |
| 432 |
.IP "\fB\-\-retain\-formats\fR \fIlist\fR" 4 |
| 433 |
.IX Item "--retain-formats list" |
| 434 |
Indicates which location formats should always be retained even if |
| 435 |
it causes a partial duplicate. Only exact duplicates will be merged. |
| 436 |
.IP \fB\-\-shift\-zero\-sections\fR 4 |
| 437 |
.IX Item "--shift-zero-sections" |
| 438 |
Shift up section locations ending with ".0" (for sections deeper |
| 439 |
than chapter). This action is applied recursively. |
| 440 |
.Sp |
| 441 |
For example, if a record has counter \f(CW\*(C`subsection\*(C'\fR and location |
| 442 |
\&\f(CW2.0.0\fR then this will first be replaced with counter \f(CW\*(C`section\*(C'\fR |
| 443 |
and location \f(CW2.0\fR but since this still has a section location |
| 444 |
ending with ".0" the function will be applied again and the counter |
| 445 |
will be changed to \f(CW\*(C`chapter\*(C'\fR and the location will be changed to |
| 446 |
\&\f(CW2\fR (so the location subsection 2.0.0 ends up as chapter 2). |
| 447 |
The log file (and verbose mode) will have a line for each change in the |
| 448 |
recursion. |
| 449 |
.IP "\fB\-\-shortcuts\fR \fIoption\fR" 4 |
| 450 |
.IX Item "--shortcuts option" |
| 451 |
Check for the shortcut commands when searching for dependencies. |
| 452 |
Permitted values of \fIoption\fR: \fBacronyms\fR (or \fBacro\fR), \fBac\fR, |
| 453 |
\&\fBabbreviations\fR (or \fBabbr\fR), \fBall\fR (or \fBtrue\fR), \fBnone\fR (or |
| 454 |
\&\fBfalse\fR). This overrides the setting given in \fIauxfile\fR. |
| 455 |
.IP "\fB\-\-map\-format\fR \fIkey\fR\fB:\fR\fIvalue\fR[\fB,\fR\fIkey\fR\fB:\fR\fIvalue\fR]* (or \fB\-m\fR \fIkey\fR\fB:\fR\fIvalue\fR[\fB,\fR\fIkey\fR\fB:\fR\fIvalue\fR]*)" 4 |
| 456 |
.IX Item "--map-format key:value[,key:value]* (or -m key:value[,key:value]*)" |
| 457 |
Set location format mappings. |
| 458 |
.IP \fB\-\-silent\fR 4 |
| 459 |
.IX Item "--silent" |
| 460 |
Only display error messages. All other messages are just written to |
| 461 |
the transcript file. (Synonym of \fB\-\-quiet\fR.) |
| 462 |
.IP \fB\-\-support\-unicode\-script\fR 4 |
| 463 |
.IX Item "--support-unicode-script" |
| 464 |
Text superscript (\f(CW\*(C`\etextsuperscript\*(C'\fR) or subscripts (\f(CW\*(C`\etextsubscript\*(C'\fR) |
| 465 |
will use Unicode superscript/subscript characters if available. |
| 466 |
For example, \f(CW\*(C`\etextsuperscript{2}\*(C'\fR will be converted to U+00B2 |
| 467 |
(superscript two). |
| 468 |
.IP "\fB\-\-tex\-encoding\fR \fIname\fR" 4 |
| 469 |
.IX Item "--tex-encoding name" |
| 470 |
Set the character encoding for the \fIglstex\fR files. This overrides the |
| 471 |
setting given in \fIauxfile\fR. |
| 472 |
.IP "\fB\-\-trim\-except\-fields\fR \fIlist\fR" 4 |
| 473 |
.IX Item "--trim-except-fields list" |
| 474 |
Trim leading and trailing spaces from all fields except those listed. |
| 475 |
This option is cumulative but is cancelled by \fB\-\-trim\-fields\fR |
| 476 |
and \fB\-\-no\-trim\-fields\fR. This option may not be used with |
| 477 |
\&\fB\-\-trim\-only\-fields\fR. |
| 478 |
.IP \fB\-\-trim\-fields\fR 4 |
| 479 |
.IX Item "--trim-fields" |
| 480 |
Trim leading and trailing spaces from all fields. |
| 481 |
This option cancels \fB\-\-trim\-only\-fields\fR and \fB\-\-no\-trim\-fields\fR. |
| 482 |
.IP "\fB\-\-trim\-only\-fields\fR \fIlist\fR" 4 |
| 483 |
.IX Item "--trim-only-fields list" |
| 484 |
Trim leading and trailing spaces from only the listed fields. |
| 485 |
This option is cumulative but is cancelled by \fB\-\-trim\-fields\fR |
| 486 |
and \fB\-\-no\-trim\-fields\fR. This option may not be used with |
| 487 |
\&\fB\-\-trim\-except\-fields\fR. |
| 488 |
.IP \fB\-\-verbose\fR 4 |
| 489 |
.IX Item "--verbose" |
| 490 |
Switch on verbose mode. |
| 491 |
.IP "\fB\-\-version\fR or \fB\-v\fR" 4 |
| 492 |
.IX Item "--version or -v" |
| 493 |
Display version information and exit. |
| 494 |
.IP \fB\-\-warn\-non\-bib\-fields\fR 4 |
| 495 |
.IX Item "--warn-non-bib-fields" |
| 496 |
Warn if internal non\-bib fields are found in the \fI.bib\fR file. |
| 497 |
.IP \fB\-\-warn\-unknown\-entry\-types\fR 4 |
| 498 |
.IX Item "--warn-unknown-entry-types" |
| 499 |
Warn if any unknown entry types are found in the \fI.bib\fR file. |
| 500 |
.SH REQUIRES |
| 501 |
.IX Header "REQUIRES" |
| 502 |
Java 8 or later and a TeX distribution. |
| 503 |
.SH LICENSE |
| 504 |
.IX Header "LICENSE" |
| 505 |
License GPLv3+: GNU GPL version 3 or later |
| 506 |
<http://gnu.org/licenses/gpl.html> |
| 507 |
This is free software: you are free to change and redistribute it. |
| 508 |
There is NO WARRANTY, to the extent permitted by law. |
| 509 |
.SH "RECOMMENDED READING" |
| 510 |
.IX Header "RECOMMENDED READING" |
| 511 |
The bib2gls manual: |
| 512 |
.PP |
| 513 |
.Vb 1 |
| 514 |
\& texdoc bib2gls |
| 515 |
.Ve |
| 516 |
.PP |
| 517 |
The glossaries\-extra manual: |
| 518 |
.PP |
| 519 |
.Vb 1 |
| 520 |
\& texdoc glossaries\-extra |
| 521 |
.Ve |
| 522 |
.PP |
| 523 |
The glossaries manual: |
| 524 |
.PP |
| 525 |
.Vb 1 |
| 526 |
\& texdoc glossaries |
| 527 |
.Ve |
| 528 |
.SH AUTHOR |
| 529 |
.IX Header "AUTHOR" |
| 530 |
Nicola L. C. Talbot, |
| 531 |
<https://www.dickimaw\-books.com/> |