| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" |
| 56 |
.\" Required to disable full justification in groff 1.23.0. |
| 57 |
.if n .ds AD l |
| 58 |
.\" ======================================================================== |
| 59 |
.\" |
| 60 |
.IX Title "CONVERTGLS2BIB 1" |
| 61 |
.TH CONVERTGLS2BIB 1 2024-12-21 "perl v5.40.0" convertgls2bib |
| 62 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 63 |
.\" way too many mistakes in technical documents. |
| 64 |
.if n .ad l |
| 65 |
.nh |
| 66 |
.SH SYNOPSIS |
| 67 |
.IX Header "SYNOPSIS" |
| 68 |
\&\fBconvertgls2bib\fR [\fIoption\fR]+ \fItexfile\fR \fIbibfile\fR |
| 69 |
.SH DESCRIPTION |
| 70 |
.IX Header "DESCRIPTION" |
| 71 |
Converts a \fB.tex\fR file containing glossary definitions using |
| 72 |
commands like \f(CW\*(C`\enewglossaryentry\*(C'\fR and \f(CW\*(C`\enewacronym\*(C'\fR to |
| 73 |
a \fB.bib\fR file in the format required for \fBbib2gls\fR. |
| 74 |
Distributed with \fIbib2gls\fR. |
| 75 |
.SH OPTIONS |
| 76 |
.IX Header "OPTIONS" |
| 77 |
.SS "GENERAL OPTIONS" |
| 78 |
.IX Subsection "GENERAL OPTIONS" |
| 79 |
.IP "\fB\-\-help\fR or \fB\-h\fR" 4 |
| 80 |
.IX Item "--help or -h" |
| 81 |
Display help message and exit. |
| 82 |
.IP "\fB\-\-version\fR or \fB\-v\fR" 4 |
| 83 |
.IX Item "--version or -v" |
| 84 |
Display version information and exit. |
| 85 |
.IP "\fB\-\-silent\fR or \fB\-\-quiet\fR or \fB\-q\fR" 4 |
| 86 |
.IX Item "--silent or --quiet or -q" |
| 87 |
Suppress all messages except for errors. |
| 88 |
.IP \fB\-\-verbose\fR 4 |
| 89 |
.IX Item "--verbose" |
| 90 |
Switch on verbose mode. |
| 91 |
.IP \fB\-\-no\-verbose\fR 4 |
| 92 |
.IX Item "--no-verbose" |
| 93 |
Switch off verbose mode. |
| 94 |
.IP "\fB\-\-debug\fR [\fIn\fR]" 4 |
| 95 |
.IX Item "--debug [n]" |
| 96 |
Display debugging messages. |
| 97 |
.IP "\fB\-\-debug\-mode\fR \fIsetting\fR" 4 |
| 98 |
.IX Item "--debug-mode setting" |
| 99 |
May be used instead of \fB\-\-debug\fR where the level number is |
| 100 |
difficult to remember. Value same as for \fBbib2gls\fR\*(Aqs |
| 101 |
\&\fB\-\-debug\-mode\fR option. |
| 102 |
.IP \fB\-\-no\-debug\fR 4 |
| 103 |
.IX Item "--no-debug" |
| 104 |
Switch off debugging mode. Equivalent to \fB\-\-debug\fR \fB0\fR. |
| 105 |
.IP "\fB\-\-log\-file\fR \fIfilename\fR" 4 |
| 106 |
.IX Item "--log-file filename" |
| 107 |
Log messages to given file. Intended primarily for debugging messages so |
| 108 |
enabling debug mode will automatically create a transcript file, but otherwise |
| 109 |
a file won\*(Aqt be created unless this option is used. |
| 110 |
.SS "ENCOSING AND LOCALISATION OPTIONS" |
| 111 |
.IX Subsection "ENCOSING AND LOCALISATION OPTIONS" |
| 112 |
.IP "\fB\-\-texenc\fR \fIname\fR" 4 |
| 113 |
.IX Item "--texenc name" |
| 114 |
Set the character encoding to \fIname\fR for the input \fB.tex\fR files. |
| 115 |
.IP "\fB\-\-bibenc\fR \fIname\fR" 4 |
| 116 |
.IX Item "--bibenc name" |
| 117 |
Set the character encoding to \fIname\fR for the output \fB.bib\fR files. |
| 118 |
.IP "\fB\-\-locale\fR \fIlang tag\fR" 4 |
| 119 |
.IX Item "--locale lang tag" |
| 120 |
Use the language resource files associated with the given language |
| 121 |
tag \fIlang tag\fR. If there isn\*(Aqt an appropriate file, the \fBen\fR |
| 122 |
(English) file will be used. |
| 123 |
.SS "FILTERING OPTIONS" |
| 124 |
.IX Subsection "FILTERING OPTIONS" |
| 125 |
.IP "\fB\-\-preamble\-only\fR or \fB\-p\fR" 4 |
| 126 |
.IX Item "--preamble-only or -p" |
| 127 |
Only parse the document preamble. That is, stop parsing if |
| 128 |
\&\f(CW\*(C`\ebegin{document}\*(C'\fR encountered. |
| 129 |
.IP \fB\-\-no\-preamble\-only\fR 4 |
| 130 |
.IX Item "--no-preamble-only" |
| 131 |
Parse the entire document (default). |
| 132 |
.IP "\fB\-\-ignore\-fields\fR \fIlist\fR or \fB\-f\fR \fIlist\fR" 4 |
| 133 |
.IX Item "--ignore-fields list or -f list" |
| 134 |
Ignore all the fields in the comma\-separated \fIlist\fR. If the |
| 135 |
list includes \fBsort\fR, \fBtype\fR or \fBcategory\fR it will automatically |
| 136 |
implement the corresponding \fB\-\-ignore\-sort\fR, \fB\-\-ignore\-type\fR or |
| 137 |
\&\fB\-\-ignore\-category\fR option. Each item in the list should identify |
| 138 |
the field by its original case\-sensitive key. |
| 139 |
.Sp |
| 140 |
This option is cumulative. |
| 141 |
.IP \fB\-\-no\-ignore\-fields\fR 4 |
| 142 |
.IX Item "--no-ignore-fields" |
| 143 |
Cancels the effect of \fB\-\-ignore\-fields\fR. |
| 144 |
.IP \fB\-\-ignore\-category\fR 4 |
| 145 |
.IX Item "--ignore-category" |
| 146 |
Omit the \fBcategory\fR field. Default if \fB\-\-split\-on\-category\fR. |
| 147 |
.IP \fB\-\-no\-ignore\-category\fR 4 |
| 148 |
.IX Item "--no-ignore-category" |
| 149 |
Don\*(Aqt omit the \fBcategory\fR field. Default unless \fB\-\-split\-on\-category\fR. |
| 150 |
.IP \fB\-\-ignore\-type\fR 4 |
| 151 |
.IX Item "--ignore-type" |
| 152 |
Omit the \fBtype\fR field. Default if \fB\-\-split\-on\-type\fR. |
| 153 |
.IP \fB\-\-no\-ignore\-type\fR 4 |
| 154 |
.IX Item "--no-ignore-type" |
| 155 |
Don\*(Aqt omit the \fBtype\fR field. Default unless \fB\-\-split\-on\-type\fR. |
| 156 |
.IP \fB\-\-ignore\-sort\fR 4 |
| 157 |
.IX Item "--ignore-sort" |
| 158 |
Ignore the \fBsort\fR field (default). |
| 159 |
.IP \fB\-\-no\-ignore\-sort\fR 4 |
| 160 |
.IX Item "--no-ignore-sort" |
| 161 |
Don\*(Aqt ignore the \fBsort\fR field. |
| 162 |
.SS "OUTPUT FILE OPTIONS" |
| 163 |
.IX Subsection "OUTPUT FILE OPTIONS" |
| 164 |
.IP \fB\-\-overwrite\fR 4 |
| 165 |
.IX Item "--overwrite" |
| 166 |
Overwrite existing .bib files. Default unless \fB\-\-split\-on\-type\fR |
| 167 |
used. |
| 168 |
.IP \fB\-\-no\-overwrite\fR 4 |
| 169 |
.IX Item "--no-overwrite" |
| 170 |
Don\*(Aqt overwrite existing .bib files. Default if \fB\-\-split\-on\-type\fR |
| 171 |
used. |
| 172 |
.IP "\fB\-\-split\-on\-type\fR or \fB\-t\fR" 4 |
| 173 |
.IX Item "--split-on-type or -t" |
| 174 |
Split the entries into separate files according to the \fBtype\fR field. |
| 175 |
This option automatically implements \fB\-\-ignore\-type\fR and |
| 176 |
\&\fB\-\-no\-overwrite\fR. |
| 177 |
.IP \fB\-\-no\-split\-on\-type\fR 4 |
| 178 |
.IX Item "--no-split-on-type" |
| 179 |
Don\*(Aqt split the entries into separate files according to the \fBtype\fR |
| 180 |
field (default). |
| 181 |
.IP "\fB\-\-split\-on\-category\fR or \fB\-c\fR" 4 |
| 182 |
.IX Item "--split-on-category or -c" |
| 183 |
Split the entries into separate files according to the \fBcategory\fR field. |
| 184 |
This option automatically implements \fB\-\-ignore\-category\fR and |
| 185 |
\&\fB\-\-no\-overwrite\fR. |
| 186 |
.IP \fB\-\-no\-split\-on\-category\fR 4 |
| 187 |
.IX Item "--no-split-on-category" |
| 188 |
Don\*(Aqt split the entries into separate files according to the \fBcategory\fR |
| 189 |
field (default). |
| 190 |
.SS "ADJUSTMENT OPTIONS" |
| 191 |
.IX Subsection "ADJUSTMENT OPTIONS" |
| 192 |
.IP \fB\-\-absorb\-see\fR 4 |
| 193 |
.IX Item "--absorb-see" |
| 194 |
Absorb \f(CW\*(C`\eglssee\*(C'\fR and \f(CW\*(C`\eglsxtrindexseealso\*(C'\fR into the data (default). |
| 195 |
.IP \fB\-\-no\-absorb\-see\fR 4 |
| 196 |
.IX Item "--no-absorb-see" |
| 197 |
Don\*(Aqt absorb \f(CW\*(C`\eglssee\*(C'\fR and \f(CW\*(C`\eglsxtrindexseealso\*(C'\fR into the data. |
| 198 |
.IP "\fB\-\-index\-conversion\fR or \fB\-i\fR" 4 |
| 199 |
.IX Item "--index-conversion or -i" |
| 200 |
Any entries that would normally be converted to \f(CW@entry\fR that don\*(Aqt |
| 201 |
have a description or just have the description set to |
| 202 |
\&\f(CW\*(C`\enopostdesc\*(C'\fR or \f(CW\*(C`\eglsxtrnopostpunc\*(C'\fR will be converted to \f(CW@index\fR |
| 203 |
and the \fBdescription\fR field will be omitted. |
| 204 |
.IP \fB\-\-no\-index\-conversion\fR 4 |
| 205 |
.IX Item "--no-index-conversion" |
| 206 |
Don\*(Aqt use \f(CW@index\fR instead of \f(CW@entry\fR if the description is empty or |
| 207 |
just \f(CW\*(C`\enopostdesc\*(C'\fR or \f(CW\*(C`\eglsxtrnopostpunc\*(C'\fR (default). |
| 208 |
.IP "\fB\-\-space\-sub\fR \fIvalue\fR or \fB\-s\fR \fIvalue\fR" 4 |
| 209 |
.IX Item "--space-sub value or -s value" |
| 210 |
Substitute spaces in labels with \fIvalue\fR. |
| 211 |
.IP "\fB\-\-field\-map\fR \fImappings\fR or \fB\-m\fR \fImappings\fR" 4 |
| 212 |
.IX Item "--field-map mappings or -m mappings" |
| 213 |
Add source key to destination field label mapping. The argument |
| 214 |
should be a comma\-separated list of \fIsrc\-field\fR=\fIdest\-field\fR |
| 215 |
pairs. This option is cumulative. |
| 216 |
.Sp |
| 217 |
The deprecated \fB\-\-key\-map\fR is a synonym of \fB\-\-field\-map\fR. |
| 218 |
.IP \fB\-\-no\-field\-map\fR 4 |
| 219 |
.IX Item "--no-field-map" |
| 220 |
Cancels all mappings applied with \fB\-\-field\-map\fR. |
| 221 |
The deprecated \fB\-\-no\-key\-map\fR is a synonym of \fB\-\-field\-map\fR. |
| 222 |
.IP "\fB\-\-internal\-field\-map\fR \fImappings\fR" 4 |
| 223 |
.IX Item "--internal-field-map mappings" |
| 224 |
Adds the given mappings to the default set of internal field to key mappings. |
| 225 |
(For example, \fBdesc\fR is the internal field label of the |
| 226 |
\&\fBdescription\fR key.) This option is cumulative. |
| 227 |
.Sp |
| 228 |
This option is only needed if the internal field label is supplied |
| 229 |
in the argument of command such as \f(CW\*(C`\eglssetnoexpandfield\*(C'\fR. |
| 230 |
.SH REQUIRES |
| 231 |
.IX Header "REQUIRES" |
| 232 |
Java 8 and a TeX distribution. |
| 233 |
.SH LICENSE |
| 234 |
.IX Header "LICENSE" |
| 235 |
License GPLv3+: GNU GPL version 3 or later |
| 236 |
<http://gnu.org/licenses/gpl.html> |
| 237 |
This is free software: you are free to change and redistribute it. |
| 238 |
There is NO WARRANTY, to the extent permitted by law. |
| 239 |
.SH "RECOMMENDED READING" |
| 240 |
.IX Header "RECOMMENDED READING" |
| 241 |
The bib2gls manual: |
| 242 |
.PP |
| 243 |
.Vb 1 |
| 244 |
\& texdoc bib2gls |
| 245 |
.Ve |
| 246 |
.PP |
| 247 |
The glossaries\-extra manual: |
| 248 |
.PP |
| 249 |
.Vb 1 |
| 250 |
\& texdoc glossaries\-extra |
| 251 |
.Ve |
| 252 |
.PP |
| 253 |
The glossaries manual: |
| 254 |
.PP |
| 255 |
.Vb 1 |
| 256 |
\& texdoc glossaries |
| 257 |
.Ve |
| 258 |
.SH AUTHOR |
| 259 |
.IX Header "AUTHOR" |
| 260 |
Nicola L. C. Talbot, |
| 261 |
<https://www.dickimaw\-books.com/> |