summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/bib2gls.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/bib2gls.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/bib2gls.1105
1 files changed, 54 insertions, 51 deletions
diff --git a/Master/texmf-dist/doc/man/man1/bib2gls.1 b/Master/texmf-dist/doc/man/man1/bib2gls.1
index 9779f171e4b..6197f8450ae 100644
--- a/Master/texmf-dist/doc/man/man1/bib2gls.1
+++ b/Master/texmf-dist/doc/man/man1/bib2gls.1
@@ -1,5 +1,5 @@
.\" -*- mode: troff; coding: utf-8 -*-
-.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.45)
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -52,10 +52,13 @@
. \}
.\}
.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "BIB2GLS 1"
-.TH BIB2GLS 1 2024-01-30 "perl v5.38.2" bib2gls
+.TH BIB2GLS 1 2024-03-18 "perl v5.40.0" bib2gls
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -65,7 +68,7 @@
\&\fBbib2gls\fR [\fIoption\fR]+ \fIauxfile\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
-\&\fBbib2gls\fR is designed to work with the \fBglossaries-extra\fR LaTeX
+\&\fBbib2gls\fR is designed to work with the \fBglossaries\-extra\fR LaTeX
package. (The \fBrecord\fR package option is required.) The application
performs two functions in one: (1) selects entries from .bib files
according to information found in the \fIauxfile\fR (similar to
@@ -93,7 +96,7 @@ location into a normal record (default).
.IX Item "--custom-packages list"
Instruct the TeX parser library to attempt to parse the
packages listed in \fIlist\fR. This is intended for simple custom
-packages that don't contain complex code.
+packages that don\*(Aqt contain complex code.
.IP "\fB\-\-date\-in\-header\fR (or \fB\-D\fR)" 4
.IX Item "--date-in-header (or -D)"
The header comment at the start of the \fI.glstex\fR file will include
@@ -101,15 +104,15 @@ the file modification date.
.IP "\fB\-\-debug\fR [\fIn\fR]" 4
.IX Item "--debug [n]"
Switch on the debug mode at the given setting \fIn\fR, which
-should be a non-negative integer. If \fIn\fR is \fB0\fR then the
+should be a non\-negative integer. If \fIn\fR is \fB0\fR then the
debug mode is switched off. If omitted, \fIn\fR is set to 1, which
corresponds to \fB\-\-debug\-mode\fR \fBio\fR. Any positive number will
-enable all of \fBbib2gls\fR's debugging messages. The amount of
+enable all of \fBbib2gls\fR\*(Aqs debugging messages. The amount of
TeX Parser Library debugging messages depends on bitwise operation of \fIn\fR.
.IP "\fB\-\-debug\-mode\fR \fIsetting\fR" 4
.IX Item "--debug-mode setting"
May be used instead of \fB\-\-debug\fR where the level number is
-difficult to remember. The \fIsetting\fR may be a comma-separated list
+difficult to remember. The \fIsetting\fR may be a comma\-separated list
of any of the keywords:
.RS 4
.IP \fBall\fR 4
@@ -128,15 +131,15 @@ TeX Parser declarations.
.IP \fBexpansion\fR 4
.IX Item "expansion"
TeX Parser expansions (may result in a large transcript file).
-.IP \fBexpansion-list\fR 4
+.IP \fBexpansion\-list\fR 4
.IX Item "expansion-list"
TeX Parser stack expansions (may result in a large transcript file).
-.IP \fBexpansion-once\fR 4
+.IP \fBexpansion\-once\fR 4
.IX Item "expansion-once"
-TeX Parser one-level expansions.
-.IP \fBexpansion-once-list\fR 4
+TeX Parser one\-level expansions.
+.IP \fBexpansion\-once\-list\fR 4
.IX Item "expansion-once-list"
-TeX Parser one-level list expansions.
+TeX Parser one\-level list expansions.
.IP \fBio\fR 4
.IX Item "io"
TeX Parser I/O operations (open, close and fetch token).
@@ -146,22 +149,22 @@ TeX Parser stack popping.
.IP \fBprocess\fR 4
.IX Item "process"
TeX Parser macro process (may result in a large transcript file).
-.IP \fBprocess-generic-cs\fR 4
+.IP \fBprocess\-generic\-cs\fR 4
.IX Item "process-generic-cs"
TeX Parser generic command process.
-.IP \fBprocess-stack\fR 4
+.IP \fBprocess\-stack\fR 4
.IX Item "process-stack"
TeX Parser stack process (may result in a large transcript file).
-.IP \fBprocess-stack-list\fR 4
+.IP \fBprocess\-stack\-list\fR 4
.IX Item "process-stack-list"
TeX Parser detailed stack process (may result in a large transcript file).
.IP \fBread\fR 4
.IX Item "read"
TeX Parser codepoint read from file (likely to result in a large
transcript file).
-.IP \fBsty-data\fR 4
+.IP \fBsty\-data\fR 4
.IX Item "sty-data"
-TeX Parser data (typically relates to internal objects that don't
+TeX Parser data (typically relates to internal objects that don\*(Aqt
have an analogous TeX macro). This includes data gathered from the
aux file.
.RE
@@ -175,14 +178,14 @@ Set the default character encoding for input and output files.
If omitted, the JVM default encoding is assumed.
.IP "\fB\-\-dir\fR \fIdirectory\fR (or \fB\-d\fR <directory>)" 4
.IX Item "--dir directory (or -d <directory>)"
-Files are relative to \fIdirectory\fR. (This doesn't change the current
+Files are relative to \fIdirectory\fR. (This doesn\*(Aqt change the current
working directory.)
.IP \fB\-\-expand\-fields\fR 4
.IX Item "--expand-fields"
-Don't write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file.
+Don\*(Aqt write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file.
.IP "\fB\-\-force\-cross\-resource\-refs\fR or \fB\-x\fR" 4
.IX Item "--force-cross-resource-refs or -x"
-Force cross-resource referencing mode on.
+Force cross\-resource referencing mode on.
.IP "\fB\-\-group\fR or \fB\-g\fR" 4
.IX Item "--group or -g"
Add \fBgroup\fR field to entries.
@@ -191,10 +194,10 @@ Add \fBgroup\fR field to entries.
Display help message and exit.
.IP "\fB\-\-ignore\-packages\fR \fIlist\fR (or \fB\-k\fR \fIlist\fR)" 4
.IX Item "--ignore-packages list (or -k list)"
-Don't parse the log file for the packages listed in \fIlist\fR. Note
+Don\*(Aqt parse the log file for the packages listed in \fIlist\fR. Note
that \fB\-\-packages\fR overrides this option, so if the same package is
listed in both \fB\-\-ignore\-packages\fR and \fB\-\-packages\fR then the
-interpreter will check if it's supported. This option has a
+interpreter will check if it\*(Aqs supported. This option has a
cumulative action. Only known packages may be included in
\&\fIlist\fR.
.IP \fB\-\-interpret\fR 4
@@ -224,25 +227,25 @@ Rule for merging locations created with the \fBrecord=nameref\fR package option
one of: \fBhcounter\fR, \fBhref\fR, \fBtitle\fR or \fBlocation\fR.
.IP \fB\-\-merge\-wrglossary\-records\fR 4
.IX Item "--merge-wrglossary-records"
-Merge an entry's \fBwrglossary\fR records for the same page locations.
+Merge an entry\*(Aqs \fBwrglossary\fR records for the same page locations.
(For use with the \fBindexcounter\fR package option.)
.IP \fB\-\-mfirstuc\-math\-protection\fR 4
.IX Item "--mfirstuc-math-protection"
-Switch on the auto-insertion of an empty group for math-shift (\f(CW\*(C`$\*(C'\fR).
+Switch on the auto\-insertion of an empty group for math\-shift (\f(CW\*(C`$\*(C'\fR).
.Sp
-If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries-extra\fR v1.49+
+If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries\-extra\fR v1.49+
are detected, the default will be \fB\-\-no\-mfirstuc\-math\-protection\fR
as there should no longer be any need for this protection.
.IP "\fB\-\-mfirstuc\-protection\fR \fIfields\fR|\fBall\fR (or \fB\-u\fR \fIfields\fR|\fBall\fR)" 4
.IX Item "--mfirstuc-protection fields|all (or -u fields|all)"
Insert an empty group if fields start with certain problematic
-commands to protect against case-changing commands like \f(CW\*(C`\eGls\*(C'\fR.
+commands to protect against case\-changing commands like \f(CW\*(C`\eGls\*(C'\fR.
.Sp
The default is to do this for all fields. To do this for only a
-subset of fields, set \fIfields\fR to a comma-separated list of fields
+subset of fields, set \fIfields\fR to a comma\-separated list of fields
(e.g. \fBname,short,long\fR). The keyword \fBall\fR indicates all fields.
.Sp
-If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries-extra\fR v1.49+
+If \fImfirstuc\fR v2.08+, \fIglossaries\fR v4.50+ and \fIglossaries\-extra\fR v1.49+
are detected, the default will be \fB\-\-no\-mfirstuc\-protection\fR
as there should no longer be any need for this protection.
.IP "\fB\-\-nested\-link\-check\fR \fIlist\fR|\fBnone\fR" 4
@@ -254,13 +257,13 @@ firstplural, short, shortplural, long, longplural, symbol).
If \fBnone\fR, disable check.
.IP \fB\-\-no\-break\-space\fR 4
.IX Item "--no-break-space"
-Interpret \f(CW\*(C`~\*(C'\fR (tilde) and \f(CW\*(C`\enobreakspace\*(C'\fR as a non-breaking space (default).
+Interpret \f(CW\*(C`~\*(C'\fR (tilde) and \f(CW\*(C`\enobreakspace\*(C'\fR as a non\-breaking space (default).
.IP \fB\-\-no\-cite\-as\-record\fR 4
.IX Item "--no-cite-as-record"
-Don't check for instances of \f(CW\*(C`\ecitation\*(C'\fR in the \fI.aux\fR file (default).
+Don\*(Aqt check for instances of \f(CW\*(C`\ecitation\*(C'\fR in the \fI.aux\fR file (default).
.IP \fB\-\-no\-collapse\-same\-location\-range\fR 4
.IX Item "--no-collapse-same-location-range"
-Don't collapse an explicit range that has a duplicate start and end
+Don\*(Aqt collapse an explicit range that has a duplicate start and end
location into a normal record.
.IP \fB\-\-no\-date\-in\-header\fR 4
.IX Item "--no-date-in-header"
@@ -274,58 +277,58 @@ Switch off debug mode. (Equivalent to \fB\-\-debug\fR \fB0\fR)
Write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file (default).
.IP \fB\-\-no\-force\-cross\-resource\-refs\fR 4
.IX Item "--no-force-cross-resource-refs"
-Don't force cross-resource referencing mode on (default).
+Don\*(Aqt force cross\-resource referencing mode on (default).
.IP \fB\-\-no\-group\fR 4
.IX Item "--no-group"
-Don't add \fBgroup\fR field to entries (default).
+Don\*(Aqt add \fBgroup\fR field to entries (default).
.IP \fB\-\-no\-interpret\fR 4
.IX Item "--no-interpret"
-Don't try interpreting (La)TeX commands. The TeX Parser Library will
+Don\*(Aqt try interpreting (La)TeX commands. The TeX Parser Library will
still be used to parse the \fIaux\fR and \fIbib\fR files.
.IP \fB\-\-no\-merge\-wrglossary\-records\fR 4
.IX Item "--no-merge-wrglossary-records"
-Don't merge an entry's \fBwrglossary\fR records.
+Don\*(Aqt merge an entry\*(Aqs \fBwrglossary\fR records.
.IP \fB\-\-no\-mfirstuc\-math\-protection\fR 4
.IX Item "--no-mfirstuc-math-protection"
-Switch off the auto-insertion of an empty group for math-shift (\f(CW\*(C`$\*(C'\fR).
+Switch off the auto\-insertion of an empty group for math\-shift (\f(CW\*(C`$\*(C'\fR).
.IP \fB\-\-no\-mfirstuc\-protection\fR 4
.IX Item "--no-mfirstuc-protection"
-Switch off the auto-insertion of an empty group for all fields.
+Switch off the auto\-insertion of an empty group for all fields.
.IP \fB\-\-no\-nested\-link\-check\fR 4
.IX Item "--no-nested-link-check"
-Don't check for potentially problematic nested link text.
+Don\*(Aqt check for potentially problematic nested link text.
(Equivalent to \fB\-\-nested\-link\-check\fR \fBnone\fR)
.IP \fB\-\-no\-obey\-aux\-catcode\fR 4
.IX Item "--no-obey-aux-catcode"
Ignore category code changing commands encountered in the aux file.
.IP \fB\-\-no\-provide\-glossaries\fR 4
.IX Item "--no-provide-glossaries"
-Don't write \f(CW\*(C`\eprovideignoredglossary*\*(C'\fR to the \fI.glstex\fR file to
+Don\*(Aqt write \f(CW\*(C`\eprovideignoredglossary*\*(C'\fR to the \fI.glstex\fR file to
provide unknown glossaries except in documented situations
-(\fBmaster\fR, \fBsecondary\fR and \fBtrigger-type\fR resource options).
+(\fBmaster\fR, \fBsecondary\fR and \fBtrigger\-type\fR resource options).
This setting is the default.
.IP \fB\-\-no\-record\-count\fR 4
.IX Item "--no-record-count"
-Don't add record count field to entries (default).
+Don\*(Aqt add record count field to entries (default).
This option automatically implements \fB\-\-no\-record\-count\-unit\fR.
.IP \fB\-\-no\-record\-count\-unit\fR 4
.IX Item "--no-record-count-unit"
-Don't add unit record count field to entries (default).
+Don\*(Aqt add unit record count field to entries (default).
.IP \fB\-\-no\-replace\-quotes\fR 4
.IX Item "--no-replace-quotes"
-Don't replace quote characters (default).
+Don\*(Aqt replace quote characters (default).
.IP \fB\-\-no\-retain\-formats\fR 4
.IX Item "--no-retain-formats"
Normal location merging rules apply (default).
.IP \fB\-\-no\-support\-unicode\-script\fR 4
.IX Item "--no-support-unicode-script"
Text superscript (\f(CW\*(C`\etextsuperscript\*(C'\fR) or subscripts (\f(CW\*(C`\etextsubscript\*(C'\fR)
-won't be converted to Unicode superscript/subscript characters.
+won\*(Aqt be converted to Unicode superscript/subscript characters.
For example, \f(CW\*(C`\etextsuperscript{2}\*(C'\fR will be converted to \f(CW\*(C`<sup>2</sup>\*(C'\fR
and the markup will be stripped leaving just the character 2.
.IP \fB\-\-no\-trim\-fields\fR 4
.IX Item "--no-trim-fields"
-Don't trim leading and trailing spaces from fields (default).
+Don\*(Aqt trim leading and trailing spaces from fields (default).
This option cancels \fB\-\-trim\-only\-fields\fR and \fB\-\-trim\-fields\fR.
.IP "\fB\-\-no\-verbose\fR (or \fB\-\-noverbose\fR)" 4
.IX Item "--no-verbose (or --noverbose)"
@@ -333,12 +336,12 @@ Switch off verbose mode. (Some messages will still be written to
STDOUT.)
.IP \fB\-\-no\-warn\-non\-bib\-fields\fR 4
.IX Item "--no-warn-non-bib-fields"
-Don't warn if internal non-bib fields are found in the \fI.bib\fR file.
+Don\*(Aqt warn if internal non\-bib fields are found in the \fI.bib\fR file.
The use of these internal fields can cause unexpected results, so
only use this option if you have taken appropriate precautions.
.IP \fB\-\-no\-warn\-unknown\-entry\-types\fR 4
.IX Item "--no-warn-unknown-entry-types"
-Don't warn if any unknown entry types are found in the \fI.bib\fR file.
+Don\*(Aqt warn if any unknown entry types are found in the \fI.bib\fR file.
.IP \fB\-\-obey\-aux\-catcode\fR 4
.IX Item "--obey-aux-catcode"
Obey known category code changing commands encountered in the aux
@@ -346,7 +349,7 @@ file.
.IP "\fB\-\-packages\fR \fIlist\fR (or \fB\-p\fR \fIlist\fR)" 4
.IX Item "--packages list (or -p list)"
Instruct the TeX parser library to pretend the packages listed
-in \fIlist\fR have been used by the document. Note that there's only a
+in \fIlist\fR have been used by the document. Note that there\*(Aqs only a
limited number of packages supported by the TeX parser library.
This option has a cumulative action so \fB\-\-packages wasysym,pifont\fR
is the same as \fB\-\-packages wasysym \-\-packages pifont\fR.
@@ -370,7 +373,7 @@ Sets the rule used by \fB\-\-record\-count\fR and \fB\-\-record\-count\-unit\fR.
This option automatically implements \fB\-\-record\-count\fR.
.Sp
The \fIrule\fR may be: \f(CW\*(C`all\*(C'\fR or \f(CW\*(C`a\*(C'\fR (count all records),
-\&\f(CW\*(C`non\-ignored\*(C'\fR or \f(CW\*(C`n\*(C'\fR (count all non-ignored records),
+\&\f(CW\*(C`non\-ignored\*(C'\fR or \f(CW\*(C`n\*(C'\fR (count all non\-ignored records),
\&\f(CW\*(C`f/\*(C'\fR\fIregex\fR\f(CW\*(C`/\*(C'\fR (only count records where the format
matches the regular expression \fIregex\fR),
\&\f(CW\*(C`c/\*(C'\fR\fIregex\fR\f(CW\*(C`/\*(C'\fR (only count records where the counter name
@@ -441,7 +444,7 @@ Switch on verbose mode.
Display version information and exit.
.IP \fB\-\-warn\-non\-bib\-fields\fR 4
.IX Item "--warn-non-bib-fields"
-Warn if internal non-bib fields are found in the \fI.bib\fR file.
+Warn if internal non\-bib fields are found in the \fI.bib\fR file.
.IP \fB\-\-warn\-unknown\-entry\-types\fR 4
.IX Item "--warn-unknown-entry-types"
Warn if any unknown entry types are found in the \fI.bib\fR file.
@@ -462,7 +465,7 @@ The bib2gls manual:
\& texdoc bib2gls
.Ve
.PP
-The glossaries-extra manual:
+The glossaries\-extra manual:
.PP
.Vb 1
\& texdoc glossaries\-extra