aboutsummaryrefslogtreecommitdiffstats
path: root/doc/s6-frontend-helper-kill.html
blob: 1a3a315ec89b58f2583516f17820d289e12f1af1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<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-frontend: the s6-frontend-helper-kill program</title>
    <meta name="Description" content="s6-frontend: the s6-frontend-helper-kill program" />
    <meta name="Keywords" content="s6 s6-frontend helper kill" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">s6-frontend</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> The <tt>s6-frontend-helper-kill</tt> internal program </h1>

<p>
 <tt>s6-frontend-helper-kill</tt> is a small utility to send numerical
signals to a given list of pids. It is not meant to be called directly,
although nothing bad will happen if you do. It is used in command lines crafted by
<a href="s6_process_kill.html#kill">s6 process kill</a> instead of the POSIX
<a href="https://pubs.opengroup.org/onlinepubs/9799919799/utilities/kill.html">kill</a>
program, because the latter does not support sending arbitrary numerical signals.
</p>

<h2 id="interface"> Interface </h2>

<pre>
     s6-frontend-helper-kill <em>sig</em> <em>pids...</em>
</pre>

<ul>
 <li> s6-frontend-helper-kill reads an integer, <em>sig</em>, and a list
of one or more integers, <em>pids...</em>, on its command line. </li>
 <li> It sends signal number <em>sig</em> to all the processes listed as <em>pids...</em>. </li>
</ul>

<h2 id="exitcodes"> Exit codes </h2>

<dl>
 <dt> 0 </dt> <dd> Success </dd>
 <dt> 100 </dt> <dd> Wrong usage </dd>
</dl>

</body>
</html>