bibx.1

.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "BIBX" "1" "" "Version 1.0" "bibx Command Documentation"
.hy
.SH NAME
.PP
bibx \[em] Extract bibliography entries from a reference BibTeX file
using citations from LaTeX sources, to create project-specific BibTeX
files.
.SH SYNOPSIS
.PP
bibx [-h] [-v] [-o OUTPUT] [-e ENTRIES] [-q] [-f FILES [FILES \&...]]
[-i INDENT] [-d] [-b BIB]
.SH DESCRIPTION
.PP
This program extracts citations made in LaTeX source files and generates
a BibTeX file with entries that are found.
In order to generate the BibTeX file, a single \[lq]global\[rq] BibTeX
file that acts as a database to look for matching entries.
Output is written to `ext.bib' by default.
Requires at least one LaTeX source.
.PP
If extra entries other than those found from the LaTeX sources are to be
added to the output file, it can be done by using the -e option.
The file must contain a single BibTeX label on each line.
.PP
For example:
.IP
.nf
\f[C]
label1
label2
label3
\f[R]
.fi
.SH OPTIONS
.PP
-h, --help
.IP
.nf
\f[C]
Show help and exit
\f[R]
.fi
.PP
-v, --version
.IP
.nf
\f[C]
Show version information and exit
\f[R]
.fi
.PP
-b BIB, --bib BIB
.IP
.nf
\f[C]
Specify global BibTeX file to look for entries in (required if not using -h
or -v)
\f[R]
.fi
.PP
-f FILES [FILES \&...], --files FILES [FILES \&...]
.IP
.nf
\f[C]
LaTeX files to scan for citations whose BibTeX entries need to be extracted
(required if not using -h or -v)
\f[R]
.fi
.PP
-o OUTPUT, --output OUTPUT
.IP
.nf
\f[C]
Specify file to write the BibTeX output to. Defaults to \[aq]./ext.bib\[aq].
\f[R]
.fi
.PP
-e ENTRIES, --entries ENTRIES
.IP
.nf
\f[C]
Specify file containing extra entries names to be searched and included in
the final output.
\f[R]
.fi
.PP
-i INDENT, --indent INDENT
.IP
.nf
\f[C]
Specify the character(s) to be used to indent the BibTeX entries in the
final output. Defaults to four spaces. Example: -i \[dq]  \[dq] (use two spaces).
\f[R]
.fi
.PP
-d, --dryrun
.IP
.nf
\f[C]
Perform a dry-run, i.e. do not output to a file, just print info messages.
Ignores the -o option, affected by -q.
\f[R]
.fi
.PP
-q, --quiet
.IP
.nf
\f[C]
Suppress output to stdout
\f[R]
.fi
.SH EXAMPLE
.PP
Assume that there are two LaTeX files: \f[V]a.tex\f[R] and
\f[V]b.tex\f[R], the reference BibTeX file is \f[V]g.bib\f[R] and we
want the output file to be \f[V]refs.bib\f[R].
.PP
The command to achieve this would be:
.IP
.nf
\f[C]
bibx -b g.bib -o refs.bib -f a.tex b.tex
\f[R]
.fi
.SH BUGS
.PP
See GitHub issues: https://github.com/CodePurble/bibextract/issues
.SH AUTHOR
.PP
Ramprakash C (https://github.com/CodePurble)
.SH COPYRIGHT
.PP
Free use of this software is granted under the terms of the GPLv3
License.
.PP
See: https://github.com/CodePurble/bibextract/blob/master/LICENSE
.SH SEE ALSO
.PP
bibtex(1), latex(1)