summaryrefslogtreecommitdiff
path: root/support/bib2gls/convertgls2bib.1
blob: 1b2b3016e0ff3e942e895dd528321166d0fa7a6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >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
.\"
.\" 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 "CONVERTGLS2BIB 1"
.TH CONVERTGLS2BIB 1 "2020-02-11" "perl v5.30.3" "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]+ \fIauxfile\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.
.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\-\-silent\fR" 4
.IX Item "--silent"
Suppress all messages except for errors.
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
Display messages.
.IP "\fB\-\-debug\fR" 4
.IX Item "--debug"
Display debugging messages.
.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\-\-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't ignore the \fBsort\fR field.
.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't omit the \fBtype\fR field. Default unless \fB\-\-split\-on\-type\fR.
.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't split the entries into separate files according to the \fBtype\fR
field (default).
.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't omit the \fBcategory\fR field. Default unless \fB\-\-split\-on\-category\fR.
.IP "\fB\-\-split\-on\-category\fR or \fB\-t\fR" 4
.IX Item "--split-on-category or -t"
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't split the entries into separate files according to the \fBcategory\fR
field (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.
.Sp
This option isn't cumulative. An empty list will clear a previously
set list but won't undo the sort, type or category ignore 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't overwrite existing .bib files. Default if \fB\-\-split\-on\-type\fR
used.
.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't
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't 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\-\-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't absorb \f(CW\*(C`\eglssee\*(C'\fR and \f(CW\*(C`\eglsxtrindexseealso\*(C'\fR into the data.
.IP "\fB\-\-preamble\-only\fR or \fB\-p\fR" 4
.IX Item "--preamble-only or -p"
Only parse the document preamble.
.IP "\fB\-\-no\-preamble\-only\fR" 4
.IX Item "--no-preamble-only"
Parse the entire document (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\-\-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't an appropriate file, the \fBen\fR
(English) file will be used.
.SH "REQUIRES"
.IX Header "REQUIRES"
Java 8 and a TeX distribution.
.SH "LICENSE"
.IX Header "LICENSE"
License GPLv3+: \s-1GNU GPL\s0 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.
.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,
<http://www.dickimaw\-books.com/>