xref: /netbsd/lib/libc/termios/tcgetpgrp.3 (revision eb7c1594)
1.\"	$NetBSD: tcgetpgrp.3,v 1.11 2003/08/07 16:44:13 agc 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. 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.\"	@(#)tcgetpgrp.3	8.1 (Berkeley) 6/4/93
31.\"
32.Dd June 4, 1993
33.Dt TCGETPGRP 3
34.Os
35.Sh NAME
36.Nm tcgetpgrp
37.Nd get foreground process group ID
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In unistd.h
42.Ft pid_t
43.Fn tcgetpgrp "int fd"
44.Sh DESCRIPTION
45The
46.Nm 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.Nm tcgetpgrp
51returns an invalid process ID.
52.Sh ERRORS
53If an error occurs,
54.Nm 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.Nm tcgetpgrp
76function conforms to
77.St -p1003.1-90 .
78