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