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