for review: man3/posix_spawnattr_getsigdefault.3 (replaces 3p POSIX verbiage)

for review: man3/posix_spawnattr_getsigdefault.3 (replaces 3p POSIX verbiage)

[bill o gallmeister]

.\" Copyright (c) 2009 Bill O. Gallmeister (bgallmeister-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org)
.\"
.\" 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.
.\"
.\" 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.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" References consulted:
.\"     Linux glibc source code
.\"     POSIX 1003.1-2004 documentation (http://www.opengroup.org/onlinepubs/009695399)
.\"
.TH "POSIX_SPAWNATTR_GETSIGDEFAULT" 3 2009-09-22 "GNU" "Linux Programmer's Manual"
.\" posix_spawnattr_getsigdefault, posix_spawnattr_setsigdefault
.SH NAME
posix_spawnattr_getsigdefault, posix_spawnattr_setsigdefault \- get/set spawn signal defaults attribute
.SH SYNOPSIS
.nf
.B #include <spawn.h>

.BI "int posix_spawnattr_getsigdefault(const posix_spawnattr_t *" attrp ,
.BI "       sigset_t *" sigmask);

.BI "int posix_spawnattr_setsigdefault(posix_spawnattr_t *" attrp ,
.BI "       const sigset_t *" sigmask);

.fi
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.ad l
.BR posix_spawnattr_getsigdefault ()
and
.BR posix_spawnattr_setsigdefault ():
(_POSIX_C_SOURCE\ >=\ 200112L)\ &&\ (_POSIX_SPAWN)
.ad b

.SH DESCRIPTION
.BR Posix_spawn ()
and
.BR posix_spawnp ()
are used to create a new child process from the specified
process image.  Think of these functions as a combined
.BR fork ()/ exec ().
As part of calling these functions, the programmer can specify actions to be taken in the newly-created
child process by passing a pointer to an appropriately-initialized
.B posix_spawnattr_t
structure.
.LP
One of these actions is the setting of a set of signals to their default actions.
The signal mask in the spawned child process is set as follows:
.IP 1 2
First, the signal actions are set as if the child had just been created by
.BR fork ()
(which is, in fact, the case).
.IP 2 2
Then, if
.B POSIX_SPAWN_SETSIGDEF
is set in the
.I posix_spawnattr_t ,
all signals which are set in the
.I spawn-sigdefault
element will be set to their default handlers.
The
.I spawn-sigdefault
element in the
.I posix_spawnattr_t
structure is set by calling
.BR posix_spawnattr_setsigdefault ().
The programmer passes a signal mask, constructed with
.BR sigemptyset (),
.BR sigaddset (),
and so forth, to the function.
.LP
To retrieve the value of the
.I spawn-sigdefault
element in the
.I posix_spawnattr_t
structure,
use
.BR posix_spawnattr_getsigdefault ().
.SH RETURN VALUE
.LP
.BR posix_spawnattr_setsigdefault ()
and
.BR posix_spawnattr_setsigdefault ()
always return 0 on Linux/Glibc systems.
.SH ERRORS
.LP
.BR posix_spawnattr_setsigdefault ()
and
.BR posix_spawnattr_setsigdefault ()
return no errors on Linux/Glibc systems, other than the possible error
for a system where
.I posix_spawn*
are not supported:
.TP
.B ENOSYS
This function is not supported on this system.
.SH NOTES
POSIX does not specify the names of any internal elements within the
.I posix_spawnattr_t
structure;  in fact, it does not specify that it is a structure at all.
Portable programs should refrain from directly referencing fields within this
structure.  In these man pages we refer to the internal parts of the
.I posix_spawnattr_t
as elements.
.SH CONFORMING TO
.LP
POSIX.1-2004.
.SH SEE ALSO
.LP
.BR close (2),
.BR dup2 (2),
.BR execl (2),
.BR execlp (2),
.BR fork (2),
.BR open (2),
.BR pthread_atfork (3),
.BR sched_setparam (2),
.BR sched_setscheduler (2),
.BR setpgid (2),
.BR setuid (2),
.BR sigaction (2),
.BR sigprocask (2),
.BR posix_spawnattr_destroy (3),
.BR posix_spawnattr_getflags (3),
.BR posix_spawnattr_getpgroup (3),
.BR posix_spawnattr_getschedparam (3),
.BR posix_spawnattr_getschedpolicy (3),
.BR posix_spawnattr_init (3),
.BR posix_spawnattr_setflags (3),
.BR posix_spawnattr_setpgroup (3),
.BR posix_spawnattr_setschedparam (3),
.BR posix_spawnattr_setschedpolicy (3),
.BR posix_spawn_file_actions_addclose (3),
.BR posix_spawn_file_actions_adddup2 (3),
.BR posix_spawn_file_actions_addopen (3),
.BR posix_spawn_file_actions_destroy (3),
.BR posix_spawn_file_actions_init (3),
.BR sigaddset (3),
.BR sigemptyset (3),
.BR sigfillset (3),
.BR posixoptions (7),
.BR <spawn.h>,
Base Definitions volume of POSIX.1-2004,
.I http://www.opengroup.org/unix/online.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html