aboutsummaryrefslogtreecommitdiffstats
path: root/doc/s6-rc-repo-list.html
blob: 58602ca846067301771a6bcedb60f2abdc175ab2 (plain)
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
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="color-scheme" content="dark light" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>s6-rc: the s6-rc-repo-list program</title>
    <meta name="Description" content="s6-rc: the s6-rc-repo-list program" />
    <meta name="Keywords" content="s6-rc repo list ls sets" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-rc</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The s6-rc-repo-list program </h1>

<p>
 s6-rc-repo-list lists all the <a href="repodefs.html#set">sets</a> in a
<a href="repodefs.html#repository">repository</a>.
</p>

<h2> Interface </h2>

<pre>
     s6-rc-repo-list [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] [ -x <em>exclude</em> ]
</pre>

<ul>
 <li> s6-rc-repo-list lists all the defined sets in the repository, printing
one set name per line. </li>
</ul>

<h2> Options </h2>

<dl>
 <dt> -v <em>verbosity</em>, --verbosity=<em>verbosity</em> </dt>
 <dd> Be more or less verbose. The default is <strong>1</strong>, which means
that error messages and warnings will be written to stderr. 0 means that only
error messages will be written, and 2 or more adds informational messages. </dd>

 <dt> -r <em>repo</em>, --repository=<em>repo</em> </dt>
 <dd> Use the repository in <em>repo</em>, which must exist. Default is
<strong>/var/lib/s6-rc/repository</strong>.
 </dd>

 <dt> -x <em>exclude</em>, --exclude=<em>exclude</em> </dt>
 <dd> If the list contains a set named <em>exclude</em>, do not print it.
(This can save a <tt>grep -v</tt> invocation to automation using the result
of s6-rc-repo-list.) </dd>
</dl>

<h2> Exit codes </h2>

<dl>
 <dt> 0 </dt> <dd> Success. </dd>
 <dt> 100 </dt> <dd> Incorrect usage. </dd>
 <dt> 111 </dt> <dd> System call failed. This usually signals an issue with the
underlying operating system. </dd>
</dl>

</body>
</html>