From 6209d961fd35c1d4e92d26c76a8ba0e98f1a6415 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 9 Jul 2026 08:13:55 +0000
Subject:  Add -c|--clean option to s6-rc (untested)

---
 doc/s6-rc.html | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/s6-rc.html b/doc/s6-rc.html
index afd6795..bf861eb 100644
--- a/doc/s6-rc.html
+++ b/doc/s6-rc.html
@@ -48,10 +48,10 @@ root privileges.
 
 <pre>
      s6-rc help
-     s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] [ -E | -e ] list <em>servicenames...</em>
+     s6-rc [ -l live ] [ -b ] [ -a | -c ] [ -u | -d ] [ -E | -e ] list <em>servicenames...</em>
      s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] [ -E | -e ] listall <em>servicenames...</em>
      s6-rc [ -l live ] [ -b ] diff
-     s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d | -D ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
+     s6-rc [ -l live ] [ -b ] [ -a ] [ -c ] [ -u | -d | -D ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
 </pre>
 
 <ul>
@@ -161,6 +161,14 @@ the meaning is reversed: the state will be brought to the maximum
 possible set that does not include selected services. The change, however,
 is always performed in the same manner: first the unwanted services are
 all brought down, then the wanted services are all brought up. </li>
+ <li> <tt>-c</tt>&nbsp;: clean. After the machine state transition, if
+there are services that are <em>up</em> but not <em>explicit</em>, i.e.
+explicitly listed when s6-rc brought them up the last time, stop these services.
+This is only useful with <tt>s6-rc stop</tt> or <tt>s6-rc -d change</tt>.
+A service is marked as <em>explicit</em> if it appears in the arguments of
+an <tt>s6-rc start</tt> or <tt>s6-rc -u change</tt> command, or is part of
+a bundle given as an argument. A service that is not <em>explicit</em> is called
+<em>pulled</em>, because it has been pulled by dependencies. </li>
 </ul>
 
 <h2> Subcommands </h2>
@@ -191,6 +199,22 @@ essential (i.e. which have the <tt>flag-essential</tt> file in
 their source definition directories) will not be printed.
 </p>
 
+<p>
+ If the <tt>-c</tt> option has been given, the command changes
+a bit. Instead of printing the selection, it prints <em>all</em>
+the atomic services available in the database (except essential ones
+if the <tt>-e</tt> option has also been given), along with their
+state, one service per line; the fields are separated with slashes (<tt>/</tt>).
+The fields are:
+</p>
+
+<ul>
+ <li> <tt>longrun</tt> or <tt>oneshot</tt> </li>
+ <li> <tt>up</tt> or <tt>down</tt> </li>
+ <li> <tt>explicit</tt> or <tt>pulled</tt> (or nothing if the service is down) </li>
+ <li> <tt>essential</tt> or <tt>recommended</tt> or nothing </li>
+</ul>
+
 <h3> s6-rc listall <em>servicenames...</em> </h3>
 
 <ul>
-- 
cgit v1.3.1