1.\" $NetBSD: pthread_kill.3,v 1.6 2003/10/30 12:57:11 wiz Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. Neither the name of The NetBSD Foundation nor the names of its 14.\" contributors may be used to endorse or promote products derived 15.\" from this software without specific prior written permission. 16.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26.\" POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. 29.\" All rights reserved. 30.\" 31.\" Redistribution and use in source and binary forms, with or without 32.\" modification, are permitted provided that the following conditions 33.\" are met: 34.\" 1. Redistributions of source code must retain the above copyright 35.\" notice(s), this list of conditions and the following disclaimer as 36.\" the first lines of this file unmodified other than the possible 37.\" addition of one or more copyright notices. 38.\" 2. Redistributions in binary form must reproduce the above copyright 39.\" notice(s), this list of conditions and the following disclaimer in 40.\" the documentation and/or other materials provided with the 41.\" distribution. 42.\" 43.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 44.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 45.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 46.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE 47.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 48.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 49.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 50.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 51.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 52.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 53.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 54.\" 55.\" $FreeBSD: src/lib/libpthread/man/pthread_kill.3,v 1.9 2002/09/16 19:29:28 mini Exp $ 56.Dd October 30, 2003 57.Dt PTHREAD_KILL 3 58.Os 59.Sh NAME 60.Nm pthread_kill 61.Nd send a signal to a specified thread 62.Sh LIBRARY 63.Lb libpthread 64.Sh SYNOPSIS 65.In pthread.h 66.In signal.h 67.Ft int 68.Fn pthread_kill "pthread_t thread" "int sig" 69.Sh DESCRIPTION 70The 71.Fn pthread_kill 72function sends a signal, specified by 73.Fa sig , 74to a thread, specified by 75.Fa thread . 76The signal will be handled in the context of 77.Fa thread , 78but the signal action may alter the process as a whole. 79If 80.Fa sig 81is 0, error checking is performed, but no signal is actually sent. 82.Sh RETURN VALUES 83If successful, 84.Fn pthread_kill 85returns 0. 86Otherwise, an error number is returned. 87.Sh ERRORS 88.Fn pthread_kill 89shall fail if: 90.Bl -tag -width Er 91.It Bq Er ESRCH 92.Fa thread 93is an invalid thread ID. 94.It Bq Er EINVAL 95.Fa sig 96is an invalid or unsupported signal number. 97.El 98.Sh SEE ALSO 99.Xr kill 2 , 100.Xr sigwait 2 , 101.Xr pthread_self 3 , 102.Xr raise 3 103.Sh STANDARDS 104.Fn pthread_kill 105conforms to 106.St -p1003.1-96 . 107