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