Initial import from FreeBSD RELENG_4:
[games.git] / lib / libcr / compat-43 / setruid.3
1 .\" Copyright (c) 1983, 1991, 1993
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 .\"
32 .\"     @(#)setruid.3   8.1 (Berkeley) 6/2/93
33 .\" $FreeBSD: src/lib/libc/compat-43/setruid.3,v 1.5.2.5 2001/12/14 18:33:49 ru Exp $
34 .\"
35 .Dd June 2, 1993
36 .Dt SETRUID 3
37 .Os
38 .Sh NAME
39 .Nm setruid ,
40 .Nm setrgid
41 .Nd set user and group ID
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft int
47 .Fn setruid "uid_t ruid"
48 .Ft int
49 .Fn setrgid "gid_t rgid"
50 .Sh DESCRIPTION
51 The
52 .Fn setruid
53 function
54 .Pq Fn setrgid
55 sets the real user ID (group ID) of the
56 current process.
57 .Sh RETURN VALUES
58 .Rv -std
59 .Sh ERRORS
60 The functions fail if:
61 .Bl -tag -width Er
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.
69 .Sh SEE ALSO
70 .Xr getgid 2 ,
71 .Xr getuid 2 ,
72 .Xr setegid 2 ,
73 .Xr seteuid 2 ,
74 .Xr setgid 2 ,
75 .Xr setuid 2
76 .Sh HISTORY
77 The
78 .Fn setruid
79 and
80 .Fn setrgid
81 syscalls appeared in
82 .Bx 4.2
83 and were dropped in
84 .Bx 4.4 .