summaryrefslogtreecommitdiff
path: root/srcx/jkill.8
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2004-05-18 17:30:47 +0000
committerStef Walter <stef@memberwebs.com>2004-05-18 17:30:47 +0000
commit811897239f2f63dc4e4f67e81f3236e5aa1d870f (patch)
tree05833d178ac7bed7552c958b9e5789452616206d /srcx/jkill.8
parent6dd6bb17ea5bbfe539c1f8a87bf92286e0b15d1f (diff)
Some argument changes.
Documentation files.
Diffstat (limited to 'srcx/jkill.8')
-rw-r--r--srcx/jkill.873
1 files changed, 73 insertions, 0 deletions
diff --git a/srcx/jkill.8 b/srcx/jkill.8
new file mode 100644
index 0000000..bb4d5b8
--- /dev/null
+++ b/srcx/jkill.8
@@ -0,0 +1,73 @@
+.\" Process this file with
+.\" groff -mdoc -Tascii jkill.8
+.\"
+.Dd April, 2004
+.Dt jkill 8
+.Os jkill
+.Sh NAME
+.Nm jkill
+.Nd stop or restart a jail
+.Sh SYNOPSIS
+.Nm
+.Op Fl fkqv
+.Op Fl t Ar timeout
+.Ar jail ...
+.Nm
+.Fl r
+.Op Fl fqv
+.Op Fl t Ar timeout
+.Ar jail ...
+.Sh DESCRIPTION
+The
+.Nm
+utility stops one or more jails in an orderly fashion. It calls the
+shutdown scripts inside the jail and then kills all remaining processes.
+When used with the
+.Fl r
+option it can also restart the jail.
+.Pp
+.Sh OPTIONS
+.Bl -tag -width ".Fl u Ar timeout"
+.It Fl f
+Force the processes to quit. If processes remain after sending them
+a SIGTERM then kill them with SIGKILL which forces the a process exit.
+.It Fl k
+Don't call the shutdown scripts, just kill the processes.
+.It Fl q
+Supress warnings.
+.It Fl r
+After shutting down the jail, restart it by running the
+.Pa /etc/rc
+startup script.
+.It Fl t Ar timeout
+Specify a maximum timeout to wait after running the shutdown scripts and
+between the sending the various kill signals. The default is 3 seconds.
+.It Fl v
+Show the output of shutdown or startup scripts on the console. This also
+enables all warnings.
+.It Ar jail
+Either a jail id (which is an integer) or a jail host name.
+.El
+.Sh NOTES
+It's generally assumed that the jail in question is a 'full jail' with
+startup and shutdown scripts. If that's not the case use the
+.Fl k
+option.
+.Pp
+The startup and shutdown scripts inside the jail must be shell scripts
+and must be owned by root in order to be executed.
+.Pp
+The environment is purged properly before running the scripts in the
+jail in order to prevent unwanted information from leaking into the
+jail.
+.Sh FILES
+.Pa /etc/rc
+.Pa /etc/rc.shutdown
+.Sh SEE ALSO
+.Xr jail 8 ,
+.Xr jails 8 ,
+.Xr jls 8 ,
+.Xr jstart 8 ,
+.Xr kill 1
+.Sh AUTHOR
+.An Nate Nielsen Aq nielsen@memberwebs.com