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