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