summaryrefslogtreecommitdiff
path: root/support/bib2gls/src/convertgls2bib.pod
blob: 967b59aca4c00848ccb8ace205871ed58d7714aa (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
=head1 SYNOPSIS

B<convertgls2bib> [I<option>]+ I<auxfile>

=head1 DESCRIPTION

Converts a B<.tex> file containing glossary definitions using
commands like C<\newglossaryentry> and C<\newacronym> to 
a B<.bib> file in the format required for B<bib2gls>.

=head1 OPTIONS

=over 4

=item B<--help> or B<-h>

Display help message and exit.

=item B<--version> or B<-v>

Display version information and exit.

=item B<--silent>

Suppress all messages except for errors.

=item B<--verbose>

Display messages.

=item B<--debug>

Display debugging messages.

=item B<--texenc> I<name>

Set the character encoding to I<name> for the input B<.tex> files.

=item B<--bibenc> I<name>

Set the character encoding to I<name> for the output B<.bib> files.

=item B<--ignore-sort>

Ignore the B<sort> field (default).

=item B<--no-ignore-sort>

Don't ignore the B<sort> field.

=item B<--ignore-type>

Omit the B<type> field. Default if B<--split-on-type>.

=item B<--no-ignore-type>

Don't omit the B<type> field. Default unless B<--split-on-type>.

=item B<--split-on-type> or B<-t>

Split the entries into separate files according to the B<type> field.
This option automatically implements B<--ignore-type> and
B<--no-overwrite>.

=item B<--no-split-on-type>

Don't split the entries into separate files according to the B<type>
field (default).

=item B<--ignore-category>

Omit the B<category> field. Default if B<--split-on-category>.

=item B<--no-ignore-category>

Don't omit the B<category> field. Default unless B<--split-on-category>.

=item B<--split-on-category> or B<-t>

Split the entries into separate files according to the B<category> field.
This option automatically implements B<--ignore-category> and
B<--no-overwrite>.

=item B<--no-split-on-category>

Don't split the entries into separate files according to the B<category>
field (default).

=item B<--ignore-fields> I<list> or B<-f> I<list>

Ignore all the fields in the comma-separated I<list>. If the
list includes B<sort>, B<type> or B<category> it will automatically
implement the corresponding B<--ignore-sort>, B<--ignore-type> or
B<--ignore--category> option.

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.

=item B<--overwrite>

Overwrite existing .bib files. Default unless B<--split-on-type>
used.

=item B<--no-overwrite>

Don't overwrite existing .bib files. Default if B<--split-on-type>
used.

=item B<--index-conversion> or B<-i>

Any entries that would normally be converted to C<@entry> that don't
have a description or just have the description set to
C<\nopostdesc> or C<\glsxtrnopostpunc> will be converted to C<@index>
and the B<description> field will be omitted.

=item B<--no-index-conversion> 

Don't use C<@index> instead of C<@entry> if the description is empty or
just C<\nopostdesc> or C<\glsxtrnopostpunc> (default).

=item B<--absorb-see> 

Absorb C<\glssee> and C<\glsxtrindexseealso> into the data (default).

=item B<--no-absorb-see> 

Don't absorb C<\glssee> and C<\glsxtrindexseealso> into the data.

=item B<--preamble-only> or B<-p>

Only parse the document preamble.

=item B<--no-preamble-only>

Parse the entire document (default).

=item B<--space-sub> I<value> or B<-s> I<value>

Substitute spaces in labels with I<value>.

=item B<--locale> I<lang tag>

Use the language resource files associated with the given language
tag I<lang tag>. If there isn't an appropriate file, the B<en>
(English) file will be used.

=back

=head1 REQUIRES

Java 8 and a TeX distribution.

=head1 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.

=head1 RECOMMENDED READING

The bib2gls manual:

        texdoc bib2gls

The glossaries-extra manual:

        texdoc glossaries-extra

The glossaries manual:

        texdoc glossaries

=head1 AUTHOR

Nicola L. C. Talbot,
L<http://www.dickimaw-books.com/>

=cut