Repository navigation
Expand file tree
/
Copy pathdataciteapi.1.html
More file actions
75 lines (75 loc) · 2.85 KB
/
Copy pathdataciteapi.1.html
File metadata and controls
75 lines (75 loc) · 2.85 KB
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!DOCTYPE html>
<html lang="en-US">
<head>
<title>dataciteapi</title>
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<a href="#main-content" class="visually-hidden">skip to main content</a>
<nav>
<ul>
<li><a href="/">All Library Apps</a></li>
<li><a href="index.html">Home</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="INSTALL.html">INSTALL</a></li>
<li><a href="user_manual.html">User Manual</a></li>
<!-- <li><a href="about.html">About</a></li> -->
<!-- <li><a href="search.html">Search</a></li> -->
<li><a href="https://github.com/caltechlibrary/dataciteapi">Code Repository</a></li>
</ul>
</nav>
<section id="main-content">
<h1 id="name">NAME</h1>
<p>dataciteapi</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>{appName} <a href="#options">OPTIONS</a> works|dois DOI</p>
<h1 id="description">DESCRIPTION</h1>
<p>dataciteapi retrieves “works” or “dois” from the DataCite API.</p>
<p>dataciteapi is a command line utility to retrieve “works” objects
from the DataCite API. It follows the protocols described at</p>
<p>https://support.datacite.org/docs/api</p>
<p>NOTE: As of release v1.0.3 you can pass an arXiv id and it will be
converted to the DOI version of arXiv registered with DataCite under the
10.48550 prefix.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-mailto string</dt>
<dd>
set the mailto value for API access
</dd>
<dt>-version</dt>
<dd>
display app version
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Return the works for the doi “10.1037/0003-066x.59.1.29”</p>
<pre><code> {appName} -mailto="jdoe@example.edu" \
works "10.1037/0003-066x.59.1.29"</code></pre>
<p>Return the dois for the doi “10.1037/0003-066x.59.1.29”</p>
<pre><code> {appName} -mailto="jdoe@example.edu" \
dois "10.1037/0003-066x.59.1.29"</code></pre>
<p>Get the works DataCite record for “arXiv:2202.01037”</p>
<pre><code> {appName} -mailto="jdoe@example.edi" \
works "arXiv:2202.01037"</code></pre>
<p>Get the dois DataCite record for “arXiv:2202.01037”</p>
<pre><code> {appName} -mailto="jdoe@example.edi" \
dois "arXiv:2202.01037"</code></pre>
</section>
<footer-global></footer-global>
</body>
</html>