xref: /dragonfly/usr.bin/killall/killall.1 (revision 631c21f2)
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.\"
25.\" $FreeBSD: src/usr.bin/killall/killall.1,v 1.11.2.11 2003/02/25 20:31:18 trhodes Exp $
26.\"
27.Dd March 12, 2021
28.Dt KILLALL 1
29.Os
30.Sh NAME
31.Nm killall
32.Nd kill processes by name
33.Sh SYNOPSIS
34.Nm
35.Op Fl d | v
36.Op Fl q
37.Op Fl h | ?\& | help
38.Op Fl l
39.Op Fl m
40.Op Fl s
41.Op Fl T
42.Op Fl u Ar user
43.Op Fl t Ar tty
44.Op Fl c Ar procname
45.Op Fl j Ar jail
46.Op Fl SIGNAL
47.Op Ar procname ...
48.Sh DESCRIPTION
49The
50.Nm
51utility kills processes selected by name, as opposed to the selection by pid
52as done by
53.Xr kill 1 .
54By default, it will send a
55.Dv TERM
56signal to all processes with a real UID identical to the
57caller of
58.Nm
59that match the name
60.Ar procname .
61The super-user is allowed to kill any process.
62.Pp
63The options are as follows:
64.Bl -tag -width 10n -offset indent
65.It Fl q
66Do not print an error message if no matching processes are found.
67.It Fl d | v
68Be more verbose about what will be done.  For a single
69.Fl d
70option, a list of the processes that will be sent the signal will be
71printed, or a message indicating that no matching processes have been
72found.
73.It Fl h | ?\& | help
74Give a help on the command usage and exit.
75.It Fl l
76List the names of the available signals and exit, like in
77.Xr kill 1 .
78.It Fl m
79Match the argument
80.Ar procname
81as a (case insensitive) regular expression against the names
82of processes found.
83CAUTION!  This is dangerous, a single dot will match any process
84running under the real UID of the caller.
85.It Fl s
86Show only what would be done, but do not send any signal.
87.It Fl SIGNAL
88Send a different signal instead of the default
89.Dv TERM .
90The signal may be specified either as a name
91(with or without a leading
92.Dv SIG ) ,
93or numerically.
94.It Fl u Ar user
95Limit potentially matching processes to those belonging to
96the specified
97.Ar user .
98.It Fl t Ar tty
99Limit potentially matching processes to those running on
100the specified
101.Ar tty .
102.It Fl T
103Kill all processes on the current tty except ourselves or
104processes which parent us.
105.It Fl j Ar jailid
106Limit potentially matching processes to those running in the jail with id
107.Ar jailid .
108.It Fl c Ar procname
109When used with the
110.Fl u
111or
112.Fl t
113flags, limit potentially matching processes to those matching
114the specified
115.Ar procname .
116.El
117.Sh ALL PROCESSES
118Sending a signal to all processes with uid
119.Em XYZ
120is already supported by
121.Xr kill 1 .
122So use
123.Xr kill 1
124for this job (e.g. $ kill -TERM -1 or
125as root $ echo kill -TERM -1 | su -m <user>)
126.Sh DIAGNOSTICS
127The
128.Nm
129command will respond with a short usage message and exit with a status
130of 2 in case of a command error.  A status of 1 will be returned if
131either no matching process has been found or not all processes have
132been signalled successfully.  Otherwise, a status of 0 will be
133returned.
134.Pp
135Diagnostic messages will only be printed if requested by
136.Fl d
137options.
138.Sh SEE ALSO
139.Xr kill 1 ,
140.Xr pkill 1 ,
141.Xr sysctl 3
142.Sh HISTORY
143The
144.Nm
145command appeared in
146.Fx 2.1 .
147It has been modeled after the
148.Nm
149command as available on other platforms.
150.Sh AUTHORS
151.An -nosplit
152The
153.Nm
154program was originally written in Perl and was contributed by
155.An Wolfram Schneider ,
156this manual page has been written by
157.An J\(:org Wunsch .
158The current version of
159.Nm
160was rewritten in C by
161.An Peter Wemm
162using
163.Xr sysctl 3 .
164