summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorZ. Liu <zhixu.liu@gmail.com>2024-08-28 15:09:50 +0800
committerGerrit Pape <pape@smarden.org>2024-09-25 23:38:40 +0000
commit30281ba43b3d843cc02113f84602c09fe0702674 (patch)
tree25e26518e73d649b52155deb4e159056811f7633 /doc
parent150ccedbb19bfaa9eb3f1daeb54e2ecf47664921 (diff)
downloadrunit-30281ba43b3d843cc02113f84602c09fe0702674.tar.gz
runit-30281ba43b3d843cc02113f84602c09fe0702674.tar.xz
runit-30281ba43b3d843cc02113f84602c09fe0702674.zip
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
Diffstat (limited to 'doc')
-rw-r--r--doc/chpst.8.html14
-rw-r--r--doc/runsv.8.html20
2 files changed, 27 insertions, 7 deletions
diff --git a/doc/chpst.8.html b/doc/chpst.8.html
index 97d90f2..c481ce2 100644
--- a/doc/chpst.8.html
+++ b/doc/chpst.8.html
@@ -11,9 +11,9 @@
 <h2><a name='sect0'>Name</a></h2>
 chpst - runs a program with a changed process state 
 <h2><a name='sect1'>Synopsis</a></h2>
-<b>chpst</b> [-vP012]
+<b>chpst</b> [-vVP012]
 [-u <i>user</i>] [-U <i>user</i>] [-b <i>argv0</i>] [-e <i>dir</i>] [-/ <i>root</i>] [-n <i>inc</i>] [-l|-L <i>lock</i>] [-m <i>bytes</i>] [-d <i>bytes</i>]
-[-o <i>n</i>] [-p <i>n</i>] [-f <i>bytes</i>] [-c <i>bytes</i>] <i>prog</i> 
+[-o <i>n</i>] [-p <i>n</i>] [-f <i>bytes</i>] [-c <i>bytes</i>] [-t <i>seconds</i>] <i>prog</i>
 <h2><a name='sect2'>Description</a></h2>
 <i>prog</i> consists of one or
 more arguments. <p>
@@ -30,7 +30,7 @@ and a <i>group</i>, set the gid to <i>group</i>&rsquo;s gid, as found in <i>/etc
 of <i>user</i>&rsquo;s gid. If <i>group</i> consists of a colon-separated list of group names,
 <b>chpst</b> sets the group ids of all listed groups. If <i>user</i> is prefixed with
 a colon, the <i>user</i> and all <i>group</i> arguments are interpreted as uid and gids
-respectivly, and not looked up in the password or group file. All initial
+respectively, and not looked up in the password or group file. All initial
 supplementary groups are removed. </dd>
 
 <dt><b>-U <i>[:]user[:group]</b> </i></dt>
@@ -38,7 +38,7 @@ supplementary groups are removed. </dd>
 variables $UID and $GID to the <i>user</i>&rsquo;s uid and gid, as found in <i>/etc/passwd</i>.
 If <i>user</i> is followed by a colon and a <i>group</i>, set $GID to the <i>group</i>&rsquo;s gid,
 as found in <i>/etc/group</i>, instead of <i>user</i>&rsquo;s gid. If <i>user</i> is prefixed with a
-colon, the <i>user</i> and <i>group</i> arguments are interpreted as uid and gid respectivly,
+colon, the <i>user</i> and <i>group</i> arguments are interpreted as uid and gid respectively,
 and not looked up in the password or group file. </dd>
 
 <dt><b>-b <i>argv0</b> </i></dt>
@@ -98,10 +98,16 @@ the output file size to <i>bytes</i> bytes. </dd>
 <dd>limit core size. Limit the core
 file size to <i>bytes</i> bytes. </dd>
 
+<dt><b>-t <i>seconds</b> </i></dt>
+<dd>limit CPU time. Limit CPU time to <i>seconds</i> seconds, delivering a SIGXCPU thereafter.</dd>
+
 <dt><b>-v</b> </dt>
 <dd>verbose. Print verbose messages to standard error.
 This includes warnings about limits unsupported by the system. </dd>
 
+<dt><b>-V</b> </dt>
+<dd>version string. Print a version string to standard error. </dd>
+
 <dt><b>-P</b> </dt>
 <dd>pgrphack.
 Run <i>prog</i> in a new process group. </dd>
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.