summary refs log tree commit diff
path: root/man/runsvctrl.8
blob: 7e6258300642dc61638aea14964f52da307300d0 (plain) (blame)
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
.TH runsvctrl 8
.SH NAME
runsvctrl \- controls a service monitored by
.BR runsv (8).
.SH SYNOPSIS
.B runsvctrl
.I command
.I services
.SH DESCRIPTION
.I services
consists of one or more arguments, each argument naming a directory used by
.BR runsv (8).
.I command
is one of up, down, once, pause, cont, hup, alarm, interrupt, 1, 2, term,
kill, or exit.
.P
For each
.I service
of
.IR services ,
.B runsvctrl
sends the command
.I command
to the
.IR service ,
which must be controlled by
.BR runsv (8).
.SH COMMANDS
.TP
.B up
If the service is not running, start it. If the service stops, restart it.
.TP
.B down
If the service is running, send it a TERM signal. If ./run exits,
start ./finish if it exists. After it stops, do not restart service.
.TP
.B once
If the service is not running, start it. Do not restart it if it stops.
.TP
.B pause
If the service is running, send it a STOP signal.
.TP
.B cont
If the service is running, send it a CONT signal.
.TP
.B hup
If the service is running, send it a HUP signal.
.TP
.B alarm
If the service is running, send it a ALRM signal.
.TP
.B interrupt
If the service is running, send it a INT signal.
.TP
.B 1
User-defined 1. If the service is running, send it a USR1 signal.
.TP
.B 2
User-defined 2. If the service is running, send it a USR2 signal.
.TP
.B term
If the service is running, send it a TERM signal.
.TP
.B kill
If the service is running, send it a KILL signal.
.TP
.B exit
If the service is running, send it a TERM signal. Do not restart the
service. If the service is down, and no log service exists,
.BR runsv (8)
exits. If the service is down and a log service exists, send a TERM signal
to the log service. If the log service is down,
.BR runsv (8)
exits. This command is ignored if it is given to
.IR service /log/supervise/control.
.P
.BR runsvctrl
actually looks only at the first character of
.IR command .
.SH EXIT CODES
.B runsvctrl
exits 0, if the
.I command
was sent successfully to all
.IR services .
.P
For each
.I service
that caused an error (e.g. the directory is not controlled by a
.BR runsv (8)
process),
.B runsvctrl
increases the exit code by one and exits non zero. The maximum is 100.
.P
.B runsvctrl
exits 111 on error.
.SH SEE ALSO
runsvstat(8),
runit(8),
runit-init(8),
runsvdir(8),
runsv(8),
svwaitdown(8),
svwaitup(8)
.P
 http://smarden.org/runit/
.SH AUTHOR
Gerrit Pape <pape@smarden.org>