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