freebsd-skq/lib/libc/sys/getsid.2

.\" Copyright (c) 1997 Peter Wemm <peter@FreeBSD.org>
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd August 19, 1997
.Dt GETSID 2
.Os
.Sh NAME
.Nm getsid
.Nd get process session
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft pid_t
.Fn getsid "pid_t pid"
.Sh DESCRIPTION
The session ID of the process identified by
.Fa pid
is returned by
.Fn getsid .
If
.Fa pid
is zero,
.Fn getsid
returns the session ID of the current process.
.Sh RETURN VALUES
Upon successful completion, the
.Fn getsid
system call
returns the session ID of
the specified process; otherwise, it returns a value of -1 and
sets errno to indicate an error.
.Sh ERRORS
The
.Fn getsid
system call
will succeed unless:
.Bl -tag -width Er
.It Bq Er ESRCH
if there is no process with a process ID equal to
.Fa pid .
.El
.Pp
Note that an implementation may restrict this system call to
processes within the same session ID as the calling process.
.Sh SEE ALSO
.Xr getpgid 2 ,
.Xr getpgrp 2 ,
.Xr setpgid 2 ,
.Xr setsid 2 ,
.Xr termios 4
.Sh HISTORY
The
.Fn getsid
system call appeared in
.Fx 3.0 .
The
.Fn getsid
system call is derived from its usage in
.At V .
Spell "FreeBSD" with "F" and "BSD" in uppercase. 2001-08-13 16:33:00 +00:00			`.\" Copyright (c) 1997 Peter Wemm <peter@FreeBSD.org>`
Manpage for getsid(2). 1997-08-19 07:19:43 +00: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.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.\"`
			`.Dd August 19, 1997`
			`.Dt GETSID 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Sh NAME`
			`.Nm getsid`
			`.Nd get process session`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Ft pid_t`
			`.Fn getsid "pid_t pid"`
			`.Sh DESCRIPTION`
			`The session ID of the process identified by`
			`.Fa pid`
			`is returned by`
			`.Fn getsid .`
			`If`
			`.Fa pid`
			`is zero,`
			`.Fn getsid`
			`returns the session ID of the current process.`
			`.Sh RETURN VALUES`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`Upon successful completion, the`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Fn getsid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`returns the session ID of`
			`the specified process; otherwise, it returns a value of -1 and`
			`sets errno to indicate an error.`
			`.Sh ERRORS`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Fn getsid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`will succeed unless:`
			`.Bl -tag -width Er`
			`.It Bq Er ESRCH`
			`if there is no process with a process ID equal to`
			`.Fa pid .`
			`.El`
			`.Pp`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`Note that an implementation may restrict this system call to`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`processes within the same session ID as the calling process.`
			`.Sh SEE ALSO`
			`.Xr getpgid 2 ,`
Sort cross refereces in section SEE ALSO. 1997-09-29 19:11:55 +00:00			`.Xr getpgrp 2 ,`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Xr setpgid 2 ,`
			`.Xr setsid 2 ,`
			`.Xr termios 4`
			`.Sh HISTORY`
			`The`
This is the getsid() we are talking about, not setsid(). PR: docs/25626 Submitted by: Yoshihiko Sarumaru <mistral@imasy.or.jp> 2001-03-09 11:16:09 +00:00			`.Fn getsid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call appeared in`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.Fx 3.0 .`
			`The`
			`.Fn getsid`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call is derived from its usage in`
Manpage for getsid(2). 1997-08-19 07:19:43 +00:00			`.At V .`