DOI2BIB(1)

2024-05-07

NAME

doi2bib - converts DOIs into BibTeX entries

SYNOPSIS

doi2bib [-v]

DESCRIPTION

doi2bib generates bibliography entries for BibTeX from DOIs. The entries will be fetched from dblp.org.

A YAML file will be read through stdin. It needs to contain a dictionary for the key "entries". The keys represent the keys that you can use in LaTeX for citing. The values are the DOIs. You can also specify substitutions using the array stored underneath the "subs" key. For each substitution, specify a regular expression with the key "replace". The matched substring will be replaced with the string specified as "with". The generated BibTeX entries will be printed to stdout.

A cache will be used for storing BibTeX entries. It is located in your XDG_CACHE_HOME directory (usually ~/.cache). The file is named "doi2bib.nuummite".

The options are as follows:

-v

Print the version information and exit

EXIT STATUS

doi2bib exits with 0 if the bibliography entries have been generated successfully. Otherwise, it exits with a value of 1.

EXAMPLES

Calling the program might look something like this:


doi2bib < doibib.yml > literature.bib

This is an example of what your YAML input may look like:


entries:
  unsafePerformIO: 10.1007/10722298_3
  dejafu: 10.1145/2804302.2804306
subs:
  - replace: Peyton Jones
    with: '{Peyton Jones}'

HISTORY

This tool was originally written in Python by Joachim Breitner. This program is a rewrite in Crystal of that tool.

AUTHORS

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/doi2bib. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.