NetBSD/lib/libc/sys/setsid.2

.\"	$NetBSD: setsid.2,v 1.13 2004/05/13 10:20:58 wiz 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. 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 LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft pid_t
.Fn setsid "void"
.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 SEE ALSO
.Xr setpgid 2 ,
.Xr tcgetpgrp 3 ,
.Xr tcsetpgrp 3
.Sh STANDARDS
The
.Nm setsid
function conforms to
.St -p1003.1-90 .
\- is a minus, not -. 2004-05-13 14:20:57 +04:00			`.\" $NetBSD: setsid.2,v 1.13 2004/05/13 10:20:58 wiz Exp $`
merge with lite, keeping most local changes. clean up Ids 1995-02-27 15:31:34 +03:00			`.\"`
from Lite 1995-02-27 13:49:50 +03:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.\"`
			`.\" 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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
from Lite 1995-02-27 13:49:50 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.\"`
from Lite 1995-02-27 13:49:50 +03:00			.\" 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.`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.\"`
from Lite 1995-02-27 13:49:50 +03:00			`.\" @(#)setsid.2 8.1 (Berkeley) 6/4/93`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.\"`
Fix broken uses of Dd. Both the mdoc and mdoc.samples pages agree: .Dd is supposed to be invoked like: .Dd month day, year e.g. ".Dd January 25, 1989", rather than: .Dd "month day, year" which is what these pages did. 1997-05-29 05:48:05 +04:00			`.Dd June 4, 1993`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Dt SETSID 2`
			`.Os`
			`.Sh NAME`
			`.Nm setsid`
from Lite 1995-02-27 13:49:50 +03:00			`.Nd create session and set process group ID`
Add a LIBRARY section to system call manual pages. While it's clear that the libraries contain stubs only (with minor exceptions a la pipe(2)), the purpose of this section is to provide linkage information. 1999-12-03 00:42:35 +03:00			`.Sh LIBRARY`
			`.Lb libc`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Sh SYNOPSIS`
Use .In header.h instead of .Fd #include \[Lt]header.h\[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross. 2003-04-16 17:34:34 +04:00			`.In unistd.h`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Ft pid_t`
from Lite 1995-02-27 13:49:50 +03:00			`.Fn setsid "void"`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Sh DESCRIPTION`
from Lite 1995-02-27 13:49:50 +03:00			`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.`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Sh ERRORS`
from Lite 1995-02-27 13:49:50 +03:00			`If an error occurs,`
			`.Nm setsid`
\- is a minus, not -. 2004-05-13 14:20:57 +04:00			`returns \-1 and the global variable`
from Lite 1995-02-27 13:49:50 +03:00			`.Va errno`
			`is set to indicate the error, as follows:`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Bl -tag -width Er`
			`.It Bq Er EPERM`
from Lite 1995-02-27 13:49:50 +03:00			`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.`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.El`
			`.Sh SEE ALSO`
xref setpgid(2), not nonexistent setpgid(3) 1997-07-22 09:59:58 +04:00			`.Xr setpgid 2 ,`
from Lite 1995-02-27 13:49:50 +03:00			`.Xr tcgetpgrp 3 ,`
			`.Xr tcsetpgrp 3`
First cut at a setsid(2) manual page. 1994-04-16 02:48:01 +04:00			`.Sh STANDARDS`
from Lite 1995-02-27 13:49:50 +03:00			`The`
			`.Nm setsid`
Add missing `STANDARDS' compliance statements. As we #define _POSIX_VERSION to 199009L, bump existing statements to 1003.1-1990. 1997-07-15 03:19:39 +04:00			`function conforms to`
			`.St -p1003.1-90 .`