summaryrefslogtreecommitdiff
path: root/support/bib2gls/bib2gls.1
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-03-25 03:01:53 +0000
committerNorbert Preining <norbert@preining.info>2020-03-25 03:01:53 +0000
commite32477e40d853a81951c9811f8554455dbff4014 (patch)
tree12744b350742c71cbb3c768354084a5c50369ce7 /support/bib2gls/bib2gls.1
parente9af7499b89170ca5c737240b0cdb9563dcf6c5a (diff)
CTAN sync 202003250301
Diffstat (limited to 'support/bib2gls/bib2gls.1')
-rw-r--r--support/bib2gls/bib2gls.156
1 files changed, 33 insertions, 23 deletions
diff --git a/support/bib2gls/bib2gls.1 b/support/bib2gls/bib2gls.1
index 42ece34b41..55d4579a25 100644
--- a/support/bib2gls/bib2gls.1
+++ b/support/bib2gls/bib2gls.1
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "BIB2GLS 1"
-.TH BIB2GLS 1 "2020-02-09" "perl v5.30.1" "bib2gls"
+.TH BIB2GLS 1 "2020-03-18" "perl v5.30.2" "bib2gls"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -201,30 +201,30 @@ Use the TeX parser library to interpret known (La)TeX commands
Don't try interpreting (La)TeX commands.
.IP "\fB\-\-break\-space\fR" 4
.IX Item "--break-space"
-Interpret tilde character and \enobreakspace as a normal space.
+Interpret \f(CW\*(C`~\*(C'\fR (tilde) character and \f(CW\*(C`\enobreakspace\*(C'\fR as a normal space.
.IP "\fB\-\-no\-break\-space\fR" 4
.IX Item "--no-break-space"
-Interpret tilde and \enobreakspace 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\-\-cite\-as\-record\fR" 4
.IX Item "--cite-as-record"
-Treat \fB\ecitation\fR as an ignored record.
+Treat \f(CW\*(C`\ecitation\*(C'\fR as an ignored record.
.IP "\fB\-\-no\-cite\-as\-record\fR" 4
.IX Item "--no-cite-as-record"
-Don't check for instances of \fB\ecitation\fR in the \fB.aux\fR file (default).
+Don't check for instances of \f(CW\*(C`\ecitation\*(C'\fR in the \fI.aux\fR file (default).
.IP "\fB\-\-warn\-non\-bib\-fields\fR" 4
.IX Item "--warn-non-bib-fields"
-Warn if internal non-bib fields are found in the .bib file.
+Warn if internal non-bib fields are found in the \fI.bib\fR file.
.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 .bib file.
+Don't 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\-\-warn\-unknown\-entry\-types\fR" 4
.IX Item "--warn-unknown-entry-types"
-Warn if any unknown entry types are found in the .bib file.
+Warn if any unknown entry types are found in the \fI.bib\fR file.
.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 .bib file.
+Don't warn if any unknown entry types are found in the \fI.bib\fR file.
.IP "\fB\-\-merge\-wrglossary\-records\fR" 4
.IX Item "--merge-wrglossary-records"
Merge an entry's \fBwrglossary\fR records for the same page locations.
@@ -234,8 +234,8 @@ Merge an entry's \fBwrglossary\fR records for the same page locations.
Don't merge an entry's \fBwrglossary\fR records.
.IP "\fB\-\-merge\-nameref\-on\fR \fIrule\fR" 4
.IX Item "--merge-nameref-on rule"
-Rule for merging locations created with the record=nameref package option
-(requires glossaries\-extra.sty version 1.37+). The \fIrule\fR may be
+Rule for merging locations created with the \fBrecord=nameref\fR package option
+(requires \fIglossaries\-extra.sty\fR version 1.37+). The \fIrule\fR may be
one of: \fBhcounter\fR, \fBhref\fR, \fBtitle\fR or \fBlocation\fR.
.IP "\fB\-\-force\-cross\-resource\-refs\fR or \fB\-x\fR" 4
.IX Item "--force-cross-resource-refs or -x"
@@ -245,15 +245,15 @@ Force cross-resource referencing mode on.
Don't force cross-resource referencing mode on (default).
.IP "\fB\-\-support\-unicode\-script\fR" 4
.IX Item "--support-unicode-script"
-Text superscript (\etextsuperscript) or subscripts (\etextsubscript)
+Text superscript (\f(CW\*(C`\etextsuperscript\*(C'\fR) or subscripts (\f(CW\*(C`\etextsubscript\*(C'\fR)
will use Unicode superscript/subscript characters if available.
-For example, \etextsuperscript{2} will be converted to U+00B2
+For example, \f(CW\*(C`\etextsuperscript{2}\*(C'\fR will be converted to U+00B2
(superscript two).
.IP "\fB\-\-no\-support\-unicode\-script\fR" 4
.IX Item "--no-support-unicode-script"
-Text superscript (\etextsuperscript) or subscripts (\etextsubscript)
+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.
-For example, \etextsuperscript{2} will be converted to <sup>2</sup>
+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\-\-packages\fR \fIlist\fR (or \fB\-p\fR \fIlist\fR)" 4
.IX Item "--packages list (or -p list)"
@@ -286,7 +286,7 @@ packages may be used in \fB\-\-packages\fR or \fB\-\-ignore\-packages\fR.
.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 \eGls.
+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
@@ -296,11 +296,11 @@ subset of fields, set \fIfields\fR to a comma-separated list of fields
Switch off the auto-insertion of an empty group for all fields.
.IP "\fB\-\-mfirstuc\-math\-protection\fR" 4
.IX Item "--mfirstuc-math-protection"
-Switch on the auto-insertion of an empty group for math-shift ($).
+Switch on the auto-insertion of an empty group for math-shift (\f(CW\*(C`$\*(C'\fR).
This option will be overridden by \fB\-\-no\-mfirstuc\-protection\fR.
.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 ($).
+Switch off the auto-insertion of an empty group for math-shift (\f(CW\*(C`$\*(C'\fR).
.IP "\fB\-\-nested\-link\-check\fR \fIlist\fR|\fBnone\fR" 4
.IX Item "--nested-link-check list|none"
Check each field listed in \fIlist\fR for potentially problematic
@@ -323,10 +323,10 @@ Permitted values of \fIoption\fR: \fBacronyms\fR (or \fBacro\fR), \fBac\fR,
Set location format mappings.
.IP "\fB\-\-group\fR or \fB\-g\fR" 4
.IX Item "--group or -g"
-Add 'group' field to entries.
+Add \fBgroup\fR field to entries.
.IP "\fB\-\-no\-group\fR" 4
.IX Item "--no-group"
-Don't add 'group' field to entries (default).
+Don't add \fBgroup\fR field to entries (default).
.IP "\fB\-\-record\-count\fR or \fB\-c\fR" 4
.IX Item "--record-count or -c"
Add record count fields to entries.
@@ -363,10 +363,20 @@ Don't trim leading and trailing spaces from fields (default).
This option cancels \fB\-\-trim\-only\-fields\fR and \fB\-\-trim\-fields\fR.
.IP "\fB\-\-expand\-fields\fR" 4
.IX Item "--expand-fields"
-Don't write \fB\eglsnoexpandfields\fR to the \fB.glstex\fR file.
+Don't write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file.
.IP "\fB\-\-no\-expand\-fields\fR" 4
.IX Item "--no-expand-fields"
-Write \fB\eglsnoexpandfields\fR to the \fB.glstex\fR file (default).
+Write \f(CW\*(C`\eglsnoexpandfields\*(C'\fR to the \fI.glstex\fR file (default).
+.IP "\fB\-\-provide\-glossaries\fR" 4
+.IX Item "--provide-glossaries"
+Write \f(CW\*(C`\eprovideignoredglossary*\*(C'\fR to the \fI.glstex\fR file to provide
+unknown glossaries.
+.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
+provide unknown glossaries except in documented situations
+(\fBmaster\fR, \fBsecondary\fR and \fBtrigger-type\fR resource options).
+This setting is the default.
.SH "REQUIRES"
.IX Header "REQUIRES"
Java 7 or later and a TeX distribution.
@@ -398,4 +408,4 @@ The glossaries manual:
.SH "AUTHOR"
.IX Header "AUTHOR"
Nicola L. C. Talbot,
-<http://www.dickimaw\-books.com/>
+<https://www.dickimaw\-books.com/>