NetBSD/lib/libc/gen/sigset.3

.\"	$NetBSD: sigset.3,v 1.2 2003/01/16 00:33:12 wiz Exp $
.\"
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Klaus Klein.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd January 16, 2003
.Dt SIGSET 3
.Os
.Sh NAME
.Nm sigset
.Nd manipulate signal dispositions
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.Fd #include \*[Lt]signal.h\*[Gt]
.\" The following is Quite Ugly, but syntactically correct.  Don't try to
.\" fix it.
.Ft void \*(lp*
.Fn sigset "int sig" "void \*(lp*disp\*(rp\*(lpint\*(rp\*(rp\*(rp\*(lpint"
.Sh DESCRIPTION
.Bf -symbolic
This interface is made obsolete by
.Xr sigaction 2
and
.Xr sigprocmask 2 .
.Ef
.Pp
The
.Fn sigset
function manipulates the disposition of the signal
.Fa sig .
The new disposition is given in
.Fa disp .
.Pp
If
.Fa disp
is one of
.Dv SIG_DFL ,
.Dv SIG_IGN ,
or the address of a handler function,
the disposition of
.Fa sig
is changed accordingly, and
.Fa sig
is removed from the process' signal mask.
Also, if
.Fa disp
is the address of a handler function,
.Fa sig
will be added to the process' signal mask during execution of the handler.
.Pp
If
.Fa disp
is equal to
.Dv SIG_HOLD ,
.Fa sig
is added to the calling process' signal mask and the disposition of
.Fa sig
remains unchanged.
.Sh RETURN VALUES
If successful, the
.Fn sigset
function returns
.Dv SIG_HOLD
if
.Fa sig
had been blocked,
and the previous disposition of
.Fa sig
if it had not been blocked.
Otherwise
.Dv SIG_ERR
is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
The
.Fn sigignore
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The argument
.Fa sig
is not a valid signal number.
.It Bq Er EINVAL
An attempt is made to ignore a signal that cannot be ignored,
such as
.Dv SIGKILL
or
.Dv SIGSTOP .
.El
.Sh SEE ALSO
.Xr sigaction 2 ,
.Xr sigprocmask 2
.Sh STANDARDS
The
.Fn sigignore
function conforms to
.St -p1003.1-2001 .