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