lib/libc/gen/posix_spawnattr_getflags.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_getflags.3,v 1.1 2008/07/28 02:22:19 davidxu Exp $
  36 .\"
  37 .Dd April 7, 2009
  38 .Dt POSIX_SPAWNATTR_GETFLAGS 3
  39 .Os
  40 .Sh NAME
  41 .Nm posix_spawnattr_getflags ,
  42 .Nm posix_spawnattr_setflags
  43 .Nd "get and set the spawn-flags 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_getflags "const posix_spawnattr_t *restrict attr" "short *restrict flags"
  50 .Ft int
  51 .Fn posix_spawnattr_setflags "posix_spawnattr_t *attr" "short flags"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn posix_spawnattr_getflags
  55 function obtains the value of the spawn-flags attribute from the
  56 attributes object referenced by
  57 .Fa attr .
  58 .Pp
  59 The
  60 .Fn posix_spawnattr_setflags
  61 function sets the spawn-flags attribute in an initialized
  62 attributes object referenced by
  63 .Fa attr .
  64 .Pp
  65 The spawn-flags attribute is used to indicate which process attributes
  66 are to be changed in the new process image when invoking
  67 .Fn posix_spawn
  68 or
  69 .Fn posix_spawnp .
  70 It is the bitwise-inclusive OR of zero or more of the following flags
  71 (see
  72 .Fn posix_spawn ) :
  73 .Bl -tag -offset indent
  74 .It Dv POSIX_SPAWN_RESETIDS
  75 .It Dv POSIX_SPAWN_SETPGROUP
  76 .It Dv POSIX_SPAWN_SETSIGDEF
  77 .It Dv POSIX_SPAWN_SETSIGMASK
  78 .It Dv POSIX_SPAWN_SETSCHEDPARAM
  79 .It Dv POSIX_SPAWN_SETSCHEDULER
  80 .El
  81 .Pp
  82 These flags are defined in
  83 .In spawn.h .
  84 The default value of this attribute is as if no flags were set.
  85 .Sh RETURN VALUES
  86 The
  87 .Fn posix_spawnattr_getflags
  88 and
  89 .Fn posix_spawnattr_setflags
  90 functions return zero.
  91 .Sh SEE ALSO
  92 .Xr posix_spawn 3 ,
  93 .Xr posix_spawnattr_destroy 3 ,
  94 .Xr posix_spawnattr_init 3 ,
  95 .Xr posix_spawnp 3
  96 .Sh STANDARDS
  97 The
  98 .Fn posix_spawnattr_getflags
  99 and
 100 .Fn posix_spawnattr_setflags
 101 functions conform to
 102 .St -p1003.1-2001 .
 103 .Sh HISTORY
 104 The
 105 .Fn posix_spawnattr_getflags
 106 and
 107 .Fn posix_spawnattr_setflags
 108 functions first appeared in
 109 .Fx 8.0 .
 110 .Sh AUTHORS
 111 .An Ed Schouten Aq ed@FreeBSD.org