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.1138
1 files changed, 30 insertions, 108 deletions
diff --git a/support/bib2gls/convertgls2bib.1 b/support/bib2gls/convertgls2bib.1
index 36295b9a09..5431556207 100644
--- a/support/bib2gls/convertgls2bib.1
+++ b/support/bib2gls/convertgls2bib.1
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.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'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.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\}
@@ -68,85 +52,23 @@
. \}
.\}
.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.34.1" "convertgls2bib"
+.TH CONVERTGLS2BIB 1 2020-02-11 "perl v5.36.1" 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"
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBconvertgls2bib\fR [\fIoption\fR]+ \fIauxfile\fR
-.SH "DESCRIPTION"
+.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"
+.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR or \fB\-h\fR" 4
.IX Item "--help or -h"
@@ -154,13 +76,13 @@ 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
+.IP \fB\-\-silent\fR 4
.IX Item "--silent"
Suppress all messages except for errors.
-.IP "\fB\-\-verbose\fR" 4
+.IP \fB\-\-verbose\fR 4
.IX Item "--verbose"
Display messages.
-.IP "\fB\-\-debug\fR" 4
+.IP \fB\-\-debug\fR 4
.IX Item "--debug"
Display debugging messages.
.IP "\fB\-\-texenc\fR \fIname\fR" 4
@@ -169,16 +91,16 @@ 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
+.IP \fB\-\-ignore\-sort\fR 4
.IX Item "--ignore-sort"
Ignore the \fBsort\fR field (default).
-.IP "\fB\-\-no\-ignore\-sort\fR" 4
+.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
+.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
+.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
@@ -186,14 +108,14 @@ Don't omit the \fBtype\fR field. Default unless \fB\-\-split\-on\-type\fR.
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
+.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
+.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
+.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
@@ -201,7 +123,7 @@ Don't omit the \fBcategory\fR field. Default unless \fB\-\-split\-on\-category\f
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
+.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).
@@ -210,15 +132,15 @@ field (default).
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.
+\&\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
+.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
+.IP \fB\-\-no\-overwrite\fR 4
.IX Item "--no-overwrite"
Don't overwrite existing .bib files. Default if \fB\-\-split\-on\-type\fR
used.
@@ -228,20 +150,20 @@ 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
+.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
+.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
+.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
+.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
@@ -252,15 +174,15 @@ Substitute spaces in labels with \fIvalue\fR.
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"
+.SH REQUIRES
.IX Header "REQUIRES"
Java 8 and a TeX distribution.
-.SH "LICENSE"
+.SH LICENSE
.IX Header "LICENSE"
-License GPLv3+: \s-1GNU GPL\s0 version 3 or later
+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 \s-1NO WARRANTY,\s0 to the extent permitted by law.
+There is NO WARRANTY, to the extent permitted by law.
.SH "RECOMMENDED READING"
.IX Header "RECOMMENDED READING"
The bib2gls manual:
@@ -280,7 +202,7 @@ The glossaries manual:
.Vb 1
\& texdoc glossaries
.Ve
-.SH "AUTHOR"
+.SH AUTHOR
.IX Header "AUTHOR"
Nicola L. C. Talbot,
<http://www.dickimaw\-books.com/>