6394ea2b1a3ce7ecec2993be8ea331447d826859
[games.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 signal.h
46 .Ft int
47 .Fn lwp_kill "pid_t pid" "lwpid_t tid" "int sig"
48 .Sh DESCRIPTION
49 The
50 .Fn lwp_kill
51 function sends the signal
52 .Fa sig
53 to the lwp specified by
54 .Fa pid
55 and
56 .Fa tid .
57 If
58 .Fa pid
59 is -1, the signal will be sent to the current process.
60 Permission checking and signal behavior is exactly like in
61 .Xr kill 2 .
62 .Sh RETURN VALUES
63 .Rv -std
64 .Sh ERRORS
65 .Fn Lwp_kill
66 will fail and no signal will be sent if:
67 .Bl -tag -width Er
68 .It Bq Er EINVAL
69 .Fa sig
70 is not a valid signal number.
71 .It Bq Er ESRCH
72 no lwp corresponding to
73 .Fa pid
74 and
75 .Fa tid
76 can be found.
77 .It Bq Er EPERM
78 the sending process is not the super-user and its effective
79 user id does not match the effective user-id of the receiving process.
80 .El
81 .Sh SEE ALSO
82 .Xr kill 2 ,
83 .Xr lwp_create 2 ,
84 .Xr raise 3 ,
85 .Sh HISTORY
86 The
87 .Fn lwp_kill
88 function first appeared in
89 .Dx 1.9 .