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. 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 .\"     @(#)tcgetpgrp.3 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/tcgetpgrp.3,v 1.8 2001/10/01 16:08:51 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt TCGETPGRP 3
  37 .Os
  38 .Sh NAME
  39 .Nm tcgetpgrp
  40 .Nd get foreground process group ID
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft pid_t
  46 .Fo tcgetpgrp
  47 .Fa "int fildes"
  48 .Fc
  49 .Sh DESCRIPTION
  50 The
  51 .Fn tcgetpgrp
  52 function returns the value of the process group ID of the foreground
  53 process group associated with the terminal device.
  54 If there is no foreground process group,
  55 .Fn tcgetpgrp
  56 returns an invalid process ID.
  57 .Sh ERRORS
  58 If an error occurs,
  59 .Fn tcgetpgrp
  60 returns -1 and the global variable
  61 .Va errno
  62 is set to indicate the error, as follows:
  63 .Bl -tag -width Er
  64 .It Bq Er EBADF
  65 The
  66 .Fa fildes
  67 argument is not a valid file descriptor.
  68 .It Bq Er ENOTTY
  69 The calling process does not have a controlling terminal or the
  70 underlying terminal device represented by
  71 .Fa fildes
  72 is not the controlling terminal.
  73 .El
  74 .Sh LEGACY SYNOPSIS
  75 .Fd #include <sys/types.h>
  76 .Fd #include <unistd.h>
  77 .Pp
  78 The include file
  79 .In sys/types.h
  80 is necessary.
  81 .Sh SEE ALSO
  82 .Xr setpgid 2 ,
  83 .Xr setsid 2 ,
  84 .Xr tcsetpgrp 3 ,
  85 .Xr compat 5
  86 .Sh STANDARDS
  87 The
  88 .Fn tcgetpgrp
  89 function is expected to be compliant with the
  90 .St -p1003.1-88
  91 specification.