[apple/libc.git] / compat-43 / FreeBSD / setruid.3

.\" Copyright (c) 1983, 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.
.\" 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.
.\"
.\"     @(#)setruid.3	8.1 (Berkeley) 6/2/93
.\" $FreeBSD: src/lib/libc/compat-43/setruid.3,v 1.12 2007/01/09 00:27:49 imp Exp $
.\"
.Dd June 2, 1993
.Dt SETRUID 3
.Os
.Sh NAME
.Nm setruid ,
.Nm setrgid
.Nd set user and group ID
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft int
.Fn setruid "uid_t ruid"
.Ft int
.Fn setrgid "gid_t rgid"
.Sh DESCRIPTION
The
.Fn setruid
function
.Pq Fn setrgid
sets the real user ID (group ID) of the
current process.
.Sh RETURN VALUES
.Rv -std
.Sh COMPATIBILITY
The use of these calls is not portable.
Their use is discouraged; they will be removed in the future.
.Sh ERRORS
The functions fail if:
.Bl -tag -width Er
.It Bq Er EPERM
The user is not the super user and the ID
specified is not the real or effective ID.
.El
.Sh SEE ALSO
.Xr getgid 2 ,
.Xr getuid 2 ,
.Xr setegid 2 ,
.Xr seteuid 2 ,
.Xr setgid 2 ,
.Xr setuid 2
.Sh HISTORY
The
.Fn setruid
and
.Fn setrgid
syscalls appeared in
.Bx 4.2
and were dropped in
.Bx 4.4 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1983, 1991, 1993
e9ce8d39 A	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.
e9ce8d39 A	12	.\" 4. Neither the name of the University nor the names of its contributors
	13	.\" may be used to endorse or promote products derived from this software
	14	.\" without specific prior written permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
5b2abdfb	28	.\" @(#)setruid.3 8.1 (Berkeley) 6/2/93
1f2f436a	29	.\" $FreeBSD: src/lib/libc/compat-43/setruid.3,v 1.12 2007/01/09 00:27:49 imp Exp $
e9ce8d39	30	.\"
5b2abdfb A	31	.Dd June 2, 1993
5b2abdfb A	32	.Dt SETRUID 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
5b2abdfb A	35	.Nm setruid ,
	36	.Nm setrgid
	37	.Nd set user and group ID
e9ce8d39 A	38	.Sh LIBRARY
	39	.Lb libc
	40	.Sh SYNOPSIS
5b2abdfb	41	.In unistd.h
e9ce8d39	42	.Ft int
5b2abdfb A	43	.Fn setruid "uid_t ruid"
	44	.Ft int
	45	.Fn setrgid "gid_t rgid"
e9ce8d39 A	46	.Sh DESCRIPTION
e9ce8d39 A	47	The
5b2abdfb A	48	.Fn setruid
	49	function
	50	.Pq Fn setrgid
	51	sets the real user ID (group ID) of the
	52	current process.
e9ce8d39	53	.Sh RETURN VALUES
5b2abdfb	54	.Rv -std
1f2f436a A	55	.Sh COMPATIBILITY
	56	The use of these calls is not portable.
	57	Their use is discouraged; they will be removed in the future.
e9ce8d39	58	.Sh ERRORS
5b2abdfb	59	The functions fail if:
e9ce8d39	60	.Bl -tag -width Er
5b2abdfb A	61	.It Bq Er EPERM
	62	The user is not the super user and the ID
	63	specified is not the real or effective ID.
	64	.El
e9ce8d39	65	.Sh SEE ALSO
5b2abdfb A	66	.Xr getgid 2 ,
	67	.Xr getuid 2 ,
	68	.Xr setegid 2 ,
	69	.Xr seteuid 2 ,
	70	.Xr setgid 2 ,
	71	.Xr setuid 2
e9ce8d39 A	72	.Sh HISTORY
e9ce8d39 A	73	The
5b2abdfb A	74	.Fn setruid
	75	and
	76	.Fn setrgid
	77	syscalls appeared in
	78	.Bx 4.2
	79	and were dropped in
e9ce8d39	80	.Bx 4.4 .