flag fields are u_int's
[unix-history] / usr / src / lib / libc / sys / kill.2
index ea4f9e1..49541f6 100644 (file)
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.\"    @(#)kill.2      6.3 (Berkeley) %G%
+.\" %sccs.include.redist.man%
 .\"
 .\"
-.TH KILL 2 ""
-.UC 4
-.SH NAME
-kill \- send signal to a process
-.SH SYNOPSIS
-.ft B
-kill(pid, sig)
-.br
-int pid, sig;
-.SH DESCRIPTION
-.I Kill
-sends the signal \fIsig\fP
-to a process, specified by the process number
-.IR pid .
-.I Sig
+.\"     @(#)kill.2     6.6 (Berkeley) %G%
+.\"
+.Dd 
+.Dt KILL 2
+.Os BSD 4
+.Sh NAME
+.Nm kill
+.Nd send signal to a process
+.Sh SYNOPSIS
+.Fd #include <sys/signal.h>
+.Ft int
+.Fn kill "pid_t pid" "int sig"
+.Sh DESCRIPTION
+The
+.Fn kill
+function sends the signal given by
+.Fa sig
+to
+.Fa pid ,
+a
+process or a group of processes.
+.Fa Sig
 may be one of the signals specified in
 may be one of the signals specified in
-.IR sigvec (2),
+.Xr sigaction 2
 or it may be 0, in which case
 error checking is performed but no
 signal is actually sent. 
 This can be used to check the validity of
 or it may be 0, in which case
 error checking is performed but no
 signal is actually sent. 
 This can be used to check the validity of
-.IR pid .
-.PP
-The sending and receiving processes must
-have the same effective user ID, otherwise
-this call is restricted to the super-user.
+.Fa pid .
+.Pp
+For a process to have permission to send a signal to a process designated
+by
+.Fa pid ,
+the real or effective user ID of the receving process must match
+that of the sending process or the user must have appropriate privileges
+(such as given by a set-user-ID program or the user is the super-user).
 A single exception is the signal SIGCONT, which may always be sent
 A single exception is the signal SIGCONT, which may always be sent
-to any child or grandchild of the current process.
-.PP
-If the process number is 0,
-the signal is sent to all other processes in the
-sender's process group; this is a variant of
-.IR killpg (2).
-.PP
-If the process number is \-1,
-and the user is the super-user,
-the signal is broadcast universally
-except to system processes
-and the process sending the signal.
-If the process number is \-1,
-and the user is not the super-user,
-the signal is broadcast universally to
-all processes with the same uid as the user
+to any descendant of the current process.
+.Bl -tag -width Ds
+.It \&If Fa pid No \&is greater than zero :
+.Fa Sig
+is sent to the process whose ID is equal to
+.Fa pid.
+.It \&If Fa pid No \&is zero :
+.Fa Sig
+is sent to all processes whose group ID is equal
+to the process group ID of the sender, and for which the
+process has permission;
+this is a variant of
+.Xr killpg 2 .
+.It \&If Fa pid No \&is -1 :
+If the user has super user privileges,
+the signal is sent to all processes excluding
+system processes. If the user is not the super user,
+the signal is sent to all processes with the same uid as the user
 except the process sending the signal.
 except the process sending the signal.
-.PP
+No error is returned if any process could be signaled.
+.El
+.Pp
 For compatibility with System V,
 For compatibility with System V,
-a negative process number that is not -1,
-is sent to all processes whose process group ID
+if the process number is negative but not -1,
+the signal is sent to all processes whose process group ID
 is equal to the absolute value of the process number.
 This is a variant of
 is equal to the absolute value of the process number.
 This is a variant of
-.IR killpg (2).
-.PP
-Processes may send signals to themselves.
-.SH "RETURN VALUE
+.Xr killpg 2 .
+.Sh RETURN VALUES
 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.
-Otherwise, a value of \-1 is returned and
-.I errno
+Otherwise, a value of -1 is returned and
+.Va errno
 is set to indicate the error.
 is set to indicate the error.
-.SH "ERRORS
-.I Kill
-will fail and no signal will be sent if any of the following
-occur:
-.TP 15
-[EINVAL]
-\fISig\fP is not a valid signal number.
-.TP 15
-[ESRCH]
-No process can be found corresponding to that specified by \fIpid\fP.
-.TP 15
-[EPERM]
+.Sh ERRORS
+.Fn Kill
+will fail and no signal will be sent if:
+.Bl -tag -width [EINVAL]
+.It Bq Er EINVAL
+.Fa Sig
+is not a valid signal number.
+.It Bq Er ESRCH
+No process can be found corresponding to that specified by
+.Fa pid .
+.It Bq Er ESRCH
+The process id was given as 0
+but the sending process does not have a process group.
+.It Bq Er EPERM
 The sending process is not the super-user and its effective
 user id does not match the effective user-id of the receiving process.
 The sending process is not the super-user and its effective
 user id does not match the effective user-id of the receiving process.
-.SH "SEE ALSO"
-getpid(2), getpgrp(2), killpg(2), sigvec(2)
+When signaling a process group, this error is returned if any members
+of the group could not be signaled.
+.El
+.Sh SEE ALSO
+.Xr getpid 2 ,
+.Xr getpgrp 2 ,
+.Xr killpg 2 ,
+.Xr sigaction 2
+.Sh STANDARDS
+The
+.Fn kill
+function is expected to
+conform to IEEE Std 1003.1-1988
+.Pq Dq Tn POSIX .