Debian Codegraph @

texmf-dist/source/support/bib2gls/convertgls2bib.pod

raw
1 =head1 SYNOPSIS
2
3 B<convertgls2bib> [I<option>]+ I<texfile> I<bibfile>
4
5 =head1 DESCRIPTION
6
7 Converts a B<.tex> file containing glossary definitions using
8 commands like C<\newglossaryentry> and C<\newacronym> to
9 a B<.bib> file in the format required for B<bib2gls>.
10 Distributed with F<bib2gls>.
11
12 =head1 OPTIONS
13
14 =head2 GENERAL OPTIONS
15
16 =over 4
17
18 =item B<--help> or B<-h>
19
20 Display help message and exit.
21
22 =item B<--version> or B<-v>
23
24 Display version information and exit.
25
26 =item B<--silent> or B<--quiet> or B<-q>
27
28 Suppress all messages except for errors.
29
30 =item B<--verbose>
31
32 Switch on verbose mode.
33
34 =item B<--no-verbose>
35
36 Switch off verbose mode.
37
38 =item B<--debug> [I<n>]
39
40 Display debugging messages.
41
42 =item B<--debug-mode> I<setting>
43
44 May be used instead of B<--debug> where the level number is
45 difficult to remember. Value same as for B<bib2gls>'s
46 B<--debug-mode> option.
47
48 =item B<--no-debug>
49
50 Switch off debugging mode. Equivalent to B<--debug> B<0>.
51
52 =item B<--log-file> I<filename>
53
54 Log messages to given file. Intended primarily for debugging messages so
55 enabling debug mode will automatically create a transcript file, but otherwise
56 a file won't be created unless this option is used.
57
58 =back
59
60 =head2 ENCOSING AND LOCALISATION OPTIONS
61
62 =over 4
63
64 =item B<--texenc> I<name>
65
66 Set the character encoding to I<name> for the input B<.tex> files.
67
68 =item B<--bibenc> I<name>
69
70 Set the character encoding to I<name> for the output B<.bib> files.
71
72 =item B<--locale> I<lang tag>
73
74 Use the language resource files associated with the given language
75 tag I<lang tag>. If there isn't an appropriate file, the B<en>
76 (English) file will be used.
77
78 =back
79
80 =head2 FILTERING OPTIONS
81
82 =over 4
83
84 =item B<--preamble-only> or B<-p>
85
86 Only parse the document preamble. That is, stop parsing if
87 C<\begin{document}> encountered.
88
89 =item B<--no-preamble-only>
90
91 Parse the entire document (default).
92
93 =item B<--ignore-fields> I<list> or B<-f> I<list>
94
95 Ignore all the fields in the comma-separated I<list>. If the
96 list includes B<sort>, B<type> or B<category> it will automatically
97 implement the corresponding B<--ignore-sort>, B<--ignore-type> or
98 B<--ignore-category> option. Each item in the list should identify
99 the field by its original case-sensitive key.
100
101 This option is cumulative.
102
103 =item B<--no-ignore-fields>
104
105 Cancels the effect of B<--ignore-fields>.
106
107 =item B<--ignore-category>
108
109 Omit the B<category> field. Default if B<--split-on-category>.
110
111 =item B<--no-ignore-category>
112
113 Don't omit the B<category> field. Default unless B<--split-on-category>.
114
115 =item B<--ignore-type>
116
117 Omit the B<type> field. Default if B<--split-on-type>.
118
119 =item B<--no-ignore-type>
120
121 Don't omit the B<type> field. Default unless B<--split-on-type>.
122
123 =item B<--ignore-sort>
124
125 Ignore the B<sort> field (default).
126
127 =item B<--no-ignore-sort>
128
129 Don't ignore the B<sort> field.
130
131 =back
132
133 =head2 OUTPUT FILE OPTIONS
134
135 =over 4
136
137 =item B<--overwrite>
138
139 Overwrite existing .bib files. Default unless B<--split-on-type>
140 used.
141
142 =item B<--no-overwrite>
143
144 Don't overwrite existing .bib files. Default if B<--split-on-type>
145 used.
146
147 =item B<--split-on-type> or B<-t>
148
149 Split the entries into separate files according to the B<type> field.
150 This option automatically implements B<--ignore-type> and
151 B<--no-overwrite>.
152
153 =item B<--no-split-on-type>
154
155 Don't split the entries into separate files according to the B<type>
156 field (default).
157
158 =item B<--split-on-category> or B<-c>
159
160 Split the entries into separate files according to the B<category> field.
161 This option automatically implements B<--ignore-category> and
162 B<--no-overwrite>.
163
164 =item B<--no-split-on-category>
165
166 Don't split the entries into separate files according to the B<category>
167 field (default).
168
169 =back
170
171 =head2 ADJUSTMENT OPTIONS
172
173 =over 4
174
175 =item B<--absorb-see>
176
177 Absorb C<\glssee> and C<\glsxtrindexseealso> into the data (default).
178
179 =item B<--no-absorb-see>
180
181 Don't absorb C<\glssee> and C<\glsxtrindexseealso> into the data.
182
183 =item B<--index-conversion> or B<-i>
184
185 Any entries that would normally be converted to C<@entry> that don't
186 have a description or just have the description set to
187 C<\nopostdesc> or C<\glsxtrnopostpunc> will be converted to C<@index>
188 and the B<description> field will be omitted.
189
190 =item B<--no-index-conversion>
191
192 Don't use C<@index> instead of C<@entry> if the description is empty or
193 just C<\nopostdesc> or C<\glsxtrnopostpunc> (default).
194
195 =item B<--space-sub> I<value> or B<-s> I<value>
196
197 Substitute spaces in labels with I<value>.
198
199 =item B<--field-map> I<mappings> or B<-m> I<mappings>
200
201 Add source key to destination field label mapping. The argument
202 should be a comma-separated list of I<src-field>=I<dest-field>
203 pairs. This option is cumulative.
204
205 The deprecated B<--key-map> is a synonym of B<--field-map>.
206
207 =item B<--no-field-map>
208
209 Cancels all mappings applied with B<--field-map>.
210 The deprecated B<--no-key-map> is a synonym of B<--field-map>.
211
212 =item B<--internal-field-map> I<mappings>
213
214 Adds the given mappings to the default set of internal field to key mappings.
215 (For example, B<desc> is the internal field label of the
216 B<description> key.) This option is cumulative.
217
218 This option is only needed if the internal field label is supplied
219 in the argument of command such as C<\glssetnoexpandfield>.
220
221 =back
222
223 =head1 REQUIRES
224
225 Java 8 and a TeX distribution.
226
227 =head1 LICENSE
228
229 License GPLv3+: GNU GPL version 3 or later
230 <http://gnu.org/licenses/gpl.html>
231 This is free software: you are free to change and redistribute it.
232 There is NO WARRANTY, to the extent permitted by law.
233
234 =head1 RECOMMENDED READING
235
236 The bib2gls manual:
237
238 texdoc bib2gls
239
240 The glossaries-extra manual:
241
242 texdoc glossaries-extra
243
244 The glossaries manual:
245
246 texdoc glossaries
247
248 =head1 AUTHOR
249
250 Nicola L. C. Talbot,
251 L<https://www.dickimaw-books.com/>
252
253 =cut
254