summaryrefslogtreecommitdiff
path: root/support/bib2gls/convertgls2bib.1
diff options
context:
space:
mode:
Diffstat (limited to 'support/bib2gls/convertgls2bib.1')
-rw-r--r--support/bib2gls/convertgls2bib.181
1 files changed, 75 insertions, 6 deletions
diff --git a/support/bib2gls/convertgls2bib.1 b/support/bib2gls/convertgls2bib.1
index f7e3f097b7..c5f2aceaa0 100644
--- a/support/bib2gls/convertgls2bib.1
+++ b/support/bib2gls/convertgls2bib.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
+.\" Automatically generated by Pod::Man 4.12 (Pod::Simple 3.39)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "CONVERTGLS2BIB 1"
-.TH CONVERTGLS2BIB 1 "2018-03-04" "perl v5.28.1" "convertgls2bib"
+.TH CONVERTGLS2BIB 1 "2020-02-11" "perl v5.30.1" "convertgls2bib"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -144,7 +144,7 @@
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Converts a \fB.tex\fR file containing glossary definitions using
-commands like \fB\enewglossaryentry\fR and \fB\enewacronym\fR to
+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"
@@ -175,8 +175,77 @@ 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\-\-space\-sub\fR \fIvalue\fR" 4
-.IX Item "--space-sub value"
+.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"
@@ -185,7 +254,7 @@ 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 7 and a TeX distribution.
+Java 8 and a TeX distribution.
.SH "LICENSE"
.IX Header "LICENSE"
License GPLv3+: \s-1GNU GPL\s0 version 3 or later