summaryrefslogtreecommitdiff
path: root/doc/s6-rc-dryrun.html
blob: ee23d3b8d0352975bf6ada644e63eff15cf0ce47 (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
<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-dryrun program</title>
    <meta name="Description" content="s6-rc: the s6-rc-dryrun program" />
    <meta name="Keywords" content="s6-rc dry run s6-rc-dryrun command rc init dependency state management services" />
    <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
  </head>
<body>

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

<h1> The s6-rc-dryrun internal program </h1>

<p>
 s6-rc-dryrun is a command wrapper and nullifier, roughly
equivalent to the Unix <tt>echo</tt> command. When run, it
simply prints its arguments to stdout.
</p>

<p>
 s6-rc-dryrun is not meant to be used directly; it is
internally called by
<a href="s6-rc.html">s6-rc</a> when given the <tt>-n</tt>
option. When a dry-running s6-rc instance wants to change the
system state by spawning a command <tt><em>cmd</em></tt>, it spawns
<tt>s6-rc-dryrun <em>cmd</em></tt> instead, which allows the user
to see what would have been done without actually running the
command.
</p>

<h2> Interface </h2>

<pre>
     s6-rc-dryrun [ -v <em>verbosity</em> ] [ -t <em>timeout</em> ] <em>cmd...</em>
</pre>

<ul>
 <li> s6-rc-dryrun prints its name, a colon, a space, and
the space-separated list of its arguments to stdout. </li>
 <li> It then waits for <em>timeout</em> milliseconds, then
exits 0. </li>
</ul>

<h2> Options </h2>

<ul>
 <li> <tt>-v&nbsp;<em>verbosity</em></tt>&nbsp;: if <em>verbosity</em>
is 0, s6-rc-dryrun will not print anything to stdout. Default is 1. </li>
 <li> <tt>-t&nbsp;<em>timeout</em></tt>&nbsp;: sleep for <em>timeout</em>
milliseconds before exiting. Default is 1000, but when invoked by
<a href="s6-rc.html">s6-rc</a>, it will be the value of the
<em>dryruntimeout</em> argument to the <tt>-n</tt> option. This is
used to simulate a start or stop script that does not complete
immediately. </li>
</ul>

</body>
</html>