summaryrefslogtreecommitdiff
path: root/src/killjail.8
blob: 11d6e0c840412f976a8b15b75afdd66f68649e0a (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
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
.\" 
.\" Copyright (c) 2004, Nate Nielsen
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without 
.\" modification, are permitted provided that the following conditions 
.\" are met:
.\" 
.\"     * Redistributions of source code must retain the above 
.\"       copyright notice, this list of conditions and the 
.\"       following disclaimer.
.\"     * Redistributions in binary form must reproduce the 
.\"       above copyright notice, this list of conditions and 
.\"       the following disclaimer in the documentation and/or 
.\"       other materials provided with the distribution.
.\"     * The names of contributors to this software may not be 
.\"       used to endorse or promote products derived from this 
.\"       software without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
.\" DAMAGE.
.\" 
.\"
.\" CONTRIBUTORS
.\"  Nate Nielsen <nielsen@memberwebs.com>
.\"
.\" Process this file with
.\" groff -man -Tascii killjail.8
.\"
.TH KILLJAIL 8 "May 2002" FreeBSD "User Manual"
.SH NAME
.B killjail 
\- stop or restart a jail
.SH SYNOPSIS
.B killjail 
[ 
.B -h 
| 
.B -r 
] [ 
.B -t 
.I timeout
] [ 
.B -fq 
]
.I jailname ...
.SH DESCRIPTION
.B killjail
can either send signals to a 
.BR jailer (8)
process to manage the shutdown or restart of a jail or it can kill all 
the processes in a jail on it's own.

When no options are given the jail is shutdown as follows: 
.IP 1. 3
A stop request (SIGTERM) is sent to the 
.BR jailer (8)
process for the jail if there is one. This initiates an orderly shutdown. 
.IP 2. 3
Any remaining processes are killed with a SIGTERM.
.IP 3. 3
If the 
.B -f 
option is specified, send a SIGKILL to any remaining processes.

.SH OPTIONS
.IP -f
Force jail to shutdown sending a SIGKILL as a last resort.
.IP -h 
Sends a halt request to a jail (SIGQUIT). The jail must have a 
.BR jailer (8) 
process running inside it. The 
.BR jailer (8) 
process remains running within the jail, but all other jailed 
processes are shutdown in and orderly fashion.
.IP -q
Supress warnings.
.IP -r
Sends a restart request to a jail (SIGHUP). The jail must have a 
.BR jailer (8)
process running inside it. 
.IP "-t timeout"
The timeout in seconds to wait between steps 1, 2 and 3 above. Defaults to 3.

.SH BUGS
I'm sure they're out there. Let me know.

.SH AUTHOR
Nate Nielsen <nielsen@memberwebs.com>

.SH "SEE ALSO"
.BR jail (8),
.BR jailer (8),
.BR kill (1)