cold/group_vocabulary.1.html at main · caltechlibrary/cold · GitHub

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
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>cold</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>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</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/cold">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>group_vocabulary</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>group_vocabulary [OPTIONS]</p>
<h1 id="description">DESCRIPTION</h1>
<p>group_vocabulary generates an RDM Vocabulary for Groups based on the
dataset collection called “groups.ds”. The dataset collection must be in
the same directory where you run group_vocabulary. It must have the
“group_vocabulary” query defined in the “cold_api.yaml” file and the
“cold_api” service running. If all goes well group_vocabulary should
exist with a zero status code.</p>
<h1 id="option">OPTION</h1>
<dl>
<dt>-h, –help</dt>
<dd>
display this help page
</dd>
<dt>-l, –license</dt>
<dd>
display the license information
</dd>
<dt>-v, –version</dt>
<dd>
display version number
</dd>
</dl>
<h1 id="example">EXAMPLE</h1>
<p>Aside from being in the same directory as “groups.ds”
group_vocabulary will do the rest.</p>
<pre class="shell"><code>group_vocabulary</code></pre>
</section>
<footer-global></footer-global>
</body>
</html>