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 .Fo setpgid
  47 .Fa "pid_t pid"
  48 .Fa "pid_t pgid"
  49 .Fc
  50 .Ft pid_t
  51 .Fo setpgrp
  52 .Fa void
  53 .Fc
  54 .Sh DESCRIPTION
  55 .Fn Setpgid
  56 sets the process group of the specified process
  57 .Ar pid
  58 to the specified
  59 .Ar pgid .
  60 If
  61 .Ar pid
  62 is zero, then the call applies to the current process.
  63 .Pp
  64 If the invoker is not the super-user, then the affected process
  65 must have the same effective user-id as the invoker or be a descendant
  66 of the invoking process.
  67 .Pp
  68 If the calling process is not already a session leader,
  69 .Fn setpgrp
  70 sets the process group ID of the calling process
  71 to that of the calling process.
  72 Any new session that this creates will have no controlling terminal.
  73 .Sh RETURN VALUES
  74 .Fn Setpgid
  75 returns 0 when the operation was successful.
  76 If the request failed, -1 is returned and the global variable
  77 .Va errno
  78 indicates the reason.
  79 .Sh ERRORS
  80 .Fn Setpgid
  81 will fail and the process group will not be altered if:
  82 .Bl -tag -width Er
  83 .\" ===========
  84 .It Bq Er EACCES
  85 The value of the
  86 .Fa pid
  87 argument matches the process ID of a child process of the calling process,
  88 and the child process has successfully executed one of the exec functions.
  89 .\" ===========
  90 .It Bq Er EINVAL
  91 The value of the
  92 .Fa pgid
  93 argument is less than 0
  94 or is not a value supported by the implementation.
  95 .\" ===========
  96 .It Bq Er EPERM
  97 The process indicated by the
  98 .Fa pid
  99 argument is a session leader.
 100 .\" ===========
 101 .It Bq Er EPERM
 102 The effective user ID of the requested process is different
 103 from that of the caller and the process is not a descendant
 104 of the calling process.
 105 .\" ===========
 106 .It Bq Er EPERM
 107 The value of the
 108 .Fa pgid argument
 109 is valid, but does not match the process ID
 110 of the process indicated by the
 111 .Fa pid
 112 argument and there is no process with a process group ID
 113 that matches the value of the
 114 .Fa pgid
 115 argument in the same session as the calling process.
 116 .\" ===========
 117 .It Bq Er ESRCH
 118 The value of the
 119 .Fa pid
 120 argument does not match the process ID of the calling process or of a
 121 child process of the calling process.
 122 .El
 123 .Sh LEGACY SYNOPSIS
 124 .Fd #include <unistd.h>
 125 .Pp
 126 .Ft int
 127 .br
 128 .Fo setpgrp
 129 .Fa "pid_t pid"
 130 .Fa "pid_t pgid"
 131 .Fc ;
 132 .Pp
 133 The legacy
 134 .Fn setpgrp
 135 function is a clone of the
 136 .Fn setpgid
 137 function, retained for calling convention compatibility
 138 with historical versions of
 139 .Bx .
 140 .Sh COMPATIBILITY
 141 Use of the legacy version of the
 142 .Fn setpgrp
 143 call will cause compiler diagnostics.
 144 Use
 145 .Fn setpgid
 146 instead.
 147 .Pp
 148 Use of private (and conflicting) prototypes for
 149 .Fn setpgrp
 150 will cause compiler diagnostics.
 151 Delete the private prototypes and include
 152 .In unistd.h .
 153 .Sh SEE ALSO
 154 .Xr getpgrp 2 ,
 155 .Xr compat 5
 156 .Sh STANDARDS
 157 The
 158 .Fn setpgid
 159 function conforms to
 160 .St -p1003.1-88 .