xref: /netbsd/lib/libc/termios/tcgetpgrp.3 (revision bf9ec67e)
1.\"	$NetBSD: tcgetpgrp.3,v 1.9 2002/04/29 01:41:46 simonb Exp $
2.\"
3.\" Copyright (c) 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.\"	@(#)tcgetpgrp.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt TCGETPGRP 3
38.Os
39.Sh NAME
40.Nm tcgetpgrp
41.Nd get foreground process group ID
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include \*[Lt]unistd.h\*[Gt]
46.Ft pid_t
47.Fn tcgetpgrp "int fd"
48.Sh DESCRIPTION
49The
50.Nm tcgetpgrp
51function returns the value of the process group ID of the foreground
52process group associated with the terminal device.
53If there is no foreground process group,
54.Nm tcgetpgrp
55returns an invalid process ID.
56.Sh ERRORS
57If an error occurs,
58.Nm tcgetpgrp
59returns -1 and the global variable
60.Va errno
61is set to indicate the error, as follows:
62.Bl -tag -width Er
63.It Bq Er EBADF
64The
65.Fa fd
66argument is not a valid file descriptor.
67.It Bq Er ENOTTY
68The calling process does not have a controlling terminal or the
69underlying terminal device represented by
70.Fa fd
71is not the controlling terminal.
72.El
73.Sh SEE ALSO
74.Xr setpgid 2 ,
75.Xr setsid 2 ,
76.Xr tcsetpgrp 3
77.Sh STANDARDS
78The
79.Nm tcgetpgrp
80function conforms to
81.St -p1003.1-90 .
82