lib/libc/gen/posix_spawnattr_getpgroup.3

   1 .\" $NetBSD: posix_spawnattr_getpgroup.3,v 1.3 2013/07/20 21:39:57 wiz Exp $
   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_getpgroup.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_GETPGROUP 3
  41 .Os
  42 .Sh NAME
  43 .Nm posix_spawnattr_getpgroup ,
  44 .Nm posix_spawnattr_setpgroup
  45 .Nd "get and set the spawn-pgroup 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_getpgroup "const posix_spawnattr_t *restrict attr" "pid_t *restrict pgroup"
  52 .Ft int
  53 .Fn posix_spawnattr_setpgroup "posix_spawnattr_t *attr" "pid_t pgroup"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn posix_spawnattr_getpgroup
  57 function obtains the value of the spawn-pgroup attribute from the
  58 attributes object referenced by
  59 .Fa attr .
  60 .Pp
  61 The
  62 .Fn posix_spawnattr_setpgroup
  63 function sets the spawn-pgroup attribute in an initialized
  64 attributes object referenced by
  65 .Fa attr .
  66 .Pp
  67 The spawn-pgroup attribute represents the process group to be joined by
  68 the new process image in a spawn operation (if
  69 .Dv POSIX_SPAWN_SETPGROUP
  70 is set in the spawn-flags attribute).
  71 The default value of this attribute is zero.
  72 .Sh RETURN VALUES
  73 The
  74 .Fn posix_spawnattr_getpgroup
  75 and
  76 .Fn posix_spawnattr_setpgroup
  77 functions return zero.
  78 .Sh SEE ALSO
  79 .Xr posix_spawn 3 ,
  80 .Xr posix_spawnattr_destroy 3 ,
  81 .Xr posix_spawnattr_init 3 ,
  82 .Xr posix_spawnp 3
  83 .Sh STANDARDS
  84 The
  85 .Fn posix_spawnattr_getpgroup
  86 and
  87 .Fn posix_spawnattr_setpgroup
  88 functions conform to
  89 .St -p1003.1-2001 .
  90 .Sh HISTORY
  91 The
  92 .Fn posix_spawnattr_getpgroup
  93 and
  94 .Fn posix_spawnattr_setpgroup
  95 functions first appeared in
  96 .Fx 8.0
  97 and imported for
  98 .Nx 6.0 .
  99 .Sh AUTHORS
 100 .An Ed Schouten Aq Mt ed@FreeBSD.org