usr.bin/id/id.1

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)id.1        8.1 (Berkeley) 6/6/93
  32 .\" $FreeBSD: src/usr.bin/id/id.1,v 1.7.2.3 2001/08/16 13:16:50 ru Exp $
  33 .\" $DragonFly: src/usr.bin/id/id.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
  34 .\"
  35 .Dd August 11, 2021
  36 .Dt ID 1
  37 .Os
  38 .Sh NAME
  39 .Nm id
  40 .Nd return user identity
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Ar user
  44 .Nm
  45 .Fl G Op Fl n
  46 .Op Ar user
  47 .Nm
  48 .Fl P
  49 .Op Ar user
  50 .Nm
  51 .Fl g Op Fl nr
  52 .Op Ar user
  53 .Nm
  54 .Fl p
  55 .Op Ar user
  56 .Nm
  57 .Fl u Op Fl nr
  58 .Op Ar user
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 utility displays the user and group names and numeric IDs, of the
  63 calling process, to the standard output.
  64 If the real and effective IDs are different, both are displayed,
  65 otherwise only the real ID is displayed.
  66 .Pp
  67 If a
  68 .Ar user
  69 (login name or user ID)
  70 is specified, the user and group IDs of that user are displayed.
  71 In this case, the real and effective IDs are assumed to be the same.
  72 .Pp
  73 The options are as follows:
  74 .Bl -tag -width indent
  75 .It Fl G
  76 Display the different group IDs (effective, real and supplementary)
  77 as white-space separated numbers, in no particular order.
  78 .It Fl P
  79 Display the id as a password file entry.
  80 .It Fl a
  81 Ignored for compatibility with other
  82 .Nm
  83 implementations.
  84 .It Fl g
  85 Display the effective group ID as a number.
  86 .It Fl n
  87 Display the name of the user or group ID for the
  88 .Fl G ,
  89 .Fl g
  90 and
  91 .Fl u
  92 options instead of the number.
  93 If any of the ID numbers cannot be mapped into names, the number will be
  94 displayed as usual.
  95 .It Fl p
  96 Make the output human-readable.
  97 If the user name returned by
  98 .Xr getlogin 2
  99 is different from the login name referenced by the user ID, the name
 100 returned by
 101 .Xr getlogin 2
 102 is displayed, preceded by the keyword
 103 .Dq login .
 104 The user ID as a name is displayed, preceded by the keyword
 105 .Dq uid .
 106 If the effective user ID is different from the real user ID, the real user
 107 ID is displayed as a name, preceded by the keyword
 108 .Dq euid .
 109 If the effective group ID is different from the real group ID, the real group
 110 ID is displayed as a name, preceded by the keyword
 111 .Dq rgid .
 112 The list of groups to which the user belongs is then displayed as names,
 113 preceded by the keyword
 114 .Dq groups .
 115 Each display is on a separate line.
 116 .It Fl r
 117 Display the real ID for the
 118 .Fl g
 119 and
 120 .Fl u
 121 options instead of the effective ID.
 122 .It Fl u
 123 Display the effective user ID as a number.
 124 .El
 125 .Sh EXIT STATUS
 126 .Ex -std
 127 .Sh SEE ALSO
 128 .Xr who 1
 129 .Sh STANDARDS
 130 The
 131 .Nm
 132 function is expected to conform to
 133 .St -p1003.2 .
 134 .Sh HISTORY
 135 The
 136 historic
 137 .Xr groups 1
 138 command is equivalent to
 139 .Dq Nm id Fl Gn Op Ar user .
 140 .Pp
 141 The
 142 historic
 143 .Xr whoami 1
 144 command is equivalent to
 145 .Dq Nm id Fl un .
 146 .Pp
 147 The
 148 .Nm
 149 command appeared in
 150 .Bx 4.4 .