Merge branch 'vendor/OPENPAM'
[dragonfly.git] / lib / libc / sys / kill.2
1 .\" Copyright (c) 1980, 1991, 1993
2 .\"     The Regents of the University of California.  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 .\" 3. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)kill.2      8.3 (Berkeley) 4/19/94
29 .\" $FreeBSD: src/lib/libc/sys/kill.2,v 1.10.2.7 2001/12/14 18:34:01 ru Exp $
30 .\"
31 .Dd November 26, 2016
32 .Dt KILL 2
33 .Os
34 .Sh NAME
35 .Nm kill
36 .Nd send signal to a process
37 .Sh LIBRARY
38 .Lb libc
39 .Sh SYNOPSIS
40 .In sys/types.h
41 .In signal.h
42 .Ft int
43 .Fn kill "pid_t pid" "int sig"
44 .Sh DESCRIPTION
45 The
46 .Fn kill
47 function sends the signal given by
48 .Fa sig
49 to
50 .Fa pid ,
51 a
52 process or a group of processes.
53 .Fa Sig
54 may be one of the signals specified in
55 .Xr sigaction 2
56 or it may be 0, in which case
57 error checking is performed but no
58 signal is actually sent.
59 This can be used to check the validity of
60 .Fa pid .
61 .Pp
62 For a process to have permission to send a signal to a process designated
63 by
64 .Fa pid ,
65 the real or effective user ID of the receiving process must match
66 that of the sending process or the user must have appropriate privileges
67 (such as given by a set-user-ID program or the user is the super-user).
68 A single exception is the signal
69 .Dv SIGCONT ,
70 which may always be sent to any descendant of the current process.
71 .Bl -tag -width Ds
72 .It \&If Fa pid No \&is greater than zero :
73 .Fa Sig
74 is sent to the process whose ID is equal to
75 .Fa pid .
76 .It \&If Fa pid No \&is zero :
77 .Fa Sig
78 is sent to all processes whose group ID is equal
79 to the process group ID of the sender, and for which the
80 process has permission;
81 this is a variant of
82 .Xr killpg 3 .
83 .It \&If Fa pid No \&is -1 :
84 If the user has super-user privileges,
85 the signal is sent to all processes excluding
86 system processes
87 (with
88 .Dv P_SYSTEM
89 flag set),
90 process with ID 1
91 (usually
92 .Xr init 8 ) ,
93 and the process sending the signal.
94 If the user is not the super user, the signal is sent to all processes
95 with the same uid as the user excluding the process sending the signal.
96 No error is returned if any process could be signaled.
97 .El
98 .Pp
99 NOTE! If the sending process is restricted by a reaper, the signal is
100 further restricted to processes only within or under that reaper.
101 The reaper itself can only be signalled directly.
102 .Pp
103 For compatibility with System V,
104 if the process number is negative but not -1,
105 the signal is sent to all processes whose process group ID
106 is equal to the absolute value of the process number.
107 This is a variant of
108 .Xr killpg 3 .
109 .Sh RETURN VALUES
110 .Rv -std kill
111 .Sh ERRORS
112 .Fn Kill
113 will fail and no signal will be sent if:
114 .Bl -tag -width Er
115 .It Bq Er EINVAL
116 .Fa Sig
117 is not a valid signal number.
118 .It Bq Er ESRCH
119 No process can be found corresponding to that specified by
120 .Fa pid .
121 .It Bq Er ESRCH
122 The process id was given as 0
123 but the sending process does not have a process group.
124 .It Bq Er EPERM
125 The sending process is not the super-user and its effective
126 user id does not match the effective user-id of the receiving process.
127 When signaling a process group, this error is returned if any members
128 of the group could not be signaled.
129 .El
130 .Sh SEE ALSO
131 .Xr getpgrp 2 ,
132 .Xr getpid 2 ,
133 .Xr lwp_kill 2 ,
134 .Xr sigaction 2 ,
135 .Xr killpg 3 ,
136 .Xr raise 3 ,
137 .Xr init 8
138 .Sh STANDARDS
139 The
140 .Fn kill
141 function call is expected to conform to
142 .St -p1003.1-90 .
143 .Sh HISTORY
144 A
145 .Fn kill
146 function call appeared in
147 .At v7 .