[apple/xnu.git] / bsd / man / man2 / setsid.2

.\"	$NetBSD: setsid.2,v 1.3 1995/10/12 15:41:13 jtc Exp $
.\"
.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)setsid.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt SETSID 2
.Os
.Sh NAME
.Nm setsid
.Nd create session and set process group ID
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft pid_t
.Fo setsid
.Fa void
.Fc
.Sh DESCRIPTION
The
.Nm setsid
function creates a new session.
The calling process is the session leader of the new session, is the
process group leader of a new process group and has no controlling
terminal.
The calling process is the only process in either the session or the
process group.
.Pp
Upon successful completion, the
.Nm setsid
function returns the value of the process group ID of the new process
group, which is the same as the process ID of the calling process.
.Sh ERRORS
If an error occurs,
.Nm setsid
returns -1 and the global variable
.Va errno
is set to indicate the error, as follows:
.Bl -tag -width Er
.It Bq Er EPERM
The calling process is already a process group leader, or the process
group ID of a process other than the calling process matches the process
ID of the calling process.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <unistd.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Sh SEE ALSO
.Xr setpgid 3 ,
.Xr tcgetpgrp 3 ,
.Xr tcsetpgrp 3 ,
.Xr compat 5
.Sh STANDARDS
The
.Nm setsid
function is expected to be compliant with the
.St -p1003.1-88
specification.
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: setsid.2,v 1.3 1995/10/12 15:41:13 jtc Exp $
	2	.\"
	3	.\" Copyright (c) 1991, 1993
	4	.\" The Regents of the University of California. 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. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)setsid.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt SETSID 2
	38	.Os
	39	.Sh NAME
	40	.Nm setsid
	41	.Nd create session and set process group ID
	42	.Sh SYNOPSIS
9bccf70c A	43	.Fd #include <unistd.h>
9bccf70c A	44	.Ft pid_t
2d21ac55 A	45	.Fo setsid
	46	.Fa void
	47	.Fc
9bccf70c A	48	.Sh DESCRIPTION
	49	The
	50	.Nm setsid
	51	function creates a new session.
	52	The calling process is the session leader of the new session, is the
	53	process group leader of a new process group and has no controlling
	54	terminal.
	55	The calling process is the only process in either the session or the
	56	process group.
	57	.Pp
	58	Upon successful completion, the
	59	.Nm setsid
	60	function returns the value of the process group ID of the new process
	61	group, which is the same as the process ID of the calling process.
	62	.Sh ERRORS
	63	If an error occurs,
	64	.Nm setsid
	65	returns -1 and the global variable
	66	.Va errno
	67	is set to indicate the error, as follows:
	68	.Bl -tag -width Er
	69	.It Bq Er EPERM
	70	The calling process is already a process group leader, or the process
	71	group ID of a process other than the calling process matches the process
	72	ID of the calling process.
	73	.El
2d21ac55 A	74	.Sh LEGACY SYNOPSIS
	75	.Fd #include <sys/types.h>
	76	.Fd #include <unistd.h>
	77	.Pp
	78	The include file
	79	.In sys/types.h
	80	is necessary.
9bccf70c A	81	.Sh SEE ALSO
	82	.Xr setpgid 3 ,
	83	.Xr tcgetpgrp 3 ,
2d21ac55 A	84	.Xr tcsetpgrp 3 ,
2d21ac55 A	85	.Xr compat 5
9bccf70c A	86	.Sh STANDARDS
	87	The
	88	.Nm setsid
	89	function is expected to be compliant with the
	90	.St -p1003.1-88
	91	specification.