freebsd-nq/lib/libc/sys/getuid.2

.\" Copyright (c) 1980, 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.
.\"
.\"     @(#)getuid.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt GETUID 2
.Os
.Sh NAME
.Nm getuid ,
.Nm geteuid
.Nd get user identification
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.In sys/types.h
.Ft uid_t
.Fn getuid void
.Ft uid_t
.Fn geteuid void
.Sh DESCRIPTION
The
.Fn getuid
function returns the real user ID of the calling process.
The
.Fn geteuid
function
returns the effective user ID of the calling process.
.Pp
The real user ID is that of the user who has invoked the program.
As the effective user ID
gives the process additional permissions during
execution of
.Dq Em set-user-ID
mode processes,
.Fn getuid
is used to determine the real-user-id of the calling process.
.Sh ERRORS
The
.Fn getuid
and
.Fn geteuid
functions are always successful, and no return value is reserved to
indicate an error.
.Sh SEE ALSO
.Xr getgid 2 ,
.Xr issetugid 2 ,
.Xr setgid 2 ,
.Xr setreuid 2 ,
.Xr setuid 2
.Sh STANDARDS
The
.Fn geteuid
and
.Fn getuid
function calls are expected to conform to
.St -p1003.1-90 .
.Sh HISTORY
A
.Fn getuid
and a
.Fn geteuid
function call appeared in
.At v7 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1980, 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.`
			`.\"`
			`.\" @(#)getuid.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt GETUID 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm getuid ,`
			`.Nm geteuid`
			`.Nd get user identification`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
			`.In sys/types.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft uid_t`
			`.Fn getuid void`
			`.Ft uid_t`
			`.Fn geteuid void`
			`.Sh DESCRIPTION`
			`The`
			`.Fn getuid`
			`function returns the real user ID of the calling process.`
			`The`
			`.Fn geteuid`
			`function`
			`returns the effective user ID of the calling process.`
			`.Pp`
			`The real user ID is that of the user who has invoked the program.`
			`As the effective user ID`
			`gives the process additional permissions during`
			`execution of`
			`.Dq Em set-user-ID`
			`mode processes,`
			`.Fn getuid`
			`is used to determine the real-user-id of the calling process.`
			`.Sh ERRORS`
			`The`
			`.Fn getuid`
			`and`
			`.Fn geteuid`
			`functions are always successful, and no return value is reserved to`
			`indicate an error.`
			`.Sh SEE ALSO`
			`.Xr getgid 2 ,`
Xref the new issetugid(2) man page where appropriate. Also add additional set*id(2) xrefs where appropriate. 1997-04-01 18:58:38 +00:00			`.Xr issetugid 2 ,`
			`.Xr setgid 2 ,`
			`.Xr setreuid 2 ,`
			`.Xr setuid 2`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh STANDARDS`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`The`
			`.Fn geteuid`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`and`
			`.Fn getuid`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`function calls are expected to conform to`
upgrade STANDARDS from POSIX 1003.1-88 to 1003.1-90 using .St macro use ``is expected to conform to'' phrase, not ``conforms to'' Pointed out by: Bruce->NIST-PCTS 1996-12-02 20:03:58 +00:00			`.St -p1003.1-90 .`
function appeared in Version 7 AT&T UNIX Obtained from: ftp://netlib.att.com/netlib/att/cs/v7man/man2 1996-08-29 21:24:19 +00:00			`.Sh HISTORY`
			`A`
			`.Fn getuid`
			`and a`
			`.Fn geteuid`
			`function call appeared in`
			`.At v7 .`