diff options
author | Norbert Preining <norbert@preining.info> | 2023-08-26 03:00:52 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2023-08-26 03:00:52 +0000 |
commit | 2c6f7db39402a9980f7423ed3266ad1d18936bcc (patch) | |
tree | b998126ee1c53cfee553777049066ea4b50244f4 /support/bib2gls/bib2gls.1 | |
parent | ba73c7edc85ac1310d82920c5f432993f8a9af23 (diff) |
CTAN sync 202308260300
Diffstat (limited to 'support/bib2gls/bib2gls.1')
-rw-r--r-- | support/bib2gls/bib2gls.1 | 593 |
1 files changed, 297 insertions, 296 deletions
diff --git a/support/bib2gls/bib2gls.1 b/support/bib2gls/bib2gls.1 index c92252702f..fb8ea43d20 100644 --- a/support/bib2gls/bib2gls.1 +++ b/support/bib2gls/bib2gls.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,80 +52,18 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "BIB2GLS 1" -.TH BIB2GLS 1 "2022-12-05" "perl v5.36.0" "bib2gls" +.TH BIB2GLS 1 2023-08-24 "perl v5.36.1" bib2gls .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBbib2gls\fR [\fIoption\fR]+ \fIauxfile\fR -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBbib2gls\fR is designed to work with the \fBglossaries-extra\fR LaTeX package. (The \fBrecord\fR package option is required.) The application @@ -155,148 +77,114 @@ The \fIauxfile\fR (and corresponding .log file) should either be in the current directory or in the directory specified by \fB\-\-dir\fR. Bib files can either be relative to the directory the \fIauxfile\fR is in or in a location that can be found by kpsewhich. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" -.IP "\fB\-\-help\fR or \fB\-h\fR" 4 -.IX Item "--help or -h" -Display help message and exit. -.IP "\fB\-\-version\fR or \fB\-v\fR" 4 -.IX Item "--version or -v" -Display version information and exit. -.IP "\fB\-\-debug\fR [\fIlevel\fR]" 4 -.IX Item "--debug [level]" -Switch on the debug mode (optionally at the given \fIlevel\fR, which -should be a non-negative integer). If \fIlevel\fR is \fB0\fR then the -debug mode is switched off. -.IP "\fB\-\-no\-debug\fR (or \fB\-\-nodebug\fR)" 4 -.IX Item "--no-debug (or --nodebug)" -Switch off debug mode. (Equivalent to \fB\-\-debug\fR \fB0\fR) -.IP "\fB\-\-verbose\fR" 4 -.IX Item "--verbose" -Switch on verbose mode. -.IP "\fB\-\-no\-verbose\fR (or \fB\-\-noverbose\fR)" 4 -.IX Item "--no-verbose (or --noverbose)" -Switch off verbose mode. (Some messages will still be written to -\&\s-1STDOUT.\s0) -.IP "\fB\-\-silent\fR" 4 -.IX Item "--silent" -Only display error messages. All other messages are just written to -the transcript file. -.IP "\fB\-\-locale\fR \fIlang\fR (or \fB\-l\fR \fIlang\fR)" 4 -.IX Item "--locale lang (or -l lang)" -Use language resource file for \fIlang\fR (which should be an \s-1IETF\s0 -locale tag). -.IP "\fB\-\-log\-file\fR \fIfile\fR (or \fB\-t\fR <file>)" 4 -.IX Item "--log-file file (or -t <file>)" -Set the transcript file. -.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 -working directory.) -.IP "\fB\-\-tex\-encoding\fR \fIname\fR" 4 -.IX Item "--tex-encoding name" -Set the character encoding for the output files. This overrides the -setting given in \fIauxfile\fR. -.IP "\fB\-\-interpret\fR" 4 -.IX Item "--interpret" -Use the TeX parser library to interpret known (La)TeX commands -(default). -.IP "\fB\-\-no\-interpret\fR" 4 -.IX Item "--no-interpret" -Don't try interpreting (La)TeX commands. -.IP "\fB\-\-break\-space\fR" 4 +.IP \fB\-\-break\-space\fR 4 .IX Item "--break-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 \f(CW\*(C`~\*(C'\fR (tilde) and \f(CW\*(C`\enobreakspace\*(C'\fR as a non-breaking space (default). -.IP "\fB\-\-obey\-aux\-catcode\fR" 4 -.IX Item "--obey-aux-catcode" -Obey known category code changing commands encountered in the aux -file. -.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\-\-cite\-as\-record\fR" 4 +.IP \fB\-\-cite\-as\-record\fR 4 .IX Item "--cite-as-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 \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 \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 \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 \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 \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. -(For use with the \fBindexcounter\fR package option.) -.IP "\fB\-\-no\-merge\-wrglossary\-records\fR" 4 -.IX Item "--no-merge-wrglossary-records" -Don't merge an entry's \fBwrglossary\fR records. -.IP "\fB\-\-collapse\-same\-location\-range\fR" 4 +.IP \fB\-\-collapse\-same\-location\-range\fR 4 .IX Item "--collapse-same-location-range" Collapse an explicit range that has a duplicate start and end location into a normal record (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 -location into a normal record. -.IP "\fB\-\-retain\-formats\fR \fIlist\fR" 4 -.IX Item "--retain-formats list" -Indicates which location formats should always be retained even if -it causes a partial duplicate. Only exact duplicates will be merged. -.IP "\fB\-\-no\-retain\-formats\fR" 4 -.IX Item "--no-retain-formats" -Normal location merging rules apply (default). -.IP "\fB\-\-merge\-nameref\-on\fR \fIrule\fR" 4 -.IX Item "--merge-nameref-on rule" -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" -Force cross-resource referencing mode on. -.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). -.IP "\fB\-\-support\-unicode\-script\fR" 4 -.IX Item "--support-unicode-script" -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, \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 (\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, \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)" -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 -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. -.Sp -You can find out the list of supported packages with -\&\fB\-\-list\-known\-packages\fR. .IP "\fB\-\-custom\-packages\fR \fIlist\fR" 4 .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. +.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 +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 +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 +of any of the keywords: +.RS 4 +.IP \fBall\fR 4 +.IX Item "all" +Highest level (likely to result in a large transcript file). Equivalent to +switching on all settings. +.IP \fBcatcode\fR 4 +.IX Item "catcode" +TeX Parser category code changes. +.IP \fBcs\fR 4 +.IX Item "cs" +TeX Parser command definitions. +.IP \fBdecl\fR 4 +.IX Item "decl" +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 +.IX Item "expansion-list" +TeX Parser stack expansions (may result in a large transcript file). +.IP \fBexpansion-once\fR 4 +.IX Item "expansion-once" +TeX Parser one-level expansions. +.IP \fBexpansion-once-list\fR 4 +.IX Item "expansion-once-list" +TeX Parser one-level list expansions. +.IP \fBio\fR 4 +.IX Item "io" +TeX Parser I/O operations (open, close and fetch token). +.IP \fBpopped\fR 4 +.IX Item "popped" +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 +.IX Item "process-generic-cs" +TeX Parser generic command process. +.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 +.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 +.IX Item "sty-data" +TeX Parser data (typically relates to internal objects that don't +have an analogous TeX macro). This includes data gathered from the +aux file. +.RE +.RS 4 +.Sp +For example: \f(CW\*(C`bib2gls \-\-debug\-mode io,catcode,sty\-data mydoc\*(C'\fR +.RE +.IP "\fB\-\-default\-encoding\fR \fIname\fR" 4 +.IX Item "--default-encoding name" +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 +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. +.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. +.IP "\fB\-\-group\fR or \fB\-g\fR" 4 +.IX Item "--group or -g" +Add \fBgroup\fR field to entries. +.IP "\fB\-\-help\fR or \fB\-h\fR" 4 +.IX Item "--help or -h" +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 @@ -305,11 +193,42 @@ listed in both \fB\-\-ignore\-packages\fR and \fB\-\-packages\fR then the interpreter will check if it's supported. This option has a cumulative action. Only known packages may be included in \&\fIlist\fR. -.IP "\fB\-\-list\-known\-packages\fR" 4 +.IP \fB\-\-interpret\fR 4 +.IX Item "--interpret" +Use the TeX Parser Library to interpret known (La)TeX commands +(default). +.IP \fB\-\-list\-known\-packages\fR 4 .IX Item "--list-known-packages" Lists all the packages that have are known to the TeX parser library and then exits (with exit code 0). Any of the listed packages may be used in \fB\-\-packages\fR or \fB\-\-ignore\-packages\fR. +.IP "\fB\-\-locale\fR \fIlang\fR (or \fB\-l\fR \fIlang\fR)" 4 +.IX Item "--locale lang (or -l lang)" +Use language resource file for \fIlang\fR (which should be an IETF +locale tag). +.IP "\fB\-\-log\-encoding\fR \fIname\fR" 4 +.IX Item "--log-encoding name" +Set the character encoding for the \fIlog\fR files (which may not be +the same as the encoding for the document LaTeX files). +.IP "\fB\-\-log\-file\fR \fIfile\fR (or \fB\-t\fR <file>)" 4 +.IX Item "--log-file file (or -t <file>)" +Set the transcript file. +.IP "\fB\-\-merge\-nameref\-on\fR \fIrule\fR" 4 +.IX Item "--merge-nameref-on rule" +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\-\-merge\-wrglossary\-records\fR 4 +.IX Item "--merge-wrglossary-records" +Merge an entry's \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). +.Sp +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 @@ -322,19 +241,6 @@ subset of fields, set \fIfields\fR to a comma-separated list of fields 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\-\-no\-mfirstuc\-protection\fR" 4 -.IX Item "--no-mfirstuc-protection" -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 (\f(CW\*(C`$\*(C'\fR). -.Sp -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\-\-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). .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 @@ -342,25 +248,114 @@ nested link text. (Default list: name, text, plural, first, firstplural, short, shortplural, long, longplural, symbol). .Sp If \fBnone\fR, disable check. -.IP "\fB\-\-no\-nested\-link\-check\fR" 4 +.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). +.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). +.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 +location into a normal record. +.IP "\fB\-\-no\-debug\fR (or \fB\-\-nodebug\fR)" 4 +.IX Item "--no-debug (or --nodebug)" +Switch off debug mode. (Equivalent to \fB\-\-debug\fR \fB0\fR) +.IP \fB\-\-no\-expand\-fields\fR 4 +.IX Item "--no-expand-fields" +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). +.IP \fB\-\-no\-group\fR 4 +.IX Item "--no-group" +Don't 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 +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. +.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). +.IP \fB\-\-no\-mfirstuc\-protection\fR 4 +.IX Item "--no-mfirstuc-protection" +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. (Equivalent to \fB\-\-nested\-link\-check\fR \fBnone\fR) -.IP "\fB\-\-shortcuts\fR \fIoption\fR" 4 -.IX Item "--shortcuts option" -Check for the shortcut commands when searching for dependencies. -Permitted values of \fIoption\fR: \fBacronyms\fR (or \fBacro\fR), \fBac\fR, -\&\fBabbreviations\fR (or \fBabbr\fR), \fBall\fR (or \fBtrue\fR), \fBnone\fR (or -\&\fBfalse\fR). This overrides the setting given in \fIauxfile\fR. -.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 -.IX Item "--map-format key:value[,key:value]* (or -m key:value[,key:value]*)" -Set location format mappings. -.IP "\fB\-\-group\fR or \fB\-g\fR" 4 -.IX Item "--group or -g" -Add \fBgroup\fR field to entries. -.IP "\fB\-\-no\-group\fR" 4 -.IX Item "--no-group" -Don't add \fBgroup\fR field to entries (default). +.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 +provide unknown glossaries except in documented situations +(\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). +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). +.IP \fB\-\-no\-replace\-quotes\fR 4 +.IX Item "--no-replace-quotes" +Don't 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. +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). +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)" +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. +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. +.IP \fB\-\-obey\-aux\-catcode\fR 4 +.IX Item "--obey-aux-catcode" +Obey known category code changing commands encountered in the aux +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 +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. +.Sp +You can find out the list of supported packages with +\&\fB\-\-list\-known\-packages\fR. +.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\-\-quiet\fR (or \fB\-q\fR)" 4 +.IX Item "--quiet (or -q)" +Only display error messages. All other messages are just written to +the transcript file. +.IP "\fB\-\-record\-count\fR or \fB\-c\fR" 4 +.IX Item "--record-count or -c" +Add record count fields to entries. .IP "\fB\-\-record\-count\-rule\fR \fIrule\fR or \fB\-r\fR \fIrule\fR" 4 .IX Item "--record-count-rule rule or -r rule" Sets the rule used by \fB\-\-record\-count\fR and \fB\-\-record\-count\-unit\fR. @@ -375,24 +370,52 @@ matches the regular expression \fIregex\fR), 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 matches the regular expression \fIregex1\fR and/or the counter name matches the regular expression \fIregex2\fR). The \fIop\fR part is -optional. If present it may be one of: \f(CW\*(C`and\*(C'\fR (format \s-1AND\s0 counter -must match), \f(CW\*(C`or\*(C'\fR (format \s-1OR\s0 counter must match). If \fIop\fR is -omitted, \s-1AND\s0 is assumed. -.IP "\fB\-\-record\-count\fR or \fB\-c\fR" 4 -.IX Item "--record-count or -c" -Add record count fields to entries. -.IP "\fB\-\-no\-record\-count\fR" 4 -.IX Item "--no-record-count" -Don't add record count field to entries (default). -This option automatically implements \fB\-\-no\-record\-count\-unit\fR. +optional. If present it may be one of: \f(CW\*(C`and\*(C'\fR (format AND counter +must match), \f(CW\*(C`or\*(C'\fR (format OR counter must match). If \fIop\fR is +omitted, AND is assumed. .IP "\fB\-\-record\-count\-unit\fR or \fB\-n\fR" 4 .IX Item "--record-count-unit or -n" Add unit record count fields to entries. This option automatically implements \fB\-\-record\-count\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). -.IP "\fB\-\-trim\-fields\fR" 4 +.IP \fB\-\-replace\-quotes\fR 4 +.IX Item "--replace-quotes" +Replace single and double quote characters (\f(CW\*(C`\*(Aq\*(C'\fR and \f(CW\*(C`"\*(C'\fR) with +\&\f(CW\*(C`\ebibglsaposchar\*(C'\fR and \f(CW\*(C`\ebibglsdoublequotechar\*(C'\fR in field values +and group information written to the \fI.glstex\fR file. +.IP "\fB\-\-retain\-formats\fR \fIlist\fR" 4 +.IX Item "--retain-formats list" +Indicates which location formats should always be retained even if +it causes a partial duplicate. Only exact duplicates will be merged. +.IP "\fB\-\-shortcuts\fR \fIoption\fR" 4 +.IX Item "--shortcuts option" +Check for the shortcut commands when searching for dependencies. +Permitted values of \fIoption\fR: \fBacronyms\fR (or \fBacro\fR), \fBac\fR, +\&\fBabbreviations\fR (or \fBabbr\fR), \fBall\fR (or \fBtrue\fR), \fBnone\fR (or +\&\fBfalse\fR). This overrides the setting given in \fIauxfile\fR. +.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 +.IX Item "--map-format key:value[,key:value]* (or -m key:value[,key:value]*)" +Set location format mappings. +.IP \fB\-\-silent\fR 4 +.IX Item "--silent" +Only display error messages. All other messages are just written to +the transcript file. (Synonym of \fB\-\-quiet\fR.) +.IP \fB\-\-support\-unicode\-script\fR 4 +.IX Item "--support-unicode-script" +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, \f(CW\*(C`\etextsuperscript{2}\*(C'\fR will be converted to U+00B2 +(superscript two). +.IP "\fB\-\-tex\-encoding\fR \fIname\fR" 4 +.IX Item "--tex-encoding name" +Set the character encoding for the \fIglstex\fR files. This overrides the +setting given in \fIauxfile\fR. +.IP "\fB\-\-trim\-except\-fields\fR \fIlist\fR" 4 +.IX Item "--trim-except-fields list" +Trim leading and trailing spaces from all fields except those listed. +This option is cumulative but is cancelled by \fB\-\-trim\-fields\fR +and \fB\-\-no\-trim\-fields\fR. This option may not be used with +\&\fB\-\-trim\-only\-fields\fR. +.IP \fB\-\-trim\-fields\fR 4 .IX Item "--trim-fields" Trim leading and trailing spaces from all fields. This option cancels \fB\-\-trim\-only\-fields\fR and \fB\-\-no\-trim\-fields\fR. @@ -402,49 +425,27 @@ Trim leading and trailing spaces from only the listed fields. This option is cumulative but is cancelled by \fB\-\-trim\-fields\fR and \fB\-\-no\-trim\-fields\fR. This option may not be used with \&\fB\-\-trim\-except\-fields\fR. -.IP "\fB\-\-trim\-except\-fields\fR \fIlist\fR" 4 -.IX Item "--trim-except-fields list" -Trim leading and trailing spaces from all fields except those listed. -This option is cumulative but is cancelled by \fB\-\-trim\-fields\fR -and \fB\-\-no\-trim\-fields\fR. This option may not be used with -\&\fB\-\-trim\-only\-fields\fR. -.IP "\fB\-\-no\-trim\-fields\fR" 4 -.IX Item "--no-trim-fields" -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 \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 \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. -.IP "\fB\-\-replace\-quotes\fR" 4 -.IX Item "--replace-quotes" -Replace single and double quote characters (\f(CW\*(C`\*(Aq\*(C'\fR and \f(CW\*(C`"\*(C'\fR) with -\&\f(CW\*(C`\ebibglsaposchar\*(C'\fR and \f(CW\*(C`\ebibglsdoublequotechar\*(C'\fR in field values -and group information written to the \fI.glstex\fR file. -.IP "\fB\-\-no\-replace\-quotes\fR" 4 -.IX Item "--no-replace-quotes" -Don't replace quote characters (default). -.SH "REQUIRES" +.IP \fB\-\-verbose\fR 4 +.IX Item "--verbose" +Switch on verbose mode. +.IP "\fB\-\-version\fR or \fB\-v\fR" 4 +.IX Item "--version or -v" +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. +.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. +.SH REQUIRES .IX Header "REQUIRES" Java 8 or later and a TeX distribution. -.SH "LICENSE" +.SH LICENSE .IX Header "LICENSE" -License GPLv3+: \s-1GNU GPL\s0 version 3 or later +License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. -There is \s-1NO WARRANTY,\s0 to the extent permitted by law. +There is NO WARRANTY, to the extent permitted by law. .SH "RECOMMENDED READING" .IX Header "RECOMMENDED READING" The bib2gls manual: @@ -464,7 +465,7 @@ The glossaries manual: .Vb 1 \& texdoc glossaries .Ve -.SH "AUTHOR" +.SH AUTHOR .IX Header "AUTHOR" Nicola L. C. Talbot, <https://www.dickimaw\-books.com/> |