-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathscitopdf.1
58 lines (55 loc) · 2.93 KB
/
scitopdf.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.TH SCITOPDF 1 scitopdf
.SH NAME
scitopdf \- bash script to fetch, download and auto-open papers from Sci-Hub
.SH SYNOPSIS
\fBscitopdf\fP [\fItitle\fP|\fIyear\fP|\fIauthor\fP|...] ... [\fB-D\fP \fIdownload_dir\fP] [\fB-u\fP \fISH_URL\fP] [\fB-p\fP] [\fB-q\fP]
.br
\fBscitopdf\fP [\fB-l\fP \fIbibliography_file\fP] [\fB-q\fP]
.SH DESCRIPTION
\fBscitopdf\fP automatically downloads papers from Sci-Hub based on heterogeneous and potentially incomplete informations (title, URL, DOI, authors, year of publication...). Sci-Hub URL can be specified or automatically located thanks to \fIhttps://sci-hub.now.sh\fP. Calls to \fIhttps://crossref.org\fP API to pinpoint the right paper are made when provided information to identify a paper is incomplete.
.SH OPTIONS
.TP
.BI \-l\fP, \ \fB\-\-list \ \fB \fIbibliography_file\fP
Download multiple papers referenced in a bibliography file. The bibliography file is any text file. Each reference to a paper in the bibliography file \fBmust\fP be placed on its own single line. A reference to a paper can be any information (title, DOI, etc.).
.TP
.BI \-D\fP, \ \fB \-\-download\-dir\ \fB \fIdownload_dir_path\fP
Manually set the download directory.
.TP
.BI \-u\fP, \ \fB \-\-url\ \fB \fIURL\fP
Manually set Sci-Hub URL.
.TP
.BI \-p\fP, \ \fB \-\-no\-auto\-open
Skip automatic opening of downloaded papers.
.TP
.BI \-q\fP, \ \fB \-\-quiet
Silent mode. Nothing displayed on stdout.
.TP
.BI \-w\fP, \ \fB\-\-wait \ \fB \fIseconds\fP
Set the delay between two requests (in seconds). Accepts integers and decimals (e.g. "0.3" or "10"). Effective only when used in conjunction with \fB--list\fP.
.TP
.BI \-b\fP, \ \fB\-\-break-after \ \fB \fInb_requests\fP
Make a break every chosen number of requests (integers only). Effective only when used in conjunction with \fB--list\fP. If \fB--break-for\fP is not set, default break duration value is 15 seconds.
.TP
.BI \-d\fP, \ \fB\-\-break-for \ \fB \fIseconds\fP
Set the break duration (in seconds). Accepts integers and decimals (e.g. "0.3" or "10"). Effective only when used in conjunction with \fB--list\fP and \fB--break-after\fP.
.TP
.BI \-\-dns \ \fB \fIip1,ip2,...\fP
Experimental. Tries using \fBcurl\fP's \fI--dns-servers\fP option to bypass current DNS settings. But this needs \fBlibcurl\fP to be compiled with \fBc-ares\fP support. If not the case, uses \fBcurl\fP's \fI--resolve\fP option which has a much lower chance of success. DNS must be provided as a comma-separated list of IPs.
.TP
.BI \-\-ref
Display and copy to clipboard paper's BibTex reference.
.TP
.BI \-\-dmenu
Use dmenu as prompt. Support for other menus will come.
.TP
.BI \-h\fP, \ \fB \-\-help
Display help and exit.
.SH EXIT CODES
0 \ Success.
1 \ Error with the URL.
2 \ DOI cannot be found.
3 \ Paper filename is empty.
.SH AUTHORS / CONTRIBUTORS
dougy147 is the main author of \fBscitopdf\fP (originally written in 2020). Contributors are thanked on the GitHub repository (\fIhttps://github.com/dougy147/scitopdf\fP).
.SH LICENSE
GPLv3