[apple/shell_cmds.git] / killall / killall.1

.\" Copyright (C) 1995 by Joerg Wunsch, Dresden
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``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 AUTHOR(S) 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.
.\"
.\" $FreeBSD: src/usr.bin/killall/killall.1,v 1.34 2005/01/17 07:44:20 ru Exp $
.\"
.Dd January 26, 2004
.Os
.Dt KILLALL 1
.Sh NAME
.Nm killall
.Nd kill processes by name
.Sh SYNOPSIS
.Nm
.Op Fl delmsvz
.Op Fl help
.Op Fl u Ar user
.Op Fl t Ar tty
.Op Fl c Ar procname
.Op Fl SIGNAL
.Op Ar procname ...
.Sh DESCRIPTION
The
.Nm
utility kills processes selected by name, as opposed to the selection by pid
as done by
.Xr kill 1 .
By default, it will send a
.Dv TERM
signal to all processes with a real UID identical to the
caller of
.Nm
that match the name
.Ar procname .
The super-user is allowed to kill any process.
.Pp
The options are as follows:
.Bl -tag -width 10n -offset indent
.It Fl v
Be more verbose about what will be done.
.It Fl e
Use the effective user ID instead of the (default) real user ID for matching
processes specified with the
.Fl u
option.
.It Fl help
Give a help on the command usage and exit.
.It Fl l
List the names of the available signals and exit, like in
.Xr kill 1 .
.It Fl m
Match the argument
.Ar procname
as a (case sensitive) regular expression against the names
of processes found.
CAUTION!
This is dangerous, a single dot will match any process
running under the real UID of the caller.
.It Fl s
Show only what would be done, but do not send any signal.
.It Fl d
Print detailed information about the processes matched,
but do not send any signal.
.It Fl SIGNAL
Send a different signal instead of the default
.Dv TERM .
The signal may be specified either as a name
(with or without a leading
.Dv SIG ) ,
or numerically.
.It Fl u Ar user
Limit potentially matching processes to those belonging to
the specified
.Ar user .
.It Fl t Ar tty
Limit potentially matching processes to those running on
the specified
.Ar tty .
.It Fl c Ar procname
When used with the
.Fl u
or
.Fl t
flags, limit potentially matching processes to those matching
the specified
.Ar procname .
.It Fl z
Do not skip zombies.
This should not have any effect except to print a few error messages
if there are zombie processes that match the specified pattern.
.El
.Sh ALL PROCESSES
Sending a signal to all processes with uid
.Em XYZ
is already supported by
.Xr kill 1 .
So use
.Xr kill 1
for this job (e.g.\& $ kill -TERM -1 or
as root $ echo kill -TERM -1 | su -m <user>)
.Sh EXIT STATUS
The
.Nm
command will respond with a short usage message and exit with a status
of 2 in case of a command error.
A status of 1 will be returned if
either no matching process has been found or not all processes have
been signalled successfully.
Otherwise, a status of 0 will be
returned.
.Sh DIAGNOSTICS
Diagnostic messages will only be printed if requested by
.Fl d
options.
.Sh SEE ALSO
.Xr kill 1 ,
.Xr sysctl 3
.Sh HISTORY
The
.Nm
command appeared in
.Fx 2.1 .
It has been modeled after the
.Nm
command as available on other platforms.
.Sh AUTHORS
.An -nosplit
The
.Nm
program was originally written in Perl and was contributed by
.An Wolfram Schneider ,
this manual page has been written by
.An J\(:org Wunsch .
The current version of
.Nm
was rewritten in C by
.An Peter Wemm
using
.Xr sysctl 3 .
Commit	Line	Data
c0fcf4e1 A	1	.\" Copyright (C) 1995 by Joerg Wunsch, Dresden
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\"
	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
	14	.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	15	.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	16	.\" DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
	17	.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	18	.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
	19	.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	20	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	21	.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	22	.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	23	.\" POSSIBILITY OF SUCH DAMAGE.
	24	.\"
e1a085ba	25	.\" $FreeBSD: src/usr.bin/killall/killall.1,v 1.34 2005/01/17 07:44:20 ru Exp $
c0fcf4e1	26	.\"
e1a085ba	27	.Dd January 26, 2004
c0fcf4e1 A	28	.Os
	29	.Dt KILLALL 1
	30	.Sh NAME
	31	.Nm killall
	32	.Nd kill processes by name
	33	.Sh SYNOPSIS
	34	.Nm
e1a085ba	35	.Op Fl delmsvz
c0fcf4e1	36	.Op Fl help
c0fcf4e1 A	37	.Op Fl u Ar user
	38	.Op Fl t Ar tty
	39	.Op Fl c Ar procname
	40	.Op Fl SIGNAL
	41	.Op Ar procname ...
	42	.Sh DESCRIPTION
e1a085ba A	43	The
	44	.Nm
	45	utility kills processes selected by name, as opposed to the selection by pid
c0fcf4e1 A	46	as done by
	47	.Xr kill 1 .
	48	By default, it will send a
	49	.Dv TERM
	50	signal to all processes with a real UID identical to the
	51	caller of
	52	.Nm
	53	that match the name
	54	.Ar procname .
	55	The super-user is allowed to kill any process.
	56	.Pp
	57	The options are as follows:
	58	.Bl -tag -width 10n -offset indent
06a885f3	59	.It Fl v
e1a085ba	60	Be more verbose about what will be done.
e1a085ba A	61	.It Fl e
	62	Use the effective user ID instead of the (default) real user ID for matching
	63	processes specified with the
	64	.Fl u
	65	option.
c0fcf4e1 A	66	.It Fl help
	67	Give a help on the command usage and exit.
	68	.It Fl l
	69	List the names of the available signals and exit, like in
	70	.Xr kill 1 .
	71	.It Fl m
	72	Match the argument
	73	.Ar procname
e1a085ba	74	as a (case sensitive) regular expression against the names
c0fcf4e1	75	of processes found.
e1a085ba A	76	CAUTION!
e1a085ba A	77	This is dangerous, a single dot will match any process
c0fcf4e1 A	78	running under the real UID of the caller.
	79	.It Fl s
	80	Show only what would be done, but do not send any signal.
06a885f3 A	81	.It Fl d
	82	Print detailed information about the processes matched,
	83	but do not send any signal.
c0fcf4e1 A	84	.It Fl SIGNAL
	85	Send a different signal instead of the default
	86	.Dv TERM .
	87	The signal may be specified either as a name
	88	(with or without a leading
	89	.Dv SIG ) ,
	90	or numerically.
	91	.It Fl u Ar user
	92	Limit potentially matching processes to those belonging to
	93	the specified
	94	.Ar user .
	95	.It Fl t Ar tty
	96	Limit potentially matching processes to those running on
	97	the specified
	98	.Ar tty .
	99	.It Fl c Ar procname
	100	When used with the
	101	.Fl u
	102	or
	103	.Fl t
	104	flags, limit potentially matching processes to those matching
	105	the specified
e1a085ba A	106	.Ar procname .
	107	.It Fl z
	108	Do not skip zombies.
	109	This should not have any effect except to print a few error messages
	110	if there are zombie processes that match the specified pattern.
c0fcf4e1 A	111	.El
	112	.Sh ALL PROCESSES
	113	Sending a signal to all processes with uid
e1a085ba	114	.Em XYZ
c0fcf4e1 A	115	is already supported by
	116	.Xr kill 1 .
	117	So use
	118	.Xr kill 1
e1a085ba	119	for this job (e.g.\& $ kill -TERM -1 or
c0fcf4e1	120	as root $ echo kill -TERM -1 \| su -m <user>)
e1a085ba	121	.Sh EXIT STATUS
c0fcf4e1 A	122	The
	123	.Nm
	124	command will respond with a short usage message and exit with a status
e1a085ba A	125	of 2 in case of a command error.
e1a085ba A	126	A status of 1 will be returned if
c0fcf4e1	127	either no matching process has been found or not all processes have
e1a085ba A	128	been signalled successfully.
e1a085ba A	129	Otherwise, a status of 0 will be
c0fcf4e1	130	returned.
e1a085ba	131	.Sh DIAGNOSTICS
c0fcf4e1 A	132	Diagnostic messages will only be printed if requested by
	133	.Fl d
	134	options.
	135	.Sh SEE ALSO
	136	.Xr kill 1 ,
	137	.Xr sysctl 3
	138	.Sh HISTORY
	139	The
	140	.Nm
	141	command appeared in
	142	.Fx 2.1 .
	143	It has been modeled after the
	144	.Nm
	145	command as available on other platforms.
	146	.Sh AUTHORS
	147	.An -nosplit
	148	The
	149	.Nm
	150	program was originally written in Perl and was contributed by
	151	.An Wolfram Schneider ,
	152	this manual page has been written by
	153	.An J\(:org Wunsch .
	154	The current version of
	155	.Nm
	156	was rewritten in C by
	157	.An Peter Wemm
	158	using
	159	.Xr sysctl 3 .