Annotation of src/lib/libc/gen/posix_spawnattr_getflags.3, Revision 1.4
1.4 ! riastrad 1: .\" $NetBSD: posix_spawnattr_getflags.3,v 1.2.6.1 2013/07/23 21:07:29 riastradh Exp $
1.1 martin 2: .\"
3: .\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
4: .\" All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
14: .\"
15: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25: .\" SUCH DAMAGE.
26: .\"
27: .\" Portions of this text are reprinted and reproduced in electronic form
28: .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
29: .\" Portable Operating System Interface (POSIX), The Open Group Base
30: .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
31: .\" Electrical and Electronics Engineers, Inc and The Open Group. In the
32: .\" event of any discrepancy between this version and the original IEEE and
33: .\" The Open Group Standard, the original IEEE and The Open Group Standard is
34: .\" the referee document. The original Standard can be obtained online at
35: .\" http://www.opengroup.org/unix/online.html.
36: .\"
37: .\" $FreeBSD: src/lib/libc/gen/posix_spawnattr_getflags.3,v 1.1.2.1.4.1 2010/06/14 02:09:06 kensmith Exp $
38: .\"
39: .Dd December 20, 2011
40: .Dt POSIX_SPAWNATTR_GETFLAGS 3
41: .Os
42: .Sh NAME
43: .Nm posix_spawnattr_getflags ,
44: .Nm posix_spawnattr_setflags
45: .Nd "get and set the spawn-flags attribute of a spawn attributes object"
46: .Sh LIBRARY
47: .Lb libc
48: .Sh SYNOPSIS
49: .In spawn.h
50: .Ft int
51: .Fn posix_spawnattr_getflags "const posix_spawnattr_t *restrict attr" "short *restrict flags"
52: .Ft int
53: .Fn posix_spawnattr_setflags "posix_spawnattr_t *attr" "short flags"
54: .Sh DESCRIPTION
55: The
56: .Fn posix_spawnattr_getflags
57: function obtains the value of the spawn-flags attribute from the
58: attributes object referenced by
59: .Fa attr .
60: .Pp
61: The
62: .Fn posix_spawnattr_setflags
63: function sets the spawn-flags attribute in an initialized
64: attributes object referenced by
65: .Fa attr .
66: .Pp
67: The spawn-flags attribute is used to indicate which process attributes
68: are to be changed in the new process image when invoking
69: .Fn posix_spawn
70: or
71: .Fn posix_spawnp .
72: It is the bitwise-inclusive OR of zero or more of the following flags
73: (see
74: .Fn posix_spawn ) :
75: .Bl -tag -offset indent
76: .It Dv POSIX_SPAWN_RESETIDS
77: .It Dv POSIX_SPAWN_SETPGROUP
78: .It Dv POSIX_SPAWN_SETSIGDEF
79: .It Dv POSIX_SPAWN_SETSIGMASK
80: .It Dv POSIX_SPAWN_SETSCHEDPARAM
81: .It Dv POSIX_SPAWN_SETSCHEDULER
82: .El
83: .Pp
84: These flags are defined in
85: .In spawn.h .
86: The default value of this attribute is as if no flags were set.
87: .Sh RETURN VALUES
88: The
89: .Fn posix_spawnattr_getflags
90: and
91: .Fn posix_spawnattr_setflags
92: functions return zero.
93: .Sh SEE ALSO
94: .Xr posix_spawn 3 ,
95: .Xr posix_spawnattr_destroy 3 ,
96: .Xr posix_spawnattr_init 3 ,
97: .Xr posix_spawnp 3
98: .Sh STANDARDS
99: The
100: .Fn posix_spawnattr_getflags
101: and
102: .Fn posix_spawnattr_setflags
103: functions conform to
104: .St -p1003.1-2001 .
105: .Sh HISTORY
106: The
107: .Fn posix_spawnattr_getflags
108: and
109: .Fn posix_spawnattr_setflags
110: functions first appeared in
111: .Fx 8.0
112: and imported for
1.2 njoly 113: .Nx 6.0 .
1.1 martin 114: .Sh AUTHORS
1.3 wiz 115: .An Ed Schouten Aq Mt ed@FreeBSD.org
CVSweb <webmaster@jp.NetBSD.org>