2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (C) 2004 Andries Brouwer (aeb@cwi.nl)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2010-09-12 13:18:07 +00:00
|
|
|
.TH SIGPAUSE 3 2010-09-12 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
sigpause \- atomically release blocked signals and wait for interrupt
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <signal.h>
|
|
|
|
.sp
|
|
|
|
.BI "int sigpause(int " sigmask "); /* BSD */"
|
|
|
|
.sp
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.BI "int sigpause(int " sig "); /* System V / UNIX 95 */"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-04-12 22:42:49 +00:00
|
|
|
Don't use this function.
|
|
|
|
Use
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR sigsuspend (2)
|
|
|
|
instead.
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR sigpause ()
|
2004-11-03 13:51:07 +00:00
|
|
|
is designed to wait for some signal.
|
2005-11-29 15:13:21 +00:00
|
|
|
It changes the process's signal mask (set of blocked signals),
|
2004-11-03 13:51:07 +00:00
|
|
|
and then waits for a signal to arrive.
|
|
|
|
Upon arrival of a signal, the original signal mask is restored.
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
If
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR sigpause ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns, it was interrupted by a signal and the return value is \-1
|
|
|
|
with
|
|
|
|
.I errno
|
|
|
|
set to
|
|
|
|
.BR EINTR .
|
2007-06-16 08:02:06 +00:00
|
|
|
.SH CONFORMING TO
|
|
|
|
The System V version of
|
|
|
|
.BR sigpause ()
|
|
|
|
is standardized in POSIX.1-2001.
|
2007-05-18 11:59:14 +00:00
|
|
|
.SH NOTES
|
|
|
|
.SS History
|
2004-11-03 13:51:07 +00:00
|
|
|
The classical BSD version of this function appeared in 4.2BSD.
|
2005-11-29 15:13:21 +00:00
|
|
|
It sets the process's signal mask to
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR sigmask .
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
UNIX 95 standardized the incompatible System V version of
|
2006-06-03 01:26:30 +00:00
|
|
|
this function, which removes only the specified signal
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sig
|
2007-06-11 19:20:30 +00:00
|
|
|
from the process's signal mask.
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.\" __xpg_sigpause: UNIX 95, spec 1170, SVID, SVr4, XPG
|
2004-11-03 13:51:07 +00:00
|
|
|
The unfortunate situation with two incompatible functions with the
|
|
|
|
same name was solved by the
|
|
|
|
.BR \%sigsuspend (2)
|
|
|
|
function, that takes a
|
2005-11-29 15:13:21 +00:00
|
|
|
.I "sigset_t *"
|
2008-07-10 20:53:08 +00:00
|
|
|
argument (instead of an
|
2005-11-29 15:13:21 +00:00
|
|
|
.IR int ).
|
2007-05-27 16:10:33 +00:00
|
|
|
.SS Linux Notes
|
2004-11-03 13:51:07 +00:00
|
|
|
On Linux, this routine is a system call only on the Sparc (sparc64)
|
2007-04-12 22:42:49 +00:00
|
|
|
architecture.
|
2007-05-27 16:10:33 +00:00
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
Libc4 and libc5 only know about the BSD version.
|
2007-05-27 16:10:33 +00:00
|
|
|
|
2007-06-22 17:48:59 +00:00
|
|
|
Glibc uses the BSD version if the
|
|
|
|
.B _BSD_SOURCE
|
2007-06-22 19:42:52 +00:00
|
|
|
feature test macro is defined and none of
|
|
|
|
.BR _POSIX_SOURCE ,
|
|
|
|
.BR _POSIX_C_SOURCE ,
|
|
|
|
.BR _XOPEN_SOURCE ,
|
|
|
|
.BR _GNU_SOURCE ,
|
|
|
|
or
|
2007-06-22 17:42:06 +00:00
|
|
|
.B _SVID_SOURCE
|
|
|
|
is defined.
|
2010-09-12 13:18:07 +00:00
|
|
|
Otherwise, the System V version is used.
|
2007-06-21 22:55:04 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" For the BSD version, one usually uses a zero
|
|
|
|
.\" .I sigmask
|
|
|
|
.\" to indicate that no signals are to be blocked.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR kill (2),
|
|
|
|
.BR sigaction (2),
|
|
|
|
.BR sigprocmask (2),
|
|
|
|
.BR sigsuspend (2),
|
2005-11-29 15:01:54 +00:00
|
|
|
.BR sigblock (3),
|
2007-05-27 16:10:33 +00:00
|
|
|
.BR sigvec (3),
|
|
|
|
.BR feature_test_macros (7)
|