xref: /freebsd/usr.bin/id/id.1 (revision 9b50d9027575220cb6dd09b3e62f03f511e908b8)
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.\"
37.Dd "June 6, 1993"
38.Dt ID 1
39.Os BSD 4.4
40.Sh NAME
41.Nm id
42.Nd return user identity
43.Sh SYNOPSIS
44.Nm id
45.Op Ar user
46.Nm id
47.Fl G Op Fl n
48.Op Ar user
49.Nm id
50.Fl g Op Fl nr
51.Op Ar user
52.Nm id
53.Fl p
54.Nm id
55.Fl u Op Fl nr
56.Op Ar user
57.Sh DESCRIPTION
58The
59.Nm id
60utility displays the user and group names and numeric IDs, of the
61calling process, to the standard output.
62If the real and effective IDs are different, both are displayed,
63otherwise only the real ID is displayed.
64.Pp
65If a
66.Ar user
67(login name or user ID)
68is specified, the user and group IDs of that user are displayed.
69In this case, the real and effective IDs are assumed to be the same.
70.Pp
71The options are as follows:
72.Bl -tag -width Ds
73.It Fl G
74Display the different group IDs (effective, real and supplementary)
75as white-space separated numbers, in no particular order.
76.It Fl g
77Display the effective group ID as a number.
78.It Fl n
79Display the name of the user or group ID for the
80.Fl G ,
81.Fl g
82and
83.Fl u
84options instead of the number.
85If any of the ID numbers cannot be mapped into names, the number will be
86displayed as usual.
87.It Fl p
88Make the output human-readable.
89If the user name returned by
90.Xr getlogin 2
91is different from the login name referenced by the user ID, the name
92returned by
93.Xr getlogin 2
94is displayed, preceded by the keyword ``login''.
95The user ID as a name is displayed, preceded by the keyword ``uid''.
96If the effective user ID is different from the real user ID, the real user
97ID is displayed as a name, preceded by the keyword ``euid''.
98If the effective group ID is different from the real group ID, the real group
99ID is displayed as a name, preceded by the keyword ``rgid''.
100The list of groups to which the user belongs is then displayed as names,
101preceded by the keyword ``groups''.
102Each display is on a separate line.
103.It Fl r
104Display the real ID for the
105.Fl g
106and
107.Fl u
108options instead of the effective ID.
109.It Fl u
110Display the effective user ID as a number.
111.El
112.Pp
113The
114.Nm id
115utility exits 0 on success, and >0 if an error occurs.
116.Sh SEE ALSO
117.Xr who 1
118.Sh STANDARDS
119The
120.Nm id
121function is expected to conform to
122.St -p1003.2 .
123.Sh HISTORY
124The
125historic
126.Xr groups 1
127command is equivalent to
128.Dq Nm id Fl Gn Op Ar user .
129.Pp
130The
131historic
132.Xr whoami 1
133command is equivalent to
134.Dq Nm id Fl un .
135.Pp
136The
137.Nm
138command appears in
139.Bx 4.4 .
140