xref: /dragonfly/usr.bin/id/id.1 (revision 7d3e9a5b)
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. 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: src/usr.bin/id/id.1,v 1.7.2.3 2001/08/16 13:16:50 ru Exp $
33.\" $DragonFly: src/usr.bin/id/id.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
34.\"
35.Dd August 11, 2021
36.Dt ID 1
37.Os
38.Sh NAME
39.Nm id
40.Nd return user identity
41.Sh SYNOPSIS
42.Nm
43.Op Ar user
44.Nm
45.Fl G Op Fl n
46.Op Ar user
47.Nm
48.Fl P
49.Op Ar user
50.Nm
51.Fl g Op Fl nr
52.Op Ar user
53.Nm
54.Fl p
55.Op Ar user
56.Nm
57.Fl u Op Fl nr
58.Op Ar user
59.Sh DESCRIPTION
60The
61.Nm
62utility displays the user and group names and numeric IDs, of the
63calling process, to the standard output.
64If the real and effective IDs are different, both are displayed,
65otherwise only the real ID is displayed.
66.Pp
67If a
68.Ar user
69(login name or user ID)
70is specified, the user and group IDs of that user are displayed.
71In this case, the real and effective IDs are assumed to be the same.
72.Pp
73The options are as follows:
74.Bl -tag -width indent
75.It Fl G
76Display the different group IDs (effective, real and supplementary)
77as white-space separated numbers, in no particular order.
78.It Fl P
79Display the id as a password file entry.
80.It Fl a
81Ignored for compatibility with other
82.Nm
83implementations.
84.It Fl g
85Display the effective group ID as a number.
86.It Fl n
87Display the name of the user or group ID for the
88.Fl G ,
89.Fl g
90and
91.Fl u
92options instead of the number.
93If any of the ID numbers cannot be mapped into names, the number will be
94displayed as usual.
95.It Fl p
96Make the output human-readable.
97If the user name returned by
98.Xr getlogin 2
99is different from the login name referenced by the user ID, the name
100returned by
101.Xr getlogin 2
102is displayed, preceded by the keyword
103.Dq login .
104The user ID as a name is displayed, preceded by the keyword
105.Dq uid .
106If the effective user ID is different from the real user ID, the real user
107ID is displayed as a name, preceded by the keyword
108.Dq euid .
109If the effective group ID is different from the real group ID, the real group
110ID is displayed as a name, preceded by the keyword
111.Dq rgid .
112The list of groups to which the user belongs is then displayed as names,
113preceded by the keyword
114.Dq groups .
115Each display is on a separate line.
116.It Fl r
117Display the real ID for the
118.Fl g
119and
120.Fl u
121options instead of the effective ID.
122.It Fl u
123Display the effective user ID as a number.
124.El
125.Sh EXIT STATUS
126.Ex -std
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