freebsd-dev/lib/libc/sys/setpgid.2

.\" Copyright (c) 1980, 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.
.\"
.\"     @(#)setpgid.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd February 8, 2004
.Dt SETPGID 2
.Os
.Sh NAME
.Nm setpgid ,
.Nm setpgrp
.Nd set process group
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn setpgid "pid_t pid" "pid_t pgrp"
.Ft int
.Fn setpgrp "pid_t pid" "pid_t pgrp"
.Sh DESCRIPTION
The
.Fn setpgid
system call
sets the process group of the specified process
.Fa pid
to the specified
.Fa pgrp .
If
.Fa pid
is zero, then the call applies to the current process.
If
.Fa pgrp
is zero, then the process id of the process specified by
.Fa pid
is used instead.
.Pp
If the affected process is not the invoking process, then it must be a
child of the invoking process, it must not have performed an
.Xr exec 3
operation, and both processes must be in the same session.
The requested process group ID must already exist in the session of
the caller, or it must be equal to the target process ID.
.Sh RETURN VALUES
.Rv -std setpgid
.Sh COMPATIBILITY
The
.Fn setpgrp
system call
is identical to
.Fn setpgid ,
and is retained for calling convention compatibility with historical
versions of
.Bx .
.Sh ERRORS
The
.Fn setpgid
system call
will fail and the process group will not be altered if:
.Bl -tag -width Er
.It Bq Er EINVAL
The requested process group ID is not legal.
.It Bq Er ESRCH
The requested process does not exist.
.It Bq Er ESRCH
The target process is not the calling process or
a child of the calling process.
.It Bq Er EACCES
The requested process is a child of the calling process,
but it has performed an
.Xr exec 3
operation.
.It Bq Er EPERM
The target process is a session leader.
.It Bq Er EPERM
The requested process group ID is not in the session of the caller,
and it is not equal to the process ID of the target process.
.El
.Sh SEE ALSO
.Xr getpgrp 2
.Sh STANDARDS
The
.Fn setpgid
system call is expected to conform to
.St -p1003.1-90 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1980, 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.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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.`
			`.\"`
			`.\" @(#)setpgid.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Update the documentation for setpgrp(2) to reflect the access control checks that the code actually performs. Judging from the 4.2BSD release notes, the docs have only been out of date for 20 years. PR: 29844 2004-02-08 12:38:30 +00:00			`.Dd February 8, 2004`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt SETPGID 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm setpgid ,`
			`.Nm setpgrp`
			`.Nd set process group`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +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`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
Proper spacing in the Synopsis. 1997-10-16 01:19:15 +00:00			`.Fn setpgid "pid_t pid" "pid_t pgrp"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
Proper spacing in the Synopsis. 1997-10-16 01:19:15 +00:00			`.Fn setpgrp "pid_t pid" "pid_t pgrp"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
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`
			`.Fn setpgid`
			`system call`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`sets the process group of the specified process`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa pid`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`to the specified`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa pgrp .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`If`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa pid`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`is zero, then the call applies to the current process.`
Describe what setpgid(2) does when pgid=0. The text has been copied from NetBSD's manpage, and it also matches the behavior described by the Open Group's online copy of setpgid.2 at http://www.opengroup.org/onlinepubs/009695399/functions/setpgid.html Obtained from: NetBSD Submitted by: Petros Barbayiannis <petrosbarbayiannis@yahoo.gr> MFC after: 1 week 2009-12-01 06:12:31 +00:00			`If`
			`.Fa pgrp`
			`is zero, then the process id of the process specified by`
			`.Fa pid`
			`is used instead.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Pp`
Update the documentation for setpgrp(2) to reflect the access control checks that the code actually performs. Judging from the 4.2BSD release notes, the docs have only been out of date for 20 years. PR: 29844 2004-02-08 12:38:30 +00:00			`If the affected process is not the invoking process, then it must be a`
			`child of the invoking process, it must not have performed an`
			`.Xr exec 3`
			`operation, and both processes must be in the same session.`
			`The requested process group ID must already exist in the session of`
			`the caller, or it must be equal to the target process ID.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh RETURN VALUES`
Use ``.Rv -std'' wherever possible. Submitted by: yar 2001-08-31 09:57:38 +00:00			`.Rv -std setpgid`
Sort sections. 2005-01-20 09:17:07 +00:00			`.Sh COMPATIBILITY`
			`The`
			`.Fn setpgrp`
			`system call`
			`is identical to`
			`.Fn setpgid ,`
			`and is retained for calling convention compatibility with historical`
			`versions of`
			`.Bx .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.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`
			`.Fn setpgid`
			`system call`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`will fail and the process group will not be altered if:`
Use `Er' variable to define first column width in ERRORS section. It was initially suggested by mdoc(7) style, but was broken over the years 2000-05-04 13:09:25 +00:00			`.Bl -tag -width Er`
Update the documentation for setpgrp(2) to reflect the access control checks that the code actually performs. Judging from the 4.2BSD release notes, the docs have only been out of date for 20 years. PR: 29844 2004-02-08 12:38:30 +00:00			`.It Bq Er EINVAL`
			`The requested process group ID is not legal.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er ESRCH`
			`The requested process does not exist.`
Update the documentation for setpgrp(2) to reflect the access control checks that the code actually performs. Judging from the 4.2BSD release notes, the docs have only been out of date for 20 years. PR: 29844 2004-02-08 12:38:30 +00:00			`.It Bq Er ESRCH`
			`The target process is not the calling process or`
			`a child of the calling process.`
			`.It Bq Er EACCES`
			`The requested process is a child of the calling process,`
			`but it has performed an`
			`.Xr exec 3`
			`operation.`
			`.It Bq Er EPERM`
			`The target process is a session leader.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er EPERM`
Update the documentation for setpgrp(2) to reflect the access control checks that the code actually performs. Judging from the 4.2BSD release notes, the docs have only been out of date for 20 years. PR: 29844 2004-02-08 12:38:30 +00:00			`The requested process group ID is not in the session of the caller,`
			`and it is not equal to the process ID of the target process.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr getpgrp 2`
			`.Sh STANDARDS`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`The`
			`.Fn setpgid`
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 expected to conform to`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`.St -p1003.1-90 .`