1.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. 2.\" 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(s), this list of conditions and the following disclaimer as 9.\" the first lines of this file unmodified other than the possible 10.\" addition of one or more copyright notices. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice(s), this list of conditions and the following disclaimer in 13.\" the documentation and/or other materials provided with the 14.\" distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE 20.\" 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 23.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 24.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 25.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 26.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27.\" 28.\" $FreeBSD: src/lib/libc_r/man/sigwait.3,v 1.2.2.6 2001/12/17 10:08:26 ru Exp $ 29.Dd July 20, 2016 30.Dt SIGWAIT 3 31.Os 32.Sh NAME 33.Nm sigwait 34.Nd select a set of signals 35.Sh LIBRARY 36.Lb libpthread 37.Sh SYNOPSIS 38.In signal.h 39.Ft int 40.Fn sigwait "const sigset_t * restrict set" "int * restrict sig" 41.Sh DESCRIPTION 42The 43.Fn sigwait 44function selects a set of signals, specified by 45.Fa set . 46If none of the selected signals are pending, 47.Fn sigwait 48waits until one or more of the selected signals has been generated. 49Then 50.Fn sigwait 51atomically clears one of the selected signals from the set of pending signals 52(for the process or for the current thread) and sets the location pointed to by 53.Fa sig 54to the signal number that was cleared. 55.Pp 56The signals specified by 57.Fa set 58should be blocked at the time of the call to 59.Fn sigwait . 60.Sh RETURN VALUES 61If successful, 62.Fn sigwait 63returns 0 and sets the location pointed to by 64.Fa sig 65to the cleared signal number. 66Otherwise, an error number is returned. 67.Sh ERRORS 68The 69.Fn sigwait 70function will fail if: 71.Bl -tag -width Er 72.It Bq Er EINVAL 73The 74.Fa set 75argument specifies one or more invalid signal numbers. 76.El 77.Sh SEE ALSO 78.Xr sigaction 2 , 79.Xr sigpending 2 , 80.Xr sigsuspend 2 , 81.Xr pause 3 , 82.Xr pthread_sigmask 3 83.Sh STANDARDS 84The 85.Fn sigwait 86function conforms to 87.St -p1003.1-96 . 88