From 30281ba43b3d843cc02113f84602c09fe0702674 Mon Sep 17 00:00:00 2001
From: "Z. Liu" <zhixu.liu@gmail.com>
Date: Wed, 28 Aug 2024 15:09:50 +0800
Subject: add/update doc & man page of chpst and runsv

1. fix error in runsv for log/finish:
     Log ./finish script is not actually invoked. It is not clear, whether this
     limitation is worth lifting.
2. add options -t and -V to chpst man page; ignore -r since it's obsolete.
3. clarify in runsv.8 manpage how signal override works with control/dx

copied from debian's patch:
  0009-fix-error-in-manpage.patch
  0027-Clarify-runsv-8-control-dx.patch
  0027-Add-missing-options-to-chpst-manpage.patch

links of debian's patches is: https://salsa.debian.org/debian/runit/-/tree/master/debian/patches
---
 doc/runsv.8.html | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

(limited to 'doc/runsv.8.html')

diff --git a/doc/runsv.8.html b/doc/runsv.8.html
index d27deeb..04f299e 100644
--- a/doc/runsv.8.html
+++ b/doc/runsv.8.html
@@ -115,15 +115,29 @@ to send a TERM signal to the socklog-unix service, either do   # sv term
 <i><b>printf</b>(1)</i> usually blocks if no <b>runsv</b> process is running in the service
 directory. 
 <h2><a name='sect4'>Customize Control</a></h2>
-For each control character <i>c</i> sent to the control
+For each control character <i>c</i> except "d" and "x" sent to the control
 pipe, <b>runsv</b> first checks if <i>service</i>/control/<i>c</i> exists and is executable.
 If so, it starts <i>service</i>/control/<i>c</i> and waits for it to terminate, before
 interpreting the command. If the program exits with return code 0, <b>runsv</b>
 refrains from sending the service the corresponding signal. The command
 <i>o</i> is always considered as command <i>u</i>. On command <i>d</i> first <i>service</i>/control/<i>t</i>
 is checked, and then <i>service</i>/control/<i>d</i>. On command <i>x</i> first <i>service</i>/control/<i>t</i>
-is checked, and then <i>service</i>/control/<i>x</i>. The control of the optional log
-service cannot be customized. 
+is checked, and then <i>service</i>/control/<i>x</i>. Specifically:<br>
+<p>
+<dt><b>1.</b> </dt>
+<dd><b>runsv</b> checks whether <i>service</i>/control/<i>t</i> exists and is executable and runs it if yes.</dd>
+
+<dt><b>2.</b> </dt>
+<dd>If <i>service</i>/control/<i>t</i> exits nonzero, or is not executable or doesn't exist, <b>runsv</b> sends
+              the service a TERM signal.</dd>
+
+<dt><b>3.</b> </dt>
+<dd><b>runsv</b> sends the service a CONT signal, disregarding <i>service</i>/control/<i>c</i> even if it exists and is executable.</dd>
+
+<dt><b>4.</b> </dt>
+<dd><b>runsv</b> checks whether <i>service</i>/control/<i>d</i> (or control/<i>x</i>) exists and is executable and runs it if yes. Its exit status is ignored.</dd>
+<p>
+The control of the optional log service cannot be customized.
 <h2><a name='sect5'>Signals</a></h2>
 If <b>runsv</b> receives a TERM signal, it
 acts as if the character x was written to the control pipe. 
-- 
cgit 1.4.1