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