summaryrefslogtreecommitdiff
path: root/doc/s6-frontend-alias-sv.html
blob: a619661d99d6c897354ca26ab71bb7b770e5db72 (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<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-alias-sv program</title>
    <meta name="Description" content="s6-frontend: the s6-frontend-alias-sv program" />
    <meta name="Keywords" content="s6 command s6-frontend-alias-sv alias sv runit" />
    <!-- <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-alias-sv</tt> program </h1>

<p>
<tt>s6-frontend-alias-sv</tt> implements
<a href="http://smarden.org/runit/">runit</a>'s
<a href="http://smarden.org/runit/sv.8.html">sv</a> command over a
<a href="//skarnet.org/software/s6/">s6</a> supervision tree, via
native <a href="//skarnet.org/software/s6/">s6</a> commands.

</p>

<h2> Interface </h2>

<pre>
     s6-frontend-alias-sv [ -v ] [ -w <em>secs</em> ] <em>command</em> <em>services...</em>
</pre>

<p>
 When s6-frontend has been configured with the
<tt>--enable-aliases-runit</tt> option, the
<tt>s6-frontend-alias-sv</tt> program is built, and at installation
time, a <tt>sv</tt> symbolic link is created, pointing to it.
</p>

<p>
 <tt>s6-frontend-alias-sv</tt> implements most of the functionality of
<a href="http://smarden.org/runit/sv.8.html">sv</a>, as closely as
possible. When some functionality cannot be emulated on a s6
supervision tree, it prints an error message to stderr and exits 100.
</p>

<h2> Notes </h2>

<ul>
 <li> <tt>s6-frontend-alias-sv</tt> is a convenience program, written
so that runit users can keep using <tt>sv</tt> to control their
s6 services. However, it is not an "official" interface, because there
are a few fundamental differences between the conception of runit and
the conception of s6 that make <tt>sv</tt> a poor fit to accurately
interface with the advanced features of s6. It is recommended that
<tt>sv</tt> users become familiar with idiomatic s6 commands such as
<a href="//skarnet.org/software/s6/s6-svc.html">s6-svc</a>,
<a href="//skarnet.org/software/s6/s6-svstat.html">s6-svstat</a>, and
<a href="//skarnet.org/software/s6/s6-svwait.html">s6-svwait</a>. </li>
</ul>

</body>
</html>