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 .\" $FreeBSD: src/lib/libc/gen/tcgetpgrp.3,v 1.6.2.2 2001/12/14 18:33:51 ru Exp $
  30 .\" $DragonFly: src/lib/libc/gen/tcgetpgrp.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt TCGETPGRP 3
  34 .Os
  35 .Sh NAME
  36 .Nm tcgetpgrp
  37 .Nd get foreground process group ID
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In unistd.h
  43 .Ft pid_t
  44 .Fn tcgetpgrp "int fd"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn tcgetpgrp
  48 function returns the value of the process group ID of the foreground
  49 process group associated with the terminal device.
  50 If there is no foreground process group,
  51 .Fn tcgetpgrp
  52 returns an invalid process ID.
  53 .Sh ERRORS
  54 If an error occurs,
  55 .Fn tcgetpgrp
  56 returns -1 and the global variable
  57 .Va errno
  58 is set to indicate the error, as follows:
  59 .Bl -tag -width Er
  60 .It Bq Er EBADF
  61 The
  62 .Fa fd
  63 argument is not a valid file descriptor.
  64 .It Bq Er ENOTTY
  65 The calling process does not have a controlling terminal or the
  66 underlying terminal device represented by
  67 .Fa fd
  68 is not the controlling terminal.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr setpgid 2 ,
  72 .Xr setsid 2 ,
  73 .Xr tcsetpgrp 3
  74 .Sh STANDARDS
  75 The
  76 .Fn tcgetpgrp
  77 function is expected to be compliant with the
  78 .St -p1003.1-88
  79 specification.