Annotation of src/usr.bin/pkill/pkill.1, Revision 1.22
1.22 ! jmc 1: .\" $OpenBSD: pkill.1,v 1.21 2013/06/03 04:17:37 tedu Exp $
1.1 millert 2: .\" $NetBSD: pkill.1,v 1.8 2003/02/14 15:59:18 grant Exp $
3: .\"
4: .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
5: .\" All rights reserved.
6: .\"
7: .\" This code is derived from software contributed to The NetBSD Foundation
8: .\" by Andrew Doran.
9: .\"
10: .\" Redistribution and use in source and binary forms, with or without
11: .\" modification, are permitted provided that the following conditions
12: .\" are met:
13: .\" 1. Redistributions of source code must retain the above copyright
14: .\" notice, this list of conditions and the following disclaimer.
15: .\" 2. Redistributions in binary form must reproduce the above copyright
16: .\" notice, this list of conditions and the following disclaimer in the
17: .\" documentation and/or other materials provided with the distribution.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29: .\" POSSIBILITY OF SUCH DAMAGE.
30: .\"
1.22 ! jmc 31: .Dd $Mdocdate: June 3 2013 $
1.1 millert 32: .Dt PKILL 1
33: .Os
34: .Sh NAME
1.3 jmc 35: .Nm pgrep , pkill
1.1 millert 36: .Nd find or signal processes by name
37: .Sh SYNOPSIS
38: .Nm pgrep
1.19 espie 39: .Op Fl flnoqvx
1.6 jmc 40: .Op Fl d Ar delim
1.1 millert 41: .Op Fl G Ar gid
1.6 jmc 42: .Op Fl g Ar pgrp
1.1 millert 43: .Op Fl P Ar ppid
44: .Op Fl s Ar sid
1.18 markus 45: .Op Fl T Ar rtable
1.1 millert 46: .Op Fl t Ar tty
1.6 jmc 47: .Op Fl U Ar uid
1.1 millert 48: .Op Fl u Ar euid
1.6 jmc 49: .Op Ar pattern ...
1.1 millert 50: .Nm pkill
1.9 jmc 51: .Op Fl Ar signal
1.21 tedu 52: .Op Fl fIlnoqvx
1.1 millert 53: .Op Fl G Ar gid
1.6 jmc 54: .Op Fl g Ar pgrp
1.1 millert 55: .Op Fl P Ar ppid
56: .Op Fl s Ar sid
1.18 markus 57: .Op Fl T Ar rtable
1.1 millert 58: .Op Fl t Ar tty
1.6 jmc 59: .Op Fl U Ar uid
1.1 millert 60: .Op Fl u Ar euid
1.6 jmc 61: .Op Ar pattern ...
1.1 millert 62: .Sh DESCRIPTION
63: The
64: .Nm pgrep
65: command searches the process table on the running system and prints the
66: process IDs of all processes that match the criteria given on the command
67: line.
68: .Pp
69: The
70: .Nm pkill
71: command searches the process table on the running system and signals all
72: processes that match the criteria given on the command line.
73: .Pp
74: The following options are available:
1.7 jmc 75: .Bl -tag -width Ds
1.1 millert 76: .It Fl d Ar delim
77: Specify a delimiter to be printed between each process ID.
78: The default is a newline.
79: This option can only be used with the
80: .Nm pgrep
81: command.
82: .It Fl f
83: Match against full argument lists.
84: The default is to match against process names.
1.6 jmc 85: .It Fl G Ar gid
86: Restrict matches to processes with a real group ID in the comma-separated
87: list
88: .Ar gid .
1.1 millert 89: .It Fl g Ar pgrp
90: Restrict matches to processes with a process group ID in the comma-separated
91: list
92: .Ar pgrp .
93: The value zero is taken to mean the process group ID of the running
94: .Nm pgrep
95: or
96: .Nm pkill
97: command.
1.22 ! jmc 98: .It Fl I
! 99: Ask for confirmation before killing a process.
1.1 millert 100: .It Fl l
101: Long output.
102: Print the process name in addition to the process ID for each matching
103: process.
104: If used in conjunction with
105: .Fl f ,
1.17 lum 106: print the process ID and the full argument list for each matching process
107: .Pf ( Nm pgrep
108: only).
1.1 millert 109: .It Fl n
1.10 millert 110: Match only the most recently created (newest) process, if any.
1.13 sobrado 111: Cannot be used in conjunction with
1.10 millert 112: .Fl o .
113: .It Fl o
114: Match only the least recently created (oldest) process, if any.
1.13 sobrado 115: Cannot be used in conjunction with
1.10 millert 116: .Fl n .
1.6 jmc 117: .It Fl P Ar ppid
118: Restrict matches to processes with a parent process ID in the
119: comma-separated list
120: .Ar ppid .
1.20 ajacouto 121: .It Fl q
122: Quiet mode.
123: Perform the action, but don't display anything on standard output.
124: Note that
125: .Fl q
126: takes precedence over other display options such as
127: .Fl l .
1.1 millert 128: .It Fl s Ar sid
129: Restrict matches to processes with a session ID in the comma-separated
130: list
131: .Ar sid .
132: The value zero is taken to mean the session ID of the running
133: .Nm pgrep
134: or
135: .Nm pkill
136: command.
1.18 markus 137: .It Fl T Ar rtable
138: Restrict matches to processes associated with the specified routing tables
139: in the comma-separated list
140: .Ar rtable .
1.1 millert 141: .It Fl t Ar tty
142: Restrict matches to processes associated with a terminal in the
143: comma-separated list
144: .Ar tty .
145: Terminal names may be of the form
146: .Sq ttyxx
147: or the shortened form
148: .Sq xx .
1.7 jmc 149: A single dash
150: .Pq Sq -
151: matches processes not associated with a terminal.
1.6 jmc 152: .It Fl U Ar uid
153: Restrict matches to processes with a real user ID in the comma-separated
154: list
155: .Ar uid .
1.1 millert 156: .It Fl u Ar euid
157: Restrict matches to processes with an effective user ID in the
158: comma-separated list
159: .Ar euid .
160: .It Fl v
1.14 jmc 161: Reverse the sense of the matching;
162: display or signal processes that do not match the given criteria.
1.1 millert 163: .It Fl x
164: Require an exact match of the process name, or argument list if
165: .Fl f
166: is given.
167: The default is to match any substring.
1.9 jmc 168: .It Fl Ar signal
1.1 millert 169: A non-negative decimal number or symbolic signal name specifying the signal
170: to be sent instead of the default TERM.
171: This option is valid only when given as the first argument to
172: .Nm pkill .
173: .El
1.15 jmc 174: .Pp
175: If any
176: .Ar pattern
177: operands are specified, they are used as
178: regular expressions to match the command name
179: or, if
180: .Fl f
181: is specified, the full argument list of each process.
182: However, presently
183: .Ox
184: will only keep track of the first 16 characters of the command name
185: for each process.
186: Attempts to match any characters after the first 16 of a
187: command name will silently fail.
1.1 millert 188: .Pp
189: Note that a running
190: .Nm pgrep
191: or
192: .Nm pkill
1.7 jmc 193: process will never consider itself or system processes (kernel threads) as
1.1 millert 194: a potential match.
1.16 jmc 195: .Sh EXIT STATUS
196: The
1.1 millert 197: .Nm pgrep
198: and
199: .Nm pkill
1.16 jmc 200: utilities exit with one of the following values:
1.7 jmc 201: .Pp
202: .Bl -tag -width Ds -offset indent -compact
1.1 millert 203: .It 0
204: One or more processes were matched.
205: .It 1
206: No processes were matched.
207: .It 2
208: Invalid options were specified on the command line.
209: .It 3
210: An internal error occurred.
211: .El
212: .Sh SEE ALSO
1.7 jmc 213: .Xr grep 1 ,
1.1 millert 214: .Xr kill 1 ,
215: .Xr ps 1 ,
216: .Xr kill 2 ,
217: .Xr sigaction 2 ,
1.2 millert 218: .Xr re_format 7
1.1 millert 219: .Sh HISTORY
220: .Nm pkill
221: and
222: .Nm pgrep
223: first appeared in
224: .Ox 3.5 .
225: They are modelled after utilities of the same name that appeared in Sun
226: Solaris 7.
227: .Sh AUTHORS
228: .An Andrew Doran
229: .Aq ad@NetBSD.org .
![[BACK]](/icons/back.gif){kind=icon}
Return to pkill.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / pkill