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