lib/libc/sys/setpgid.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)setpgid.2   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/setpgid.2,v 1.5.2.7 2001/12/14 18:34:01 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/setpgid.2,v 1.4 2007/09/05 08:23:43 hasso Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt SETPGID 2
  38 .Os
  39 .Sh NAME
  40 .Nm setpgid ,
  41 .Nm setpgrp
  42 .Nd set process group
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn setpgid "pid_t pid" "pid_t pgrp"
  49 .Ft int
  50 .Fn setpgrp "pid_t pid" "pid_t pgrp"
  51 .Sh DESCRIPTION
  52 .Fn Setpgid
  53 sets the process group of the specified process
  54 .Fa pid
  55 to the specified
  56 .Fa pgrp .
  57 If
  58 .Fa pid
  59 is zero, then the call applies to the current process.
  60 If
  61 .Ar pgrp
  62 is zero, then the process id of the process specified by
  63 .Ar pid
  64 is used instead.
  65 .Pp
  66 If the invoker is not the super-user, then the affected process
  67 must have the same effective user-id as the invoker or be a descendant
  68 of the invoking process.
  69 .Sh RETURN VALUES
  70 .Rv -std setpgid
  71 .Sh COMPATIBILITY
  72 .Fn Setpgrp
  73 is identical to
  74 .Fn setpgid ,
  75 and is retained for calling convention compatibility with historical
  76 versions of
  77 .Bx .
  78 .Sh ERRORS
  79 .Fn Setpgid
  80 will fail and the process group will not be altered if:
  81 .Bl -tag -width Er
  82 .It Bq Er EACCES
  83 The value of the
  84 .Fa pid
  85 argument matches the process ID of a child process of the calling
  86 process, and the child process has successfully executed one of the
  87 .Xr exec 3
  88 functions.
  89 .It Bq Er EINVAL
  90 The value of the
  91 .Fa pgrp
  92 is not legal (less than zero).
  93 .It Bq Er EPERM
  94 The effective user ID of the requested process is different
  95 from that of the caller and the process is not a descendent
  96 of the calling process.
  97 .It Bq Er ESRCH
  98 The value of the
  99 .Fa pid
 100 argument does not match the process ID of the calling process
 101 or of a child process of the calling process.
 102 .El
 103 .Sh SEE ALSO
 104 .Xr getpgrp 2
 105 .Sh STANDARDS
 106 The
 107 .Fn setpgid
 108 function call is expected to conform to
 109 .St -p1003.1-90 .