lib/libcr/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 .\"
  35 .Dd June 4, 1993
  36 .Dt SETPGID 2
  37 .Os
  38 .Sh NAME
  39 .Nm setpgid ,
  40 .Nm setpgrp
  41 .Nd set process group
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft int
  47 .Fn setpgid "pid_t pid" "pid_t pgrp"
  48 .Ft int
  49 .Fn setpgrp "pid_t pid" "pid_t pgrp"
  50 .Sh DESCRIPTION
  51 .Fn Setpgid
  52 sets the process group of the specified process
  53 .Fa pid
  54 to the specified
  55 .Fa pgrp .
  56 If
  57 .Fa pid
  58 is zero, then the call applies to the current process.
  59 .Pp
  60 If the invoker is not the super-user, then the affected process
  61 must have the same effective user-id as the invoker or be a descendant
  62 of the invoking process.
  63 .Sh RETURN VALUES
  64 .Rv -std setpgid
  65 .Sh ERRORS
  66 .Fn Setpgid
  67 will fail and the process group will not be altered if:
  68 .Bl -tag -width Er
  69 .It Bq Er ESRCH
  70 The requested process does not exist.
  71 .It Bq Er EPERM
  72 The effective user ID of the requested process is different
  73 from that of the caller and the process is not a descendent
  74 of the calling process.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr getpgrp 2
  78 .Sh STANDARDS
  79 The
  80 .Fn setpgid
  81 function call is expected to conform to
  82 .St -p1003.1-90 .
  83 .Sh COMPATIBILITY
  84 .Fn Setpgrp
  85 is identical to
  86 .Fn setpgid ,
  87 and is retained for calling convention compatibility with historical
  88 versions of
  89 .Bx .