Add posix_spawn() and posix_spawnp().
[dragonfly.git] / lib / libc / gen / posix_spawnattr_getschedpolicy.3
1 .\" Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" Portions of this text are reprinted and reproduced in electronic form
26 .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27 .\" Portable Operating System Interface (POSIX), The Open Group Base
28 .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29 .\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30 .\" event of any discrepancy between this version and the original IEEE and
31 .\" The Open Group Standard, the original IEEE and The Open Group Standard is
32 .\" the referee document.  The original Standard can be obtained online at
33 .\"     http://www.opengroup.org/unix/online.html.
34 .\"
35 .\" $FreeBSD: src/lib/libc/gen/posix_spawnattr_getschedpolicy.3,v 1.1 2008/07/28 02:22:19 davidxu Exp $
36 .\"
37 .Dd Mar 24, 2008
38 .Dt POSIX_SPAWNATTR_GETSCHEDPOLICY 3
39 .Os
40 .Sh NAME
41 .Nm posix_spawnattr_getschedpolicy ,
42 .Nm posix_spawnattr_setschedpolicy
43 .Nd "get and set the spawn-schedpolicy attribute of a spawn attributes object"
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In spawn.h
48 .Ft int
49 .Fn posix_spawnattr_getschedpolicy "const posix_spawnattr_t *restrict attr" "int *restrict schedpolicy"
50 .Ft int
51 .Fn posix_spawnattr_setschedpolicy "posix_spawnattr_t *attr" "int schedpolicy"
52 .Sh DESCRIPTION
53 The
54 .Fn posix_spawnattr_getschedpolicy
55 function obtains the value of the spawn-schedpolicy attribute from the
56 attributes object referenced by
57 .Fa attr .
58 .Pp
59 The
60 .Fn posix_spawnattr_setschedpolicy
61 function sets the spawn-schedpolicy attribute in an initialized attributes
62 object referenced by
63 .Fa attr .
64 .Pp
65 The spawn-schedpolicy attribute represents the scheduling policy to
66 be assigned to the new process image in a spawn operation (if
67 .Dv POSIX_SPAWN_SETSCHEDULER
68 is set in the spawn-flags attribute).
69 The default value of this attribute is unspecified.
70 .Sh RETURN VALUES
71 The
72 .Fn posix_spawnattr_getschedpolicy
73 and
74 .Fn posix_spawnattr_setschedpolicy
75 functions return zero.
76 .Sh SEE ALSO
77 .Xr posix_spawn 3 ,
78 .Xr posix_spawnattr_destroy 3 ,
79 .Xr posix_spawnattr_getschedparam 3 ,
80 .Xr posix_spawnattr_init 3 ,
81 .Xr posix_spawnattr_setschedparam 3 ,
82 .Xr posix_spawnp 3
83 .Sh STANDARDS
84 The
85 .Fn posix_spawnattr_getschedpolicy
86 and
87 .Fn posix_spawnattr_setschedpolicy
88 functions conform to
89 .St -p1003.1-2001 .
90 .Sh HISTORY
91 The
92 .Fn posix_spawnattr_getschedpolicy
93 and
94 .Fn posix_spawnattr_setschedpolicy
95 functions first appeared in
96 .Fx 8.0 .
97 .Sh AUTHORS
98 .An Ed Schouten Aq ed@FreeBSD.org