diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/overview.html | 15 | ||||
| -rw-r--r-- | doc/s6.html | 14 | ||||
| -rw-r--r-- | doc/s6_live.html | 35 |
3 files changed, 58 insertions, 6 deletions
diff --git a/doc/overview.html b/doc/overview.html index cd9f338..84a81e1 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -265,8 +265,9 @@ the kind of commands that can be worked with. <tbody> <tr> <td> <tt>rc-service foobar start</tt> </td> - <td> <tt>s6 live start foobar</tt> </td> - <td> Starts a service in the live database. </td> + <td> <tt>s6 live start foobar</tt> or <tt>s6 start foobar</tt> </td> + <td> Starts a service in the live database. <tt>s6 start foobar</tt> +is a shortcut. </td> </tr> <tr> <td> <tt>rc-service foobar status</tt> </td> @@ -282,13 +283,15 @@ in which case it will give detailed information on its supervised instance. </td </tr> <tr> <td> <tt>rc-update add foobar</tt> </td> - <td> <tt>s6 set enable foobar</tt> </td> - <td> Enable service <tt>foobar</tt> in the <tt>current</tt> offline working set. </td> + <td> <tt>s6 set enable foobar</tt> or <tt>s6 enable foobar</tt> </td> + <td> Enable service <tt>foobar</tt> in the <tt>current</tt> offline working set. +<tt>s6 enable foobar</tt> is a shortcut. </td> </tr> <tr> <td> <tt>rc-update del foobar</tt> </td> - <td> <tt>s6 set disable foobar</tt> </td> - <td> Disable service <tt>foobar</tt> in the <tt>current</tt> offline working set. </td> + <td> <tt>s6 set disable foobar</tt> or <tt>s6 disable foobar</tt> </td> + <td> Disable service <tt>foobar</tt> in the <tt>current</tt> offline working set. +<tt>s6 disable foobar</tt> is a shortcut. </td> </tr> <tr> <td> <tt>rc-update show</tt> </td> diff --git a/doc/s6.html b/doc/s6.html index a5454c3..0f6fc39 100644 --- a/doc/s6.html +++ b/doc/s6.html @@ -220,6 +220,20 @@ to shut the system down. The details are available <a href="s6_system.html">here</a>. </p> +<h3 id="shortcuts"> shortcuts </h3> + +<p> + Some common subcommands have shortcuts, for ease of typing. +</p> + +<ul> + <li> <tt>s6 enable</tt> is a shortcut for <a href="s6_set.html#enable"><tt>s6 set enable</tt></a>. </li> + <li> <tt>s6 disable</tt> is a shortcut for <a href="s6_set.html#disable"><tt>s6 set disable</tt></a>. </li> + <li> <tt>s6 start</tt> is a shortcut for <a href="s6_live.html#start"><tt>s6 live start</tt></a>. </li> + <li> <tt>s6 stop</tt> is a shortcut for <a href="s6_live.html#stop"><tt>s6 live stop</tt></a>. </li> + <li> <tt>s6 kill</tt> is a shortcut for <a href="s6_process.html#kill"><tt>s6 process kill</tt></a>. </li> +</ul> + <h2 id="notes"> Notes </h2> <ul> diff --git a/doc/s6_live.html b/doc/s6_live.html index 0af54c5..d770f80 100644 --- a/doc/s6_live.html +++ b/doc/s6_live.html @@ -206,6 +206,41 @@ The default is <tt>default</tt>, possibly overridden by the <a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>. </dd> </dl> +<h3 id="reset"> reset </h3> + +<h4> Interface </h4> + +<pre> + s6 live reset [ -n ] [ -t <em>timeout</em> ] [ -D <em>bundle</em> ] +</pre> + +<ul> + <li> <tt>s6 live reset</tt> brings up all the services in the default bundle +<em>and</em> brings down all the services that are <em>not</em> in it. In +other words, it resets the machine state to what it was right after +booting. </li> +</ul> + +<h4> Options </h4> + +<dl> +<dt> <tt>-n</tt>, <tt>--dry-run</tt> </dt> +<dd> Only print what would be done; do not actually change service states. </dd> + +<dt> <tt>-t <em>timeout</em></tt>, <tt>--timeout=<em>timeout</em></tt> </dt> +<dd> If the whole change still hasn't completed after <em>timeout</em> +milliseconds, stop waiting and don't attempt to perform the remaining +transitions. By default, <em>timeout</em> is 0, meaning infinite: the +command can wait forever. </dd> + +<dt> <tt>-D <em>bundle</em></tt>, <tt>--default-bundle=<em>bundle</em></tt> </dt> +<dd> Align to the bundle of services named <em>bundle</em> instead. +The default is <tt>default</tt>, possibly overridden by the +<tt>--with-default-bundle</tt> build-time configure option in +<a href="//skarnet.org/software/s6-rc/">s6-rc</a> or +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>. </dd> +</dl> + <h3 id="stop-everything"> stop-everything </h3> <h4> Interface </h4> |
