1.\" $NetBSD: pkill.1,v 1.15 2007/03/21 20:05:18 erh Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Andrew Doran. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd February 25, 2006 38.Dt PKILL 1 39.Os 40.Sh NAME 41.Nm pkill 42.Nd find or signal processes by name 43.Sh SYNOPSIS 44.Nm pgrep 45.Op Fl filnvx 46.Op Fl d Ar delim 47.Op Fl G Ar gid 48.Op Fl g Ar pgrp 49.Op Fl P Ar ppid 50.Op Fl s Ar sid 51.Op Fl t Ar tty 52.Op Fl U Ar uid 53.Op Fl u Ar euid 54.Op Ar pattern ... 55.Nm pkill 56.Op Fl signal 57.Op Fl finvx 58.Op Fl G Ar gid 59.Op Fl g Ar pgrp 60.Op Fl P Ar ppid 61.Op Fl s Ar sid 62.Op Fl t Ar tty 63.Op Fl U Ar uid 64.Op Fl u Ar euid 65.Op Ar pattern ... 66.Sh DESCRIPTION 67The 68.Nm pgrep 69command searches the process table on the running system and prints the 70process IDs of all processes that match the criteria given on the command 71line. 72.Pp 73The 74.Nm pkill 75command searches the process table on the running system and signals all 76processes that match the criteria given on the command line. 77.Pp 78The following options are available: 79.Bl -tag -width xxxxxxxx 80.It Fl d Ar delim 81Specify a delimiter to be printed between each process ID. 82The default is a newline. 83This option can only be used with the 84.Nm pgrep 85command. 86.It Fl f 87Match against full argument lists. 88The default is to match against process names. 89.It Fl G Ar gid 90Restrict matches to processes with a real group ID in the comma-separated 91list 92.Ar gid . 93.It Fl g Ar pgrp 94Restrict matches to processes with a process group ID in the comma-separated 95list 96.Ar pgrp . 97The value zero is taken to mean the process group ID of the running 98.Nm pgrep 99or 100.Nm pkill 101command. 102.It Fl i 103Ignore case distinctions in both the process table and the supplied pattern. 104.It Fl l 105Long output. 106Print the process name in addition to the process ID for each matching 107process. 108If used in conjunction with 109.Fl f , 110print the process ID and the full argument list for each matching process. 111.It Fl n 112Match only the most recently created process, if any. 113.It Fl P Ar ppid 114Restrict matches to processes with a parent process ID in the 115comma-separated list 116.Ar ppid . 117.It Fl s Ar sid 118Restrict matches to processes with a session ID in the comma-separated 119list 120.Ar sid . 121The value zero is taken to mean the session ID of the running 122.Nm pgrep 123or 124.Nm pkill 125command. 126.It Fl t Ar tty 127Restrict matches to processes associated with a terminal in the 128comma-separated list 129.Ar tty . 130Terminal names may be of the form 131.Sq ttyxx 132or the shortened form 133.Sq xx . 134A single dash 135.Pq Sq - 136matches processes not associated with a terminal. 137.It Fl U Ar uid 138Restrict matches to processes with a real user ID in the comma-separated 139list 140.Ar uid . 141.It Fl u Ar euid 142Restrict matches to processes with an effective user ID in the 143comma-separated list 144.Ar euid . 145.It Fl v 146Reverse the sense of the matching; display processes that do not match the 147given criteria. 148.It Fl x 149Require an exact match of the process name, or argument list if 150.Fl f 151is given. 152The default is to match any substring. 153.It Fl signal 154A non-negative decimal number or symbolic signal name specifying the signal 155to be sent instead of the default TERM. 156This option is valid only when given as the first argument to 157.Nm pkill . 158.El 159.Pp 160Note that a running 161.Nm pgrep 162or 163.Nm pkill 164process will never consider itself or system processes (kernel threads) as 165a potential match. 166.Sh EXIT STATUS 167.Nm pgrep 168and 169.Nm pkill 170return one of the following values upon exit: 171.Bl -tag -width foo 172.It 0 173One or more processes were matched. 174.It 1 175No processes were matched. 176.It 2 177Invalid options were specified on the command line. 178.It 3 179An internal error occurred. 180.El 181.Sh SEE ALSO 182.Xr grep 1 , 183.Xr kill 1 , 184.Xr ps 1 , 185.Xr kill 2 , 186.Xr sigaction 2 , 187.Xr re_format 7 , 188.Xr signal 7 189.Sh HISTORY 190.Nm pkill 191and 192.Nm pgrep 193first appeared in 194.Nx 1.6 . 195They are modelled after utilities of the same name that appeared in Sun 196Solaris 7. 197