.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .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' .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\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .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 "2017-11-25" "perl v5.18.4" "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" .IX Header "SYNOPSIS" \&\fBbib2gls\fR [\fIoption\fR]+ \fIauxfile\fR .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 performs two functions in one: (1) selects entries from .bib files according to information found in the \fIauxfile\fR (similar to \&\fBbibtex\fR); (2) hierarchically sorts entries and collates location lists (similar to \fBmakeindex\fR and \fBxindy\fR). The .aux extension may be omitted from \fIauxfile\fR. .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 )" 4 .IX Item "--log-file file (or -t )" Set the transcript file. .IP "\fB\-\-dir\fR \fIdirectory\fR (or \fB\-d\fR )" 4 .IX Item "--dir directory (or -d )" 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 .IX Item "--break-space" Interpret tilde character as a normal space. .IP "\fB\-\-no\-break\-space\fR" 4 .IX Item "--no-break-space" Interpret tilde as a non-breaking space (default). .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. .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. .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 (e.g. \fBname,short,long\fR). The keyword \fBall\fR indicates all fields. .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 ($). 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 ($). .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 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 .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 'group' field to entries. .IP "\fB\-\-no\-group\fR" 4 .IX Item "--no-group" Don't add 'group' 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. .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\-\-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 .IX Item "--trim-fields" Trim leading and trailing spaces from fields. .IP "\fB\-\-no\-trim\-fields\fR" 4 .IX Item "--no-trim-fields" Don't trim leading and trailing spaces from fields (default). .IP "\fB\-\-expand\-fields\fR" 4 .IX Item "--expand-fields" Don't write \fB\eglsnoexpandfields\fR to the \fB.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). .SH "REQUIRES" .IX Header "REQUIRES" Java 7 and a TeX distribution. .SH "LICENSE" .IX Header "LICENSE" License GPLv3+: \s-1GNU GPL\s0 version 3 or later This is free software: you are free to change and redistribute it. There is \s-1NO WARRANTY,\s0 to the extent permitted by law. .SH "RECOMMENDED READING" .IX Header "RECOMMENDED READING" The bib2gls manual: .PP .Vb 1 \& texdoc bib2gls .Ve .PP The glossaries-extra manual: .PP .Vb 1 \& texdoc glossaries\-extra .Ve .PP The glossaries manual: .PP .Vb 1 \& texdoc glossaries .Ve .SH "AUTHOR" .IX Header "AUTHOR" Nicola L. C. Talbot,