git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

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