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