3d39f812e9d23a25a1dca4962dccfe4e398ac8d8
[dragonfly.git] / lib / libc / 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 .\" $DragonFly: src/lib/libc/compat-43/setruid.3,v 1.2 2003/06/17 04:26:41 dillon Exp $
35 .\"
36 .Dd June 2, 1993
37 .Dt SETRUID 3
38 .Os
39 .Sh NAME
40 .Nm setruid ,
41 .Nm setrgid
42 .Nd set user and group ID
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In unistd.h
47 .Ft int
48 .Fn setruid "uid_t ruid"
49 .Ft int
50 .Fn setrgid "gid_t rgid"
51 .Sh DESCRIPTION
52 The
53 .Fn setruid
54 function
55 .Pq Fn setrgid
56 sets the real user ID (group ID) of the
57 current process.
58 .Sh RETURN VALUES
59 .Rv -std
60 .Sh ERRORS
61 The functions fail if:
62 .Bl -tag -width Er
63 .It Bq Er EPERM
64 The user is not the super user and the ID
65 specified is not the real or effective ID.
66 .El
67 .Sh COMPATIBILITY
68 The use of these calls is not portable.
69 Their use is discouraged; they will be removed in the future.
70 .Sh SEE ALSO
71 .Xr getgid 2 ,
72 .Xr getuid 2 ,
73 .Xr setegid 2 ,
74 .Xr seteuid 2 ,
75 .Xr setgid 2 ,
76 .Xr setuid 2
77 .Sh HISTORY
78 The
79 .Fn setruid
80 and
81 .Fn setrgid
82 syscalls appeared in
83 .Bx 4.2
84 and were dropped in
85 .Bx 4.4 .