]> git.saurik.com Git - apple/shell_cmds.git/blob - id/id.1
shell_cmds-187.tar.gz
[apple/shell_cmds.git] / 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. All advertising materials mentioning features or use of this software
16 .\" must display the following acknowledgement:
17 .\" This product includes software developed by the University of
18 .\" California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\" @(#)id.1 8.1 (Berkeley) 6/6/93
36 .\" $FreeBSD: src/usr.bin/id/id.1,v 1.18 2006/09/26 22:28:12 ceri Exp $
37 .\"
38 .Dd September 26, 2006
39 .Dt ID 1
40 .Os
41 .Sh NAME
42 .Nm id
43 .Nd return user identity
44 .Sh SYNOPSIS
45 .Nm
46 .Op Ar user
47 .Nm
48 .Fl A
49 .Nm
50 .Fl F
51 .Op Ar user
52 .Nm
53 .Fl G Op Fl n
54 .Op Ar user
55 .Nm
56 .Fl M
57 .Nm
58 .Fl P
59 .Op Ar user
60 .Nm
61 .Fl g Op Fl nr
62 .Op Ar user
63 .Nm
64 .Fl p
65 .Op Ar user
66 .Nm
67 .Fl u Op Fl nr
68 .Op Ar user
69 .Sh DESCRIPTION
70 The
71 .Nm
72 utility displays the user and group names and numeric IDs, of the
73 calling process, to the standard output.
74 If the real and effective IDs are different, both are displayed,
75 otherwise only the real ID is displayed.
76 .Pp
77 If a
78 .Ar user
79 (login name or user ID)
80 is specified, the user and group IDs of that user are displayed.
81 In this case, the real and effective IDs are assumed to be the same.
82 .Pp
83 The options are as follows:
84 .Bl -tag -width indent
85 .It Fl A
86 Display the process audit user ID and other process audit properties, which
87 requires privilege.
88 .It Fl F
89 Display the full name of the user.
90 .It Fl G
91 Display the different group IDs (effective, real and supplementary)
92 as white-space separated numbers, in no particular order.
93 .It Fl M
94 Display the MAC label of the current process.
95 .It Fl P
96 Display the id as a password file entry.
97 .It Fl a
98 Ignored for compatibility with other
99 .Nm
100 implementations.
101 .It Fl g
102 Display the effective group ID as a number.
103 .It Fl n
104 Display the name of the user or group ID for the
105 .Fl G ,
106 .Fl g
107 and
108 .Fl u
109 options instead of the number.
110 If any of the ID numbers cannot be mapped into names, the number will be
111 displayed as usual.
112 .It Fl p
113 Make the output human-readable.
114 If the user name returned by
115 .Xr getlogin 2
116 is different from the login name referenced by the user ID, the name
117 returned by
118 .Xr getlogin 2
119 is displayed, preceded by the keyword
120 .Dq login .
121 The user ID as a name is displayed, preceded by the keyword
122 .Dq uid .
123 If the effective user ID is different from the real user ID, the real user
124 ID is displayed as a name, preceded by the keyword
125 .Dq euid .
126 If the effective group ID is different from the real group ID, the real group
127 ID is displayed as a name, preceded by the keyword
128 .Dq rgid .
129 The list of groups to which the user belongs is then displayed as names,
130 preceded by the keyword
131 .Dq groups .
132 Each display is on a separate line.
133 .It Fl r
134 Display the real ID for the
135 .Fl g
136 and
137 .Fl u
138 options instead of the effective ID.
139 .It Fl u
140 Display the effective user ID as a number.
141 .El
142 .Sh EXIT STATUS
143 .Ex -std
144 .Sh SEE ALSO
145 .Xr who 1
146 .Sh STANDARDS
147 The
148 .Nm
149 function is expected to conform to
150 .St -p1003.2 .
151 .Sh HISTORY
152 The
153 historic
154 .Xr groups 1
155 command is equivalent to
156 .Dq Nm id Fl Gn Op Ar user .
157 .Pp
158 The
159 historic
160 .Xr whoami 1
161 command is equivalent to
162 .Dq Nm id Fl un .
163 .Pp
164 The
165 .Nm
166 command appeared in
167 .Bx 4.4 .