]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.bin/id/id.1
Remove the advertising clause from UCB copyrighted files in usr.bin. This
[FreeBSD/FreeBSD.git] / 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 .\" 4. 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$
33 .\"
34 .Dd September 26, 2006
35 .Dt ID 1
36 .Os
37 .Sh NAME
38 .Nm id
39 .Nd return user identity
40 .Sh SYNOPSIS
41 .Nm
42 .Op Ar user
43 .Nm
44 .Fl A
45 .Nm
46 .Fl G Op Fl n
47 .Op Ar user
48 .Nm
49 .Fl M
50 .Nm
51 .Fl P
52 .Op Ar user
53 .Nm
54 .Fl g Op Fl nr
55 .Op Ar user
56 .Nm
57 .Fl p
58 .Op Ar user
59 .Nm
60 .Fl u Op Fl nr
61 .Op Ar user
62 .Sh DESCRIPTION
63 The
64 .Nm
65 utility displays the user and group names and numeric IDs, of the
66 calling process, to the standard output.
67 If the real and effective IDs are different, both are displayed,
68 otherwise only the real ID is displayed.
69 .Pp
70 If a
71 .Ar user
72 (login name or user ID)
73 is specified, the user and group IDs of that user are displayed.
74 In this case, the real and effective IDs are assumed to be the same.
75 .Pp
76 The options are as follows:
77 .Bl -tag -width indent
78 .It Fl A
79 Display the process audit user ID and other process audit properties, which
80 requires privilege.
81 .It Fl G
82 Display the different group IDs (effective, real and supplementary)
83 as white-space separated numbers, in no particular order.
84 .It Fl M
85 Display the MAC label of the current process.
86 .It Fl P
87 Display the id as a password file entry.
88 .It Fl a
89 Ignored for compatibility with other
90 .Nm
91 implementations.
92 .It Fl g
93 Display the effective group ID as a number.
94 .It Fl n
95 Display the name of the user or group ID for the
96 .Fl G ,
97 .Fl g
98 and
99 .Fl u
100 options instead of the number.
101 If any of the ID numbers cannot be mapped into names, the number will be
102 displayed as usual.
103 .It Fl p
104 Make the output human-readable.
105 If the user name returned by
106 .Xr getlogin 2
107 is different from the login name referenced by the user ID, the name
108 returned by
109 .Xr getlogin 2
110 is displayed, preceded by the keyword
111 .Dq login .
112 The user ID as a name is displayed, preceded by the keyword
113 .Dq uid .
114 If the effective user ID is different from the real user ID, the real user
115 ID is displayed as a name, preceded by the keyword
116 .Dq euid .
117 If the effective group ID is different from the real group ID, the real group
118 ID is displayed as a name, preceded by the keyword
119 .Dq rgid .
120 The list of groups to which the user belongs is then displayed as names,
121 preceded by the keyword
122 .Dq groups .
123 Each display is on a separate line.
124 .It Fl r
125 Display the real ID for the
126 .Fl g
127 and
128 .Fl u
129 options instead of the effective ID.
130 .It Fl u
131 Display the effective user ID as a number.
132 .El
133 .Sh EXIT STATUS
134 .Ex -std
135 .Sh SEE ALSO
136 .Xr who 1
137 .Sh STANDARDS
138 The
139 .Nm
140 function is expected to conform to
141 .St -p1003.2 .
142 .Sh HISTORY
143 The
144 historic
145 .Xr groups 1
146 command is equivalent to
147 .Dq Nm id Fl Gn Op Ar user .
148 .Pp
149 The
150 historic
151 .Xr whoami 1
152 command is equivalent to
153 .Dq Nm id Fl un .
154 .Pp
155 The
156 .Nm
157 command appeared in
158 .Bx 4.4 .