xref: /openbsd-src/lib/libc/termios/tcgetpgrp.3 (revision 73be947e61bb3531e84a5f9836a6c50da1c8011d)
1.\"	$OpenBSD: tcgetpgrp.3,v 1.11 2023/01/12 12:56:07 jsg Exp $
2.\"
3.\" Copyright (c) 1991 The Regents of the University of California.
4.\" 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.Dd $Mdocdate: January 12 2023 $
31.Dt TCGETPGRP 3
32.Os
33.Sh NAME
34.Nm tcgetpgrp
35.Nd get foreground process group ID
36.Sh SYNOPSIS
37.In unistd.h
38.Ft pid_t
39.Fn tcgetpgrp "int fd"
40.Sh DESCRIPTION
41The
42.Fn tcgetpgrp
43function returns the value of the process group ID of the foreground
44process group associated with the terminal device.
45If there is no foreground process group,
46.Fn tcgetpgrp
47returns an invalid process ID.
48.Sh ERRORS
49If an error occurs,
50.Fn tcgetpgrp
51returns \-1 and the global variable
52.Va errno
53is set to indicate the error, as follows:
54.Bl -tag -width Er
55.It Bq Er EBADF
56The
57.Fa fd
58argument is not a valid file descriptor.
59.It Bq Er ENOTTY
60The calling process does not have a controlling terminal or the
61underlying terminal device represented by
62.Fa fd
63is not the controlling terminal.
64.El
65.Sh SEE ALSO
66.Xr setpgid 2 ,
67.Xr setsid 2 ,
68.Xr tcsetpgrp 3
69.Sh STANDARDS
70The
71.Fn tcgetpgrp
72function is compliant with the
73.St -p1003.1-88
74specification.
75