summaryrefslogtreecommitdiff
path: root/biblio/bibtex/utils/r2bib/r2bib.1
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /biblio/bibtex/utils/r2bib/r2bib.1
Initial commit
Diffstat (limited to 'biblio/bibtex/utils/r2bib/r2bib.1')
-rw-r--r--biblio/bibtex/utils/r2bib/r2bib.149
1 files changed, 49 insertions, 0 deletions
diff --git a/biblio/bibtex/utils/r2bib/r2bib.1 b/biblio/bibtex/utils/r2bib/r2bib.1
new file mode 100644
index 0000000000..233d6f516a
--- /dev/null
+++ b/biblio/bibtex/utils/r2bib/r2bib.1
@@ -0,0 +1,49 @@
+.TH "r2bib" 1 "Mon Dec 7 2015" "Version 2015-12-07" "r2bib" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+r2bib \-
+.IP "\(bu" 2
+convert refer input to BibTex \&.bib files
+.PP
+.PP
+.SH "SYNOPSIS "
+.PP
+.PP
+\fIr2bib\fP \fIfile\fP \&.\&.\&.
+.PP
+.SH "DESCRIPTION "
+.PP
+.PP
+\fIr2bib\fP reads the \fIfiles\fP and produces a \fIbibtex\fP reference list (a \&.bib file) on the standard output\&. If no files are given, r2bib reads standard input\&.
+.PP
+Since \fIrefer\fP files are inherently unstructured (compared to \fIbibtex\fP ) \fIr2bib\fP only does a passable job\&. In particular \fIrefer\fP doesn't require a keyword, while \fIbibtex\fP does\&. The heuristic that \fIr2bib\fP uses for cooking up a keyword, in order of precedence, is:
+.PP
+.IP "\(bu" 2
+Use the keyword entry (%K) if it's only one word\&.
+.IP "\(bu" 2
+Use the label entry (%L) if it's only one word\&.
+.IP "\(bu" 2
+Otherwise just use the string 'keyN' where N is the count of this bibliographic entry in the refer file(s)\&.
+.PP
+.PP
+To determine the type of reference that the \fIrefer\fP entry is, \fIr2bib\fP has to do some 'calculated guessing'\&. The heuristic used here (again, in order of precedence) is:
+.PP
+.IP "\(bu" 2
+If it has a journal entry (%J) then it's considered to be an @article\&.
+.IP "\(bu" 2
+If it has a report entry (%R) then it's considered to be a @techreport\&.
+.IP "\(bu" 2
+If it has a issuer entry (%I) then it's considered to be a @book\&.
+.IP "\(bu" 2
+Otherwise it's considered to be a @misc\&.
+.PP
+.PP
+Quite often \fIr2bib\fP will misguess and you will need to edit (by hand) the resulting \&.bib file\&.
+.PP
+Any fields that \fIr2bib\fP doesn't know about it will ignore (and complain about on stderr)\&.
+.PP
+.SH "AUTHOR "
+.PP
+.PP
+Rusty Wright, Center For Music Experiment, University of California San Diego\&.