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