lib/libc/sys/getuid.2

   1 .\" Copyright (c) 1980, 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 .\"     @(#)getuid.2    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/getuid.2,v 1.7.2.4 2001/12/14 18:34:00 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt GETUID 2
  37 .Os
  38 .Sh NAME
  39 .Nm getuid ,
  40 .Nm geteuid
  41 .Nd get user identification
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .In sys/types.h
  47 .Ft uid_t
  48 .Fn getuid void
  49 .Ft uid_t
  50 .Fn geteuid void
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getuid
  54 function returns the real user ID of the calling process.
  55 The
  56 .Fn geteuid
  57 function
  58 returns the effective user ID of the calling process.
  59 .Pp
  60 The real user ID is that of the user who has invoked the program.
  61 As the effective user ID
  62 gives the process additional permissions during
  63 execution of
  64 .Dq Em set-user-ID
  65 mode processes,
  66 .Fn getuid
  67 is used to determine the real-user-id of the calling process.
  68 .Sh ERRORS
  69 The
  70 .Fn getuid
  71 and
  72 .Fn geteuid
  73 functions are always successful, and no return value is reserved to
  74 indicate an error.
  75 .Sh SEE ALSO
  76 .Xr getgid 2 ,
  77 .Xr issetugid 2 ,
  78 .Xr setgid 2 ,
  79 .Xr setreuid 2 ,
  80 .Xr setuid 2
  81 .Sh STANDARDS
  82 The
  83 .Fn geteuid
  84 and
  85 .Fn getuid
  86 function calls are expected to conform to
  87 .St -p1003.1-90 .
  88 .Sh HISTORY
  89 A
  90 .Fn getuid
  91 and a
  92 .Fn geteuid
  93 function call appeared in
  94 .At v7 .