lib/libc/sys/getpgrp.2

   1 .\" Copyright (c) 1983, 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 .\"     @(#)getpgrp.2   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/getpgrp.2,v 1.11.2.6 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/getpgrp.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETPGRP 2
  38 .Os
  39 .Sh NAME
  40 .Nm getpgrp
  41 .Nd get process group
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft pid_t
  47 .Fn getpgrp void
  48 .Ft pid_t
  49 .Fn getpgid "pid_t pid"
  50 .Sh DESCRIPTION
  51 The process group of the current process is returned by
  52 .Fn getpgrp .
  53 The process group of the process identified by
  54 .Fa pid
  55 is returned by
  56 .Fn getpgid .
  57 If
  58 .Fa pid
  59 is zero,
  60 .Fn getpgid
  61 returns the process group of the current process.
  62 .Pp
  63 Process groups are used for distribution of signals, and
  64 by terminals to arbitrate requests for their input: processes
  65 that have the same process group as the terminal are foreground
  66 and may read, while others will block with a signal if they attempt
  67 to read.
  68 .Pp
  69 This call is thus used by programs such as
  70 .Xr csh 1
  71 to create
  72 process groups
  73 in implementing job control.
  74 The
  75 .Fn tcgetpgrp
  76 and
  77 .Fn tcsetpgrp
  78 calls
  79 are used to get/set the process group of the control terminal.
  80 .Sh RETURN VALUES
  81 The
  82 .Fn getpgrp
  83 call always succeeds.
  84 Upon successful completion, the
  85 .Fn getpgid
  86 call returns the process group of the specified process;
  87 otherwise, it returns a value of \-1 and sets
  88 .Va errno
  89 to indicate the error.
  90 .Sh ERRORS
  91 .Fn getpgid
  92 will succeed unless:
  93 .Bl -tag -width Er
  94 .It Bq Er ESRCH
  95 there is no process whose process ID equals
  96 .Fa pid
  97 .El
  98 .Sh SEE ALSO
  99 .Xr getsid 2 ,
 100 .Xr setpgid 2 ,
 101 .Xr termios 4
 102 .Sh HISTORY
 103 The
 104 .Fn getpgrp
 105 function call appeared in
 106 .Bx 4.0 .
 107 The
 108 .Fn getpgid
 109 function call is derived from its usage in System V Release 4.
 110 .Sh STANDARDS
 111 The
 112 .Fn getpgrp
 113 function call is expected to conform to
 114 .St -p1003.1-90 .
 115 .Sh COMPATIBILITY
 116 This version of
 117 .Fn getpgrp
 118 differs from past Berkeley versions by not taking a
 119 .Fa "pid_t pid"
 120 argument.
 121 This incompatibility is required by
 122 .St -p1003.1-90 .
 123 .Pp
 124 From the
 125 .St -p1003.1-90
 126 Rationale:
 127 .Pp
 128 .Bx 4.3
 129 provides a
 130 .Fn getpgrp
 131 function that returns the process group ID for a specified process.
 132 Although this function is used to support job control, all known
 133 job-control shells always specify the calling process with this
 134 function.
 135 Thus, the simpler
 136 .At V
 137 .Fn getpgrp
 138 suffices, and the added complexity of the
 139 .Bx 4.3
 140 .Fn getpgrp
 141 has been omitted from POSIX.1.
 142 The old functionality is available from the
 143 .Fn getpgid
 144 function.