Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / lib / libc / sys / setreuid.2
1 .\" Copyright (c) 1980, 1991, 1993, 1994
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. 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 .\"
28 .\"     @(#)setreuid.2  8.2 (Berkeley) 4/16/94
29 .\" $FreeBSD: src/lib/libc/sys/setreuid.2,v 1.6.2.6 2001/12/14 18:34:01 ru Exp $
30 .\" $DragonFly: src/lib/libc/sys/setreuid.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
31 .\"
32 .Dd February 8, 2001
33 .Dt SETREUID 2
34 .Os
35 .Sh NAME
36 .Nm setreuid
37 .Nd set real and effective user ID's
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In unistd.h
42 .Ft int
43 .Fn setreuid "uid_t ruid" "uid_t euid"
44 .Sh DESCRIPTION
45 The real and effective user IDs of the
46 current process are set according to the arguments.
47 If
48 .Fa ruid
49 or
50 .Fa euid
51 is -1, the current uid is filled in by the system.
52 Unprivileged users may change the real user
53 ID to the effective user ID and vice-versa; only the super-user may
54 make other changes.
55 .Pp
56 The
57 .Fn setreuid
58 function has been used to swap the real and effective user IDs
59 in set-user-ID programs to temporarily relinquish the set-user-ID value.
60 This purpose is now better served by the use of the
61 .Fn seteuid
62 function (see
63 .Xr setuid 2 ) .
64 .Pp
65 When setting the real and effective user IDs to the same value,
66 the standard
67 .Fn setuid
68 function is preferred.
69 .Sh RETURN VALUES
70 .Rv -std setreuid
71 .Sh ERRORS
72 .Bl -tag -width Er
73 .It Bq Er EPERM
74 The current process is not the super-user and a change
75 other than changing the effective user-id to the real user-id
76 was specified.
77 .El
78 .Sh SEE ALSO
79 .Xr getuid 2 ,
80 .Xr issetugid 2 ,
81 .Xr seteuid 2 ,
82 .Xr setuid 2
83 .Sh HISTORY
84 The
85 .Fn setreuid
86 system call appeared in
87 .Bx 4.2 .