aboutsummaryrefslogtreecommitdiffstats
path: root/doc/s6-rc-set-status.html
blob: 7e55a11352d84eb94f385525a27b5a8bb848b2cd (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>s6-rc: the s6-rc-set-status program</title>
    <meta name="Description" content="s6-rc: the s6-rc-set-status program" />
    <meta name="Keywords" content="s6-rc s6-rc-set-status repo set sub list services status" />
    <!-- <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-set-status program </h1>

<p>
 s6-rc-set-status lists some of, or all, the services of a <a href="repodefs.html#set">set</a>,
along with the <a href="repodefs.html#sub">sub</a> each service is on.
</p>

<h2> Interface </h2>

<pre>
     s6-rc-set-status [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] [ -E | -e ] [ -L ] <em>set</em> [ <em>services...</em> ]
</pre>

<ul>
 <li> s6-rc-set-status prints the services in set <em>set</em> of repository
<em>repo</em>, one per line, to stdout. If some <em>services...</em> are specified,
it only prints the ones listed; if <em>services...</em> is empty, it prints all the
services in the set. Each line consists of:
  <ul>
   <li> The name of the service </li>
   <li> A slash (<tt>/</tt>) character </li>
   <li> The canonical name for the sub the service is in. </li>
  </ul> </li>
 <li> It exits 0. </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> -E, --with-essentials </dt>
 <dd> Do not ignore services in the <tt>always</tt> sub, i.e. services marked as
essential. This is the default. </dd>

 <dt> -e, --without-essentials </dt>
 <dd> Ignore services in the <tt>always</tt> sub: do not print them. </dd>

 <dt> -L. --list </dt>
 <dd> Do not print <tt>/<em>sub</em></tt> at the end of each line: only print the service names. </dd>
</dl>

<h2> Exit codes </h2>

<dl>
 <dt> 0 </dt> <dd> Success. </dd>
 <dt> 3 </dt> <dd> Nonexistent set. </dd>
 <dt> 100 </dt> <dd> Incorrect usage. </dd>
 <dt> 102 </dt> <dd> Invalid repository. </dd>
 <dt> 111 </dt> <dd> System call failed. </dd>
</dl>

<h2> Notes </h2>

<ul>
 <li> s6-rc-set-status is meant to be used with automation such as
util-linux's <a href="https://man7.org/linux/man-pages/man1/column.1.html">column</a>
for formatting. A slash is used to separate the service name for the sub because
slashes cannot appear in service names. </li>
</ul>

</body>
</html>