.\" -*- 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 "DATATOOL2BIB 1"
.TH DATATOOL2BIB 1 2024-12-11 "perl v5.40.0" datatool2bib
.\" 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"
\&\fBdatatool2bib\fR [\fIoption\fR]+ \fIin\-file\fR \fIbibfile\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Converts a \fI.tex\fR file containing \fIdatatool.sty\fR databases to 
a \fI.bib\fR file in the format required for \fBbib2gls\fR. 
Distributed with \fIbib2gls\fR.
.PP
The TeX Parser Library is used to parse the input, which may be 
a DTLTEX or DBTEX file or a file that contains
database construction commands, such as 
\&\f(CW\*(C`\eDTLnewdb\*(C'\fR or \f(CW\*(C`\eDTLaction\*(C'\fR. The input file may also be a CSV file
if used with \fB\-\-read\fR.
.PP
The \fBdatatool\fR and \fBdatagidx\fR are automatically implemented so the
input file does not need to include either them with \f(CW\*(C`\eusepackage\*(C'\fR.
In general, it\*(Aqs best not to include the entire document but instead
input a file that just contains the database construction commands,
as the TeX Parser Library only has a limited set of commands that it
recognises.
.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. 
Each item in the list should identify
the field by its original case\-sensitive column 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\-\-skip\-datagidx\fR 4
.IX Item "--skip-datagidx"
Skip the special \fBdatagidx\fR internal database.
(Default.)
.IP \fB\-\-no\-skip\-datagidx\fR 4
.IX Item "--no-skip-datagidx"
Don\*(Aqt skip the special \fBdatagidx\fR internal database.
.SS "OUTPUT FILE OPTIONS"
.IX Subsection "OUTPUT FILE OPTIONS"
.IP \fB\-\-overwrite\fR 4
.IX Item "--overwrite"
Overwrite existing .bib files.
.IP \fB\-\-no\-overwrite\fR 4
.IX Item "--no-overwrite"
Don\*(Aqt overwrite existing .bib files.
.IP \fB\-\-split\fR 4
.IX Item "--split"
Split the entries into separate files according to the database.
.IP \fB\-\-no\-split\fR 4
.IX Item "--no-split"
Don\*(Aqt split the entries into separate files (default).
.SS "ADJUSTMENT OPTIONS"
.IX Subsection "ADJUSTMENT OPTIONS"
.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 column key to destination field label mappings. The argument
should be a comma\-separated list of \fIcol\-key\fR=\fIbib\-field\fR
pairs. This option is cumulative.
.IP \fB\-\-no\-field\-map\fR 4
.IX Item "--no-field-map"
Cancels all mappings applied with \fB\-\-field\-map\fR.
.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 \fBdescription\fR field will be converted to \f(CW@index\fR.
.IP \fB\-\-no\-index\-conversion\fR 4
.IX Item "--no-index-conversion"
Don\*(Aqt replace \f(CW@entry\fR with \f(CW@index\fR if the description is missing (default).
.IP \fB\-\-detect\-symbols\fR 4
.IX Item "--detect-symbols"
Attempt to detect entries that should be \f(CW@symbol\fR or \f(CW@number\fR
based on the value of the \fBname\fR field.
.IP \fB\-\-no\-detect\-symbols\fR 4
.IX Item "--no-detect-symbols"
Don\*(Aqt attempt symbol detection (default).
.IP "\fB\-\-label\fR \fIcol\-key\fR or \fB\-L\fR" 4
.IX Item "--label col-key or -L"
Use column identified by \fIcol\-key\fR for the entry label. The default
column key is \fBLabel\fR so if the database doesn\*(Aqt have a column with
this key, you will either need to specify a column with \fB\-\-label\fR
or use \fB\-\-auto\-label\fR. This option is ignored with \fB\-\-auto\-label\fR.
.IP "\fB\-\-auto\-label\fR or \fB\-a\fR" 4
.IX Item "--auto-label or -a"
Auto\-generate entry labels instead of using a column value.
.IP \fB\-\-no\-auto\-label\fR 4
.IX Item "--no-auto-label"
Don\*(Aqt auto\-generate entry labels. Use the column identified by
\&\fB\-\-label\fR for the entry label. (Default.)
.IP "\fB\-\-auto\-label\-prefix\fR \fIprefix\fR" 4
.IX Item "--auto-label-prefix prefix"
Use \fIprefix\fR when auto\-generating entry labels. Ignored with
\&\fB\-\-no\-auto\-label\fR.
.IP \fB\-\-adjust\-gls\fR 4
.IX Item "--adjust-gls"
Adjust labels in commands like \f(CW\*(C`\egls\*(C'\fR in field values. (Default.)
This will also replace the \fIdatagidx.sty\fR commands like \f(CW\*(C`\eglsnl\*(C'\fR
with the closest \fIglossaries.sty\fR equivalent.
.IP \fB\-\-no\-adjust\-gls\fR 4
.IX Item "--no-adjust-gls"
Don\*(Aqt adjust labels in commands like \f(CW\*(C`\egls\*(C'\fR in field values.
.IP "\fB\-\-dependency\-field\fR \fIfield\-name\fR" 4
.IX Item "--dependency-field field-name"
Sets the name of the dependency field. Has no effect with
\&\fB\-\-no\-strip\-glsadd\fR. With \fB\-\-strip\-glsadd\fR, the label from the
stripped \f(CW\*(C`\eglsadd\*(C'\fR argument will be added to the field identified
by \fIfield\-name\fR. The default is \fBdependency\fR which will be ignored
by \fBbib2gls\fR unless instructed otherwise (via field aliasing etc).
.IP \fB\-\-no\-dependency\-field\fR 4
.IX Item "--no-dependency-field"
Don\*(Aqt save labels from any stripped \f(CW\*(C`\eglsadd\*(C'\fR instances.
.IP \fB\-\-strip\fR 4
.IX Item "--strip"
Switch on all strip options.
.IP \fB\-\-no\-strip\fR 4
.IX Item "--no-strip"
Switch off all strip options.
.IP \fB\-\-strip\-glsadd\fR 4
.IX Item "--strip-glsadd"
Strip \f(CW\*(C`\eglsadd\*(C'\fR and its argument from field values. (Default.)
.IP \fB\-\-no\-strip\-glsadd\fR 4
.IX Item "--no-strip-glsadd"
Don\*(Aqt strip \f(CW\*(C`\eglsadd\*(C'\fR from field values.
.IP \fB\-\-strip\-acronym\-font\fR 4
.IX Item "--strip-acronym-font"
Strip \f(CW\*(C`\eacronymfont\*(C'\fR from field values. (Default.)
.IP \fB\-\-no\-strip\-acronym\-font\fR 4
.IX Item "--no-strip-acronym-font"
Don\*(Aqt strip \f(CW\*(C`\eacronymfont\*(C'\fR from field values.
.IP \fB\-\-strip\-acronym\-text\fR 4
.IX Item "--strip-acronym-text"
Strip \fBtext\fR field for acronyms identified by \f(CW\*(C`\enewacro\*(C'\fR.
(Default.)
.IP \fB\-\-no\-strip\-acronym\-text\fR 4
.IX Item "--no-strip-acronym-text"
Don\*(Aqt strip \fBtext\fR field for acronyms.
.IP \fB\-\-strip\-acronym\-name\fR 4
.IX Item "--strip-acronym-name"
Strip \fBname\fR field for acronyms identified by \f(CW\*(C`\enewacro\*(C'\fR.
(Default.)
.IP \fB\-\-no\-strip\-acronym\-name\fR 4
.IX Item "--no-strip-acronym-name"
Don\*(Aqt strip \fBname\fR field for acronyms.
.IP \fB\-\-strip\-case\-change\fR 4
.IX Item "--strip-case-change"
Strip known case\-changing commands (such as \f(CW\*(C`\emakefirstuc\*(C'\fR or \f(CW\*(C`\ecapitalisewords\*(C'\fR)
from field values.
.IP \fB\-\-nostrip\-case\-change\fR 4
.IX Item "--nostrip-case-change"
Don\*(Aqt strip case\-changing commands.  (Default.)
.SS "OTHER OPTIONS"
.IX Subsection "OTHER OPTIONS"
These options correspond to features introduced to \fIdatatool.sty\fR
version 3.0, which has a setting that stores the numeric value and
currency symbol (where applicable) when parsing data. The original
string (formatted number), numeric value and currency symbol are
stored in a special datum format, which ordinarily expands to its
original formatted text but also allows the previously parsed
information to be easily extracted without having to reparse the
data.
.IP "\fB\-\-setup\fR \fIoptions\fR" 4
.IX Item "--setup options"
Implement \f(CW\*(C`\eDTLsetup{\*(C'\fR\fIoptions\fR\f(CW\*(C`}\*(C'\fR at the start. This can include
options such as \f(CW\*(C`store\-datum\*(C'\fR, \f(CW\*(C`new\-value\-expand\*(C'\fR,
\&\f(CW\*(C`new\-value\-trim\*(C'\fR and \f(CW\*(C`default\-name\*(C'\fR.
.IP "\fB\-\-read\fR \fIoptions\fR" 4
.IX Item "--read options"
Instead of simply parsing the input file as a normal \fI.tex\fR file,
the source is presented to the TeX parser as 
\&\f(CW\*(C`\eDTLread[\*(C'\fR\fIoptions\fR\f(CW\*(C`]{\*(C'\fR\fIin\-file\fR\f(CW\*(C`}\*(C'\fR where the options can be
used to specify the file format (for example, \f(CW\*(C`format=tsv\*(C'\fR).
.Sp
If the \fIoptions\fR list is empty (after trimming white space) then
this becomes equivalent to \fB\-\-no\-read\fR.
.IP \fB\-\-no\-read\fR 4
.IX Item "--no-read"
The input file is parsed as a normal \fI.tex\fR file, which may be the
complete document or a file that can be \f(CW\*(C`\einput\*(C'\fR into a document.
(Default.)
.IP "\fB\-\-save\-value\fR \fIsuffix\fR" 4
.IX Item "--save-value suffix"
If a field value is parsed and identified as numeric, the
unformatted numeric value will be saved in a field whose name is
constructed from the original field name followed by the given
\&\fIsuffix\fR.
.IP \fB\-\-no\-save\-value\fR 4
.IX Item "--no-save-value"
Don\*(Aqt save numeric value in a separate field. (Default.)
.IP "\fB\-\-save\-currency\fR \fIsuffix\fR" 4
.IX Item "--save-currency suffix"
If a field value is parsed and identified as currency data, the
currency symbol will be saved in a field whose name is
constructed from the original field name followed by the given
\&\fIsuffix\fR.
.IP \fB\-\-no\-save\-currency\fR 4
.IX Item "--no-save-currency"
Don\*(Aqt save currency symbol in a separate field. (Default.)
.IP \fB\-\-save\-datum\fR 4
.IX Item "--save-datum"
Equivalent to:
.Sp
.Vb 1
\&        \-\-save\-value \*(Aq\-value\*(Aq \-\-save\-currency \*(Aq\-currency\*(Aq
.Ve
.IP \fB\-\-no\-save\-datum\fR 4
.IX Item "--no-save-datum"
Equivalent to \fB\-\-no\-save\-value\fR \fB\-\-no\-save\-currency\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
.PP
The datatool manual:
.PP
.Vb 1
\&        texdoc datatool
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Nicola L. C. Talbot,
<https://www.dickimaw\-books.com/>