summaryrefslogtreecommitdiff
path: root/support/crossrefware/bbl2bib.1
blob: 9741875b2c88b9187d5f861aec13cc1933a41ddc (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
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "bbl2bib 1"
.TH bbl2bib 1 2023-08-20 "" "LATEX CROSSREFWARE"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
bbl2bib.pl \- convert thebibliography environment to a bib file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
bbl2bib.pl [\-d] [\-u] [\fB\-o\fR \fIoutput\fR] \fIfile\fR
.SH OPTIONS
.IX Header "OPTIONS"
.IP [\-d] 4
.IX Item "[-d]"
Send debugging output to stdout
.IP "\fB\-o\fR \fIoutput\fR" 4
.IX Item "-o output"
Output file.  If this option is not used, the name for the 
output file is formed by changing the extension to \f(CW\*(C`.bib\*(C'\fR
.IP \fB\-u\fR 4
.IX Item "-u"
Do not clean URL fields.
.Sp
Normally \f(CW\*(C`bbl2bib\*(C'\fR recognizes URL fields of the kind
\&\f(CW\*(C`http://dx.doi.org\*(C'\fR and their variants and converts them to DOI
fields (see also \fBbiburl2doi\fR\|(1) script).  The switch \fB\-u\fR
suppresses this cleanup.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The script tries to reconstruct a \f(CW\*(C`bib\*(C'\fR file from the corresponding
\&\f(CW\*(C`thebibliography\*(C'\fR environment.  One can argue that this operation is
akin to reconstructing a cow from the steak.  The way the script does
it is searching for the entry in the MR database, and
creating the corresponding BibTeX fields.
.PP
The script reads a TeX or Bbl file and extracts from it the
\&\f(CW\*(C`thebibliography\*(C'\fR environment.  For each bibitem it creates a plain
text bibliography entry, and then  tries to match it in
the database.
.SH "INPUT FILE"
.IX Header "INPUT FILE"
We assume some structure of the input file:
.IP 1. 4
The bibliography is contained between the lines
.Sp
.Vb 1
\&   \ebegin{thebibliography}...
.Ve
.Sp
and
.Sp
.Vb 1
\&   \eend{thebibliography}
.Ve
.IP 2. 4
Each bibliography item starts from the line
.Sp
.Vb 1
\&   \ebibitem[...]{....}
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
.Vb 3
\&   bbl2bib  \-o \- file.tex > result.bib
\&   bbl2bib  \-o result.bib file.bbl
\&   bbl2bib  file.tex
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Boris Veytsman
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2014\-2021  Boris Veytsman
.PP
This is free software.  You may redistribute copies of it under the
terms of the GNU General Public License
<http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY, to the
extent permitted by law.