1.\" $NetBSD: pkill.1,v 1.10 2005/03/16 15:05:25 wiz 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 March 16, 2005 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 G Ar gid 47.Op Fl P Ar ppid 48.Op Fl U Ar uid 49.Op Fl d Ar delim 50.Op Fl g Ar pgrp 51.Op Fl s Ar sid 52.Op Fl t Ar tty 53.Op Fl u Ar euid 54.Op Ar pattern Op ... 55.Nm pkill 56.Op Fl signal 57.Op Fl finvx 58.Op Fl G Ar gid 59.Op Fl P Ar ppid 60.Op Fl U Ar uid 61.Op Fl g Ar pgrp 62.Op Fl s Ar sid 63.Op Fl t Ar tty 64.Op Fl u Ar euid 65.Op Ar pattern Op ... 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 G Ar gid 81Restrict matches to processes with a real group ID in the comma-separated 82list 83.Ar gid . 84.It Fl P Ar ppid 85Restrict matches to processes with a parent process ID in the 86comma-separated list 87.Ar ppid . 88.It Fl U Ar uid 89Restrict matches to processes with a real user ID in the comma-separated 90list 91.Ar uid . 92.It Fl d Ar delim 93Specify a delimiter to be printed between each process ID. 94The default is a newline. 95This option can only be used with the 96.Nm pgrep 97command. 98.It Fl f 99Match against full argument lists. 100The default is to match against process names. 101.It Fl g Ar pgrp 102Restrict matches to processes with a process group ID in the comma-separated 103list 104.Ar pgrp . 105The value zero is taken to mean the process group ID of the running 106.Nm pgrep 107or 108.Nm pkill 109command. 110.It Fl i 111Ignore case distinctions in both the process table and the supplied pattern. 112.It Fl l 113Long output. 114Print the process name in addition to the process ID for each matching 115process. 116If used in conjunction with 117.Fl f , 118print the process ID and the full argument list for each matching process. 119This option can only be used with the 120.Nm pgrep 121command. 122.It Fl n 123Match only the most recently created process, if any. 124.It Fl s Ar sid 125Restrict matches to processes with a session ID in the comma-separated 126list 127.Ar sid . 128The value zero is taken to mean the session ID of the running 129.Nm pgrep 130or 131.Nm pkill 132command. 133.It Fl t Ar tty 134Restrict matches to processes associated with a terminal in the 135comma-separated list 136.Ar tty . 137Terminal names may be of the form 138.Sq ttyxx 139or the shortened form 140.Sq xx . 141A single dash (`-') matches processes not associated with a terminal. 142.It Fl u Ar euid 143Restrict matches to processes with an effective user ID in the 144comma-separated list 145.Ar euid . 146.It Fl v 147Reverse the sense of the matching; display processes that do not match the 148given criteria. 149.It Fl x 150Require an exact match of the process name, or argument list if 151.Fl f 152is given. 153The default is to match any substring. 154.It Fl signal 155A non-negative decimal number or symbolic signal name specifying the signal 156to be sent instead of the default TERM. 157This option is valid only when given as the first argument to 158.Nm pkill . 159.El 160.Pp 161Note that a running 162.Nm pgrep 163or 164.Nm pkill 165process will never consider itself nor system processes (kernel threads) as 166a potential match. 167.Sh EXIT STATUS 168.Nm pgrep 169and 170.Nm pkill 171return one of the following values upon exit: 172.Bl -tag -width foo 173.It 0 174One or more processes were matched. 175.It 1 176No processes were matched. 177.It 2 178Invalid options were specified on the command line. 179.It 3 180An internal error occurred. 181.El 182.Sh SEE ALSO 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.Sh AUTHORS 198.An Andrew Doran 199.Aq ad@NetBSD.org . 200