xref: /freebsd/lib/libc/gen/tcsetpgrp.3 (revision afe61c15161c324a7af299a9b8457aba5afc92db)
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.\"	@(#)tcsetpgrp.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd "June 4, 1993"
35.Dt TCSETPGRP 3
36.Os
37.Sh NAME
38.Nm tcsetpgrp
39.Nd set foreground process group ID
40.Sh SYNOPSIS
41.Fd #include <sys/types.h>
42.Fd #include <unistd.h>
43.Ft int
44.Fn tcsetpgrp "int fd" "pid_t pgrp_id"
45.Sh DESCRIPTION
46If the process has a controlling terminal, the
47.Nm tcsetpgrp
48function sets the foreground process group ID associated with the
49terminal device to
50.Fa pgrp_id .
51The terminal device associated with
52.Fa fd
53must be the controlling terminal of the calling process and the
54controlling terminal must be currently associated with the session
55of the calling process.
56The value of
57.Fa pgrp_id
58must be the same as the process group ID of a process in the same
59session as the calling process.
60.Pp
61Upon successful completion,
62.Nm tcsetpgrp
63returns a value of zero.
64.Sh ERRORS
65If an error occurs,
66.Nm tcgetpgrp
67returns -1 and the global variable
68.Va errno
69is set to indicate the error, as follows:
70.Bl -tag -width Er
71.It Bq Er EBADF
72The
73.Fa fd
74argument is not a valid file descriptor.
75.It Bq Er EINVAL
76An invalid value of
77.Fa pgrp_id
78was specified.
79.It Bq Er ENOTTY
80The calling process does not have a controlling terminal, or the file
81represented by
82.Fa fd
83is not the controlling terminal, or the controlling terminal is no
84longer associated with the session of the calling process.
85.It Bq Er EPERM
86The
87.Fa pgrp_id
88argument does not match the process group ID of a process in the same
89session as the calling process.
90.El
91.Sh SEE ALSO
92.Xr setpgid 3 ,
93.Xr setsid 2 ,
94.Xr tcgetpgrp 3
95.Sh STANDARDS
96The
97.Nm tcsetpgprp
98function is expected to be compliant with the
99.St -p1003.1-88
100specification.
101