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