xref: /freebsd/lib/libc/gen/tcsetpgrp.3 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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.\"	@(#)tcsetpgrp.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd November 28, 2022
32.Dt TCSETPGRP 3
33.Os
34.Sh NAME
35.Nm tcsetpgrp
36.Nd set foreground process group ID
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In unistd.h
41.Ft int
42.Fn tcsetpgrp "int fd" "pid_t pgrp_id"
43.Sh DESCRIPTION
44If the process has a controlling terminal, the
45.Fn tcsetpgrp
46function sets the foreground process group ID associated with the
47terminal device to
48.Fa pgrp_id .
49The terminal device associated with
50.Fa fd
51must be the controlling terminal of the calling process and the
52controlling terminal must be currently associated with the session
53of the calling process.
54The value of
55.Fa pgrp_id
56must be the same as the process group ID of a process in the same
57session as the calling process.
58.Sh RETURN VALUES
59.Rv -std tcsetpgrp
60.Sh ERRORS
61The
62.Fn tcsetpgrp
63function will fail if:
64.Bl -tag -width Er
65.It Bq Er EBADF
66The
67.Fa fd
68argument is not a valid file descriptor.
69.It Bq Er EINVAL
70An invalid value of
71.Fa pgrp_id
72was specified.
73.It Bq Er ENOTTY
74The calling process does not have a controlling terminal, or the file
75represented by
76.Fa fd
77is not the controlling terminal, or the controlling terminal is no
78longer associated with the session of the calling process.
79.It Bq Er EPERM
80The
81.Fa pgrp_id
82argument does not match the process group ID of a process in the same
83session as the calling process.
84.El
85.Sh SEE ALSO
86.Xr setpgid 2 ,
87.Xr setsid 2 ,
88.Xr tcgetpgrp 3
89.Sh STANDARDS
90The
91.Fn tcsetpgrp
92function is expected to be compliant with the
93.St -p1003.1-88
94specification.
95