lib/libc/gen/tcgetpgrp.3

   1 .\" Copyright (c) 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 .\"     @(#)tcgetpgrp.3 8.1 (Berkeley) 6/4/93
  29 .\"
  30 .Dd November 28, 2022
  31 .Dt TCGETPGRP 3
  32 .Os
  33 .Sh NAME
  34 .Nm tcgetpgrp
  35 .Nd get foreground process group ID
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In unistd.h
  40 .Ft pid_t
  41 .Fn tcgetpgrp "int fd"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn tcgetpgrp
  45 function returns the value of the process group ID of the foreground
  46 process group associated with the terminal device.
  47 If there is no foreground process group,
  48 .Fn tcgetpgrp
  49 returns an invalid process ID.
  50 .Sh ERRORS
  51 If an error occurs,
  52 .Fn tcgetpgrp
  53 returns -1 and the global variable
  54 .Va errno
  55 is set to indicate the error, as follows:
  56 .Bl -tag -width Er
  57 .It Bq Er EBADF
  58 The
  59 .Fa fd
  60 argument is not a valid file descriptor.
  61 .It Bq Er ENOTTY
  62 The calling process does not have a controlling terminal or the
  63 underlying terminal device represented by
  64 .Fa fd
  65 is not the controlling terminal.
  66 .El
  67 .Sh SEE ALSO
  68 .Xr setpgid 2 ,
  69 .Xr setsid 2 ,
  70 .Xr tcsetpgrp 3
  71 .Sh STANDARDS
  72 The
  73 .Fn tcgetpgrp
  74 function is expected to be compliant with the
  75 .St -p1003.1-88
  76 specification.