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