tUpdate help text - scholarref - tools for DOI and BiBTeX reference extraction,… | |
git clone git://src.adamsgaard.dk/scholarref | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit fafdfa26a670b48af4ada68637a6dff9640cd505 | |
parent 62af61ba6bea7c4100cfdf74731841039c3bf305 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Mon, 16 Sep 2019 15:55:51 +0200 | |
Update help text | |
Diffstat: | |
M README | 12 +++++------- | |
M getdoi | 2 +- | |
M getref | 2 +- | |
3 files changed, 7 insertions(+), 9 deletions(-) | |
--- | |
diff --git a/README b/README | |
t@@ -3,9 +3,9 @@ | |
POSIX shell tools to extract, fetch, and parse DOIs and BiBTeX bibliography | |
references. | |
-- getdoi: extracts a DOI from a file or fetches it online from a search query | |
-- getref: get a BiBTeX entry from a DOI and parse it | |
-- shdl: fetch a pdf from a DOI through sci-hub.tw, with Tor Browser as fallback | |
+- getdoi: takes a file or a search query and returns its DOI | |
+- getref: takes a DOI and returns the corresponding BiBTeX entry | |
+- shdl: takes a DOI and fetches the corresponding pdf from sci-hub.tw | |
The script `scholarref` is an example where `getref` and `getdoi` are | |
combined to obtain a BiBTeX entry from a search query. | |
t@@ -22,7 +22,7 @@ GNU Public License v.3 or later. See LICENSE for details. | |
## Usage | |
usage: getdoi [OPTIONS] QUERY | |
-will attempt to get the DOI from http://api.crossref.org/works | |
+returns the publication DOI from http://api.crossref.org/works | |
where QUERY can consist of publication title, author, DOI, ORCID id, | |
or a PDF file. In case a file is specified, getdoi will attempt to | |
extract the DOI from it. | |
t@@ -39,8 +39,7 @@ OPTIONS are one or more of the following: | |
-o, --open open DOI as url in browser | |
-- do not consider any following args as options | |
- | |
-usage: getref [OPTIONS] DOI1 [DOI2 ...] | |
+usage: getref [OPTIONS] [DOIs ...] | |
will attempt to get a BibTeX citation from https://doi.org | |
If no DOIs are specified, this program will expect DOIs as stdin. | |
t@@ -55,7 +54,6 @@ OPTIONS are one or more of the following: | |
-N, --notify send desktop notification when complete | |
-- do not consider any following args as options | |
- | |
usage: shdl [OPTIONS] DOI1 [DOI2...[DOI N]] | |
will fetch each DOI from http://sci-hub.tw | |
If no DOI is specified, this program will expect DOIs as stdin. | |
diff --git a/getdoi b/getdoi | |
t@@ -5,7 +5,7 @@ host="http://api.crossref.org/works" | |
show_help() { | |
echo "usage: ${0##*/} [OPTIONS] QUERY" | |
- echo "will attempt to get the DOI from $host" | |
+ echo "returns the publication DOI from $host" | |
echo "where QUERY can consist of publication title, author, DOI, ORCID… | |
echo "or a PDF file. In case a file is specified, ${0##*/} will attemp… | |
echo "extract the DOI from it." | |
diff --git a/getref b/getref | |
t@@ -5,7 +5,7 @@ version=1.0 | |
host="https://doi.org" | |
show_help() { | |
- echo "usage: ${0##*/} [OPTIONS] DOI1 [DOI2 ...]" | |
+ echo "usage: ${0##*/} [OPTIONS] [DOIs ...]" | |
echo "will attempt to get a BibTeX citation from $host" | |
echo "If no DOIs are specified, this program will expect DOIs as stdin… | |
echo |