.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "CONVERTGLS2BIB 1"
.TH CONVERTGLS2BIB 1 2024-12-08 "perl v5.40.0" convertgls2bib
.\" 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"
\&\fBconvertgls2bib\fR [\fIoption\fR]+ \fItexfile\fR \fIbibfile\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Converts a \fB.tex\fR file containing glossary definitions using
commands like \f(CW\*(C`\enewglossaryentry\*(C'\fR and \f(CW\*(C`\enewacronym\*(C'\fR to 
a \fB.bib\fR file in the format required for \fBbib2gls\fR.
Distributed with \fIbib2gls\fR.
.SH OPTIONS
.IX Header "OPTIONS"
.SS "GENERAL OPTIONS"
.IX Subsection "GENERAL 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\-\-silent\fR or \fB\-\-quiet\fR or \fB\-q\fR" 4
.IX Item "--silent or --quiet or -q"
Suppress all messages except for errors.
.IP \fB\-\-verbose\fR 4
.IX Item "--verbose"
Switch on verbose mode.
.IP \fB\-\-no\-verbose\fR 4
.IX Item "--no-verbose"
Switch off verbose mode.
.IP "\fB\-\-debug\fR [\fIn\fR]" 4
.IX Item "--debug [n]"
Display debugging messages.
.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. Value same as for \fBbib2gls\fR\*(Aqs
\&\fB\-\-debug\-mode\fR option.
.IP \fB\-\-no\-debug\fR 4
.IX Item "--no-debug"
Switch off debugging mode. Equivalent to \fB\-\-debug\fR \fB0\fR.
.IP "\fB\-\-log\-file\fR \fIfilename\fR" 4
.IX Item "--log-file filename"
Log messages to given file. Intended primarily for debugging messages so
enabling debug mode will automatically create a transcript file, but otherwise
a file won\*(Aqt be created unless this option is used.
.SS "ENCOSING AND LOCALISATION OPTIONS"
.IX Subsection "ENCOSING AND LOCALISATION OPTIONS"
.IP "\fB\-\-texenc\fR \fIname\fR" 4
.IX Item "--texenc name"
Set the character encoding to \fIname\fR for the input \fB.tex\fR files.
.IP "\fB\-\-bibenc\fR \fIname\fR" 4
.IX Item "--bibenc name"
Set the character encoding to \fIname\fR for the output \fB.bib\fR files.
.IP "\fB\-\-locale\fR \fIlang tag\fR" 4
.IX Item "--locale lang tag"
Use the language resource files associated with the given language
tag \fIlang tag\fR. If there isn\*(Aqt an appropriate file, the \fBen\fR
(English) file will be used.
.SS "FILTERING OPTIONS"
.IX Subsection "FILTERING OPTIONS"
.IP "\fB\-\-preamble\-only\fR or \fB\-p\fR" 4
.IX Item "--preamble-only or -p"
Only parse the document preamble. That is, stop parsing if
\&\f(CW\*(C`\ebegin{document}\*(C'\fR encountered.
.IP \fB\-\-no\-preamble\-only\fR 4
.IX Item "--no-preamble-only"
Parse the entire document (default).
.IP "\fB\-\-ignore\-fields\fR \fIlist\fR or \fB\-f\fR \fIlist\fR" 4
.IX Item "--ignore-fields list or -f list"
Ignore all the fields in the comma\-separated \fIlist\fR. If the
list includes \fBsort\fR, \fBtype\fR or \fBcategory\fR it will automatically
implement the corresponding \fB\-\-ignore\-sort\fR, \fB\-\-ignore\-type\fR or
\&\fB\-\-ignore\-category\fR option. Each item in the list should identify
the field by its original case\-sensitive key.
.Sp
This option is cumulative.
.IP \fB\-\-no\-ignore\-fields\fR 4
.IX Item "--no-ignore-fields"
Cancels the effect of \fB\-\-ignore\-fields\fR.
.IP \fB\-\-ignore\-category\fR 4
.IX Item "--ignore-category"
Omit the \fBcategory\fR field. Default if \fB\-\-split\-on\-category\fR.
.IP \fB\-\-no\-ignore\-category\fR 4
.IX Item "--no-ignore-category"
Don\*(Aqt omit the \fBcategory\fR field. Default unless \fB\-\-split\-on\-category\fR.
.IP \fB\-\-ignore\-type\fR 4
.IX Item "--ignore-type"
Omit the \fBtype\fR field. Default if \fB\-\-split\-on\-type\fR.
.IP \fB\-\-no\-ignore\-type\fR 4
.IX Item "--no-ignore-type"
Don\*(Aqt omit the \fBtype\fR field. Default unless \fB\-\-split\-on\-type\fR.
.IP \fB\-\-ignore\-sort\fR 4
.IX Item "--ignore-sort"
Ignore the \fBsort\fR field (default).
.IP \fB\-\-no\-ignore\-sort\fR 4
.IX Item "--no-ignore-sort"
Don\*(Aqt ignore the \fBsort\fR field.
.SS "OUTPUT FILE OPTIONS"
.IX Subsection "OUTPUT FILE OPTIONS"
.IP \fB\-\-overwrite\fR 4
.IX Item "--overwrite"
Overwrite existing .bib files. Default unless \fB\-\-split\-on\-type\fR
used.
.IP \fB\-\-no\-overwrite\fR 4
.IX Item "--no-overwrite"
Don\*(Aqt overwrite existing .bib files. Default if \fB\-\-split\-on\-type\fR
used.
.IP "\fB\-\-split\-on\-type\fR or \fB\-t\fR" 4
.IX Item "--split-on-type or -t"
Split the entries into separate files according to the \fBtype\fR field.
This option automatically implements \fB\-\-ignore\-type\fR and
\&\fB\-\-no\-overwrite\fR.
.IP \fB\-\-no\-split\-on\-type\fR 4
.IX Item "--no-split-on-type"
Don\*(Aqt split the entries into separate files according to the \fBtype\fR
field (default).
.IP "\fB\-\-split\-on\-category\fR or \fB\-c\fR" 4
.IX Item "--split-on-category or -c"
Split the entries into separate files according to the \fBcategory\fR field.
This option automatically implements \fB\-\-ignore\-category\fR and
\&\fB\-\-no\-overwrite\fR.
.IP \fB\-\-no\-split\-on\-category\fR 4
.IX Item "--no-split-on-category"
Don\*(Aqt split the entries into separate files according to the \fBcategory\fR
field (default).
.SS "ADJUSTMENT OPTIONS"
.IX Subsection "ADJUSTMENT OPTIONS"
.IP \fB\-\-absorb\-see\fR 4
.IX Item "--absorb-see"
Absorb \f(CW\*(C`\eglssee\*(C'\fR and \f(CW\*(C`\eglsxtrindexseealso\*(C'\fR into the data (default).
.IP \fB\-\-no\-absorb\-see\fR 4
.IX Item "--no-absorb-see"
Don\*(Aqt absorb \f(CW\*(C`\eglssee\*(C'\fR and \f(CW\*(C`\eglsxtrindexseealso\*(C'\fR into the data.
.IP "\fB\-\-index\-conversion\fR or \fB\-i\fR" 4
.IX Item "--index-conversion or -i"
Any entries that would normally be converted to \f(CW@entry\fR that don\*(Aqt
have a description or just have the description set to
\&\f(CW\*(C`\enopostdesc\*(C'\fR or \f(CW\*(C`\eglsxtrnopostpunc\*(C'\fR will be converted to \f(CW@index\fR
and the \fBdescription\fR field will be omitted.
.IP \fB\-\-no\-index\-conversion\fR 4
.IX Item "--no-index-conversion"
Don\*(Aqt use \f(CW@index\fR instead of \f(CW@entry\fR if the description is empty or
just \f(CW\*(C`\enopostdesc\*(C'\fR or \f(CW\*(C`\eglsxtrnopostpunc\*(C'\fR (default).
.IP "\fB\-\-space\-sub\fR \fIvalue\fR or \fB\-s\fR \fIvalue\fR" 4
.IX Item "--space-sub value or -s value"
Substitute spaces in labels with \fIvalue\fR.
.IP "\fB\-\-field\-map\fR \fImappings\fR or \fB\-m\fR \fImappings\fR" 4
.IX Item "--field-map mappings or -m mappings"
Add source key to destination field label mapping. The argument
should be a comma\-separated list of \fIsrc\-field\fR=\fIdest\-field\fR
pairs. This option is cumulative.
.Sp
The deprecated \fB\-\-key\-map\fR is a synonym of \fB\-\-field\-map\fR.
.IP \fB\-\-no\-field\-map\fR 4
.IX Item "--no-field-map"
Cancels all mappings applied with \fB\-\-field\-map\fR.
The deprecated \fB\-\-no\-key\-map\fR is a synonym of \fB\-\-field\-map\fR.
.IP "\fB\-\-internal\-field\-map\fR \fImappings\fR" 4
.IX Item "--internal-field-map mappings"
Adds the given mappings to the default set of internal field to key mappings.
(For example, \fBdesc\fR is the internal field label of the
\&\fBdescription\fR key.) This option is cumulative.
.Sp
This option is only needed if the internal field label is supplied
in the argument of command such as \f(CW\*(C`\eglssetnoexpandfield\*(C'\fR.
.SH REQUIRES
.IX Header "REQUIRES"
Java 8 and a TeX distribution.
.SH LICENSE
.IX Header "LICENSE"
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 NO WARRANTY, 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,
<https://www.dickimaw\-books.com/>