$FreeBSD: head/usr.bin/pkill/pkill.1 127427 2004-03-25 23:19:16Z gad $
Copyright (c) 2002 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Andrew Doran.
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.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the NetBSD
Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``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 FOUNDATION OR CONTRIBUTORS
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.
.Dd March 25, 2004 .Dt PKILL 1 .Os .Sh NAME .Nm pkill .Nd find or signal processes by name .Sh SYNOPSIS .Nm pgrep .Op Fl flnvx .Op Fl G Ar gid .Op Fl M Ar core .Op Fl N Ar system .Op Fl P Ar ppid .Op Fl U Ar uid .Op Fl d Ar delim .Op Fl g Ar pgrp .Op Fl s Ar sid .Op Fl t Ar tty .Op Fl u Ar euid .Op Ar pattern Op ... .Nm pkill .Op Fl signal .Op Fl fnvx .Op Fl G Ar gid .Op Fl M Ar core .Op Fl N Ar system .Op Fl P Ar ppid .Op Fl U Ar uid .Op Fl g Ar pgrp .Op Fl s Ar sid .Op Fl t Ar tty .Op Fl u Ar euid .Op Ar pattern Op ... .Sh DESCRIPTION The .Nm pgrep command searches the process table on the running system and prints the process IDs of all processes that match the criteria given on the command line.
p The .Nm pkill command searches the process table on the running system and signals all processes that match the criteria given on the command line.
p The following options are available: l -tag -width xxxxxxxx t Fl G Ar gid Restrict matches to processes with a real group ID in the comma-separated list .Ar gid . t Fl P Ar ppid Restrict matches to processes with a parent process ID in the comma-separated list .Ar ppid . t Fl M Extract values associated with the name list from the specified core instead of the default
a /dev/kmem . t Fl N Extract the name list from the specified system instead of the default
a /kernel . t Fl U Ar uid Restrict matches to processes with a real user ID in the comma-separated list .Ar uid . t Fl d Ar delim Specify a delimiter to be printed between each process ID. The default is a newline. This option can only be used with the .Nm pgrep command. t Fl f Match against full argument lists. The default is to match against process names. t Fl g Ar pgrp Restrict matches to processes with a process group ID in the comma-separated list .Ar pgrp . The value zero is taken to mean the process group ID of the running .Nm pgrep or .Nm pkill command. t Fl l Long output. Print the process name in addition to the process ID for each matching process. If used in conjunction with .Fl f , print the process ID and the full argument list for each matching process. This option can only be used with the .Nm pgrep command. t Fl n Match only the most recently created process, if any. t Fl s Ar sid Restrict matches to processes with a session ID in the comma-separated list .Ar sid . The value zero is taken to mean the session ID of the running .Nm pgrep or .Nm pkill command. t Fl t Ar tty Restrict matches to processes associated with a terminal in the comma-separated list .Ar tty . Terminal names may be of the form .Sq ttyxx or the shortened form .Sq xx . A single dash (`-') matches processes not associated with a terminal. t Fl u Ar euid Restrict matches to processes with an effective user ID in the comma-separated list .Ar euid . t Fl v Reverse the sense of the matching; display processes that do not match the given criteria. t Fl x Require an exact match of the process name, or argument list if .Fl f is given. The default is to match any substring. t Fl signal A non-negative decimal number or symbolic signal name specifying the signal to be sent instead of the default TERM. This option is valid only when given as the first argument to .Nm pkill . .El
p Note that a running .Nm pgrep or .Nm pkill process will never consider itself nor system processes (kernel threads) as a potential match. .Sh EXIT STATUS .Nm pgrep and .Nm pkill return one of the following values upon exit: l -tag -width foo t 0 One or more processes were matched. t 1 No processes were matched. t 2 Invalid options were specified on the command line. t 3 An internal error occurred. .El .Sh SEE ALSO .Xr kill 1 , .Xr ps 1 , .Xr kill 2 , .Xr sigaction 2 , .Xr re_format 7 , .Xr signal 7 .Sh HISTORY .Nm pkill and .Nm pgrep first appeared in .Nx 1.6 . They are modelled after utilities of the same name that appeared in Sun Solaris 7. .Sh AUTHORS .An Andrew Doran .Aq ad@NetBSD.org .