README.rst 1.13 KB
Newer Older
1
=======================================
User expired's avatar
User expired committed
2
3
4
5
6
7
8
9
10
11
12
Command line tools for bibtex citations
=======================================

-   Generate file names and citation keys
-   Format bibtex files
-   Abbreviate journal names
-   Insert links to pdf files for JabRef
-   Manage multi record bibtex files
-   Extract single records
-   Output text citations for copy and paste

13
The html version of this file is created with ``python-docutils``::
User expired's avatar
User expired committed
14

15
    make README.html
User expired's avatar
User expired committed
16

17
:Author: Bjoern Bastian
User expired's avatar
User expired committed
18

19
:Date: 2019-09-09
User expired's avatar
User expired committed
20
21

Usage
22
=====
User expired's avatar
User expired committed
23

24
25
See online documentation in
[bibtools.pdf](https://bbastian.pavo.uberspace.de/files/bibtools/bibtools.pdf)
26
or build ``doc/bibtools.pdf`` yourself with ``make doc``.
User expired's avatar
User expired committed
27
28

Setup
29
30
=====
GNU AWK is required.  For Ubuntu you may install the ``gawk`` package::
31
32

    sudo apt-get install gawk
User expired's avatar
User expired committed
33

34
Install scripts to ``$HOME/bin``::
User expired's avatar
User expired committed
35
36
37

    make install

38
Run all or selected tests::
39
40
41
42

    make test # all tests
    ./test/test_runner pattern...

43
44
  With one or more filter patterns containing the wildcard ``*``.  Otherwise,
  usual regular expressions are supported, for example ``testJournal[UD]*``.
45

46
Remove scripts from ``$HOME/bin``::
User expired's avatar
User expired committed
47
48

    make uninstall