bsd/man/man2/setpgid.2

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