diff options
Diffstat (limited to 'doc/s6-rc-dryrun.html')
| -rw-r--r-- | doc/s6-rc-dryrun.html | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/s6-rc-dryrun.html b/doc/s6-rc-dryrun.html new file mode 100644 index 0000000..0a55fa6 --- /dev/null +++ b/doc/s6-rc-dryrun.html @@ -0,0 +1,64 @@ +<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 <em>verbosity</em></tt> : if <em>verbosity</em> +is 0, s6-rc-dryrun will not print anything to stdout. Default is 1. </li> + <li> <tt>-t <em>timeout</em></tt> : 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 non-immediate startup or shutdown script. </li> +</ul> + +</body> +</html> |