Merge remote-tracking branch 'origin/vendor/OPENSSH'
[dragonfly.git] / lib / libc / sys / lwp_kill.2
1 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
2 .\"
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Simon 'corecode' Schubert <corecode@fs.ei.tum.de>
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\"
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in
14 .\"    the documentation and/or other materials provided with the
15 .\"    distribution.
16 .\" 3. Neither the name of The DragonFly Project nor the names of its
17 .\"    contributors may be used to endorse or promote products derived
18 .\"    from this software without specific, prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\" $DragonFly: src/lib/libc/sys/lwp_kill.2,v 1.2 2007/03/16 22:02:02 swildner Exp $
34 .\"
35 .Dd March 12, 2007
36 .Dt LWP_KILL 2
37 .Os
38 .Sh NAME
39 .Nm lwp_kill
40 .Nd send signal to a lwp
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In sys/types.h
45 .In sys/lwp.h
46 .In signal.h
47 .Ft int
48 .Fn lwp_kill "pid_t pid" "lwpid_t tid" "int sig"
49 .Sh DESCRIPTION
50 The
51 .Fn lwp_kill
52 function sends the signal
53 .Fa sig
54 to the lwp specified by
55 .Fa pid
56 and
57 .Fa tid .
58 If
59 .Fa pid
60 is -1, the signal will be sent to the current process.
61 Permission checking and signal behavior is exactly like in
62 .Xr kill 2 .
63 .Sh RETURN VALUES
64 .Rv -std
65 .Sh ERRORS
66 .Fn Lwp_kill
67 will fail and no signal will be sent if:
68 .Bl -tag -width Er
69 .It Bq Er EINVAL
70 .Fa sig
71 is not a valid signal number.
72 .It Bq Er ESRCH
73 no lwp corresponding to
74 .Fa pid
75 and
76 .Fa tid
77 can be found.
78 .It Bq Er EPERM
79 the sending process is not the super-user and its effective
80 user id does not match the effective user-id of the receiving process.
81 .El
82 .Sh SEE ALSO
83 .Xr kill 2 ,
84 .Xr lwp_create 2 ,
85 .Xr raise 3
86 .Sh HISTORY
87 The
88 .Fn lwp_kill
89 function first appeared in
90 .Dx 1.9 .