BSD 4_4 release

[unix-history] / usr / src / lib / libc / sys / sigsuspend.2

diff --git a/usr/src/lib/libc/sys/sigsuspend.2 b/usr/src/lib/libc/sys/sigsuspend.2
index 484c7d4..a234454 100644 (file)
--- a/usr/src/lib/libc/sys/sigsuspend.2
+++ b/usr/src/lib/libc/sys/sigsuspend.2
@@ -1,57 +1,80 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1983, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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 University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)sigsuspend.2        6.1 (Berkeley) 7/1/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.

 .\"
 .\"

-.TH SIGSUSPEND 2 "July 1, 1990"
-.UC 7
-.SH NAME
-sigsuspend \- atomically release blocked signals and wait for interrupt
-.SH SYNOPSIS
-.B #include <signal.h>
-.ft B
-sigsuspend(sigmask)
-.br
-sigset_t *sigmask;
-.ft R
-.SH DESCRIPTION
-.I Sigsuspend
+.\"    @(#)sigsuspend.2        8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt SIGSUSPEND 2
+.Os
+.Sh NAME
+.Nm sigsuspend
+.Nd atomically release blocked signals and wait for interrupt
+.Sh SYNOPSIS
+.Fd #include <signal.h>
+.Ft int
+.Fn sigsuspend "const sigset_t *sigmask"
+.Sh DESCRIPTION
+.Fn Sigsuspend

 temporarily changes the blocked signal mask to the set to which
 temporarily changes the blocked signal mask to the set to which

-.I sigmask
+.Fa sigmask

 points,
 and then waits for a signal to arrive;
 on return the previous set of masked signals is restored.
 The signal mask set
 is usually empty to indicate that all
 signals are to be unblocked for the duration of the call.
 points,
 and then waits for a signal to arrive;
 on return the previous set of masked signals is restored.
 The signal mask set
 is usually empty to indicate that all
 signals are to be unblocked for the duration of the call.

-The
-.I sigsuspend
-function
-always terminates by being interrupted, returning \-1 with
-.I errno
-set to EINTR.
-.PP
+.Pp

 In normal usage, a signal is blocked using
 In normal usage, a signal is blocked using

-.IR sigprocmask (2),
+.Xr sigprocmask 2

 to begin a critical section, variables modified on the occurrence
 of the signal are examined to determine that there is no work
 to be done, and the process pauses awaiting work by using
 to begin a critical section, variables modified on the occurrence
 of the signal are examined to determine that there is no work
 to be done, and the process pauses awaiting work by using

-.I sigsuspend
+.Fn sigsuspend

 with the previous mask returned by
 with the previous mask returned by

-.IR sigprocmask .
-.SH SEE ALSO
-sigprocmask(2), sigaction(2), sigsetops(3)
+.Xr sigprocmask .
+.Sh RETURN VALUES
+The
+.Fn sigsuspend
+function
+always terminates by being interrupted, returning -1 with
+.Va errno
+set to
+.Dv EINTR .
+.Sh SEE ALSO
+.Xr sigprocmask 2 ,
+.Xr sigaction 2 ,
+.Xr sigsetops 3
+.Sh STANDARDS
+The
+.Nm sigsupend
+function call
+conforms to
+.St -p1003.1-88 .