Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / compat-43 / setruid.3
blob099185ff7845ab45299c34d4639f4b55f32015b7
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. 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 .\"     from: @(#)setruid.3     8.1 (Berkeley) 6/2/93
29 .\"     $NetBSD: setruid.3,v 1.9 2003/04/16 13:34:35 wiz Exp $
30 .\"
31 .Dd June 2, 1993
32 .Dt SETRUID 3
33 .Os
34 .Sh NAME
35 .Nm setruid ,
36 .Nm setrgid
37 .Nd set user and group ID
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In sys/types.h
42 .Ft int
43 .Fn setruid "uid_t ruid"
44 .Ft int
45 .Fn setrgid "gid_t rgid"
46 .Sh DESCRIPTION
47 The
48 .Fn setruid
49 function
50 .Pq Fn setrgid
51 sets the real user ID (group ID) of the
52 current process.
53 .Sh RETURN VALUES
54 Upon success, these functions return 0;
55 otherwise \-1 is returned.
56 .Pp
57 If the user is not the super user, or the uid
58 specified is not the real or effective ID, these
59 functions return \-1.
60 .Pp
61 The use of these calls is not portable.
62 Their use is discouraged; they will be removed in the future.
63 .Sh SEE ALSO
64 .Xr getgid 2 ,
65 .Xr getuid 2 ,
66 .Xr setegid 2 ,
67 .Xr seteuid 2 ,
68 .Xr setgid 2 ,
69 .Xr setuid 2
70 .Sh HISTORY
71 The
72 .Fn setruid
73 and
74 .Fn setrgid
75 syscalls appeared in
76 .Bx 4.2
77 and were dropped in
78 .Bx 4.4 .