Merge branch 'vendor/BMAKE'
[dragonfly.git] / usr.bin / who / who.1
1 .\"     $NetBSD: who.1,v 1.21 2007/01/17 16:37:41 christos Exp $
2 .\"
3 .\" Copyright (c) 1986, 1991, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)who.1       8.2 (Berkeley) 12/30/93
31 .\"
32 .Dd January 17, 2007
33 .Dt WHO 1
34 .Os
35 .Sh NAME
36 .Nm who
37 .Nd display who is logged in
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl abdHlmqrstTuv
41 .Op Ar file
42 .Nm
43 .Ar am i
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility displays a list of all users currently logged on, showing for
48 each user the login name, tty name, the date and time of login, and
49 hostname if not local.
50 .Pp
51 Available options:
52 .Bl -tag -width file
53 .It Fl a
54 Same as
55 .Fl bdlprTtuv .
56 .It Fl b
57 Time of last system boot.
58 .It Fl d
59 Print dead processes.
60 .It Fl H
61 Write column headings above the regular output.
62 .It Fl l
63 Print system login processes.
64 .It Fl m
65 Only print information about the current terminal.
66 This is the
67 .Tn POSIX
68 way of saying
69 .Nm
70 .Ar am i .
71 .It Fl p
72 Print active processes spawned by
73 .Xr init 8 .
74 .It Fl q
75 .Dq Quick mode :
76 List only the names and the number of users currently logged on.
77 When this option is used, all other options are ignored.
78 .It Fl r
79 Print the current runlevel.
80 Supported runlevels are:
81 .Bl -tag -width "s (SINGLE_USER)"
82 .It Dv d Pq Dv DEATH
83 The system has halted.
84 .It Dv s Pq Dv SINGLE_USER
85 The system is running in single user mode.
86 .It Dv r Pq Dv RUNCOM
87 The system is executing
88 .Pa /etc/rc .
89 .It Dv t Pq Dv READ_TTYS
90 The system is processing
91 .Pa /etc/ttys .
92 .It Dv m Pq Dv MULTI_USER
93 The system is running in multi-user mode.
94 .It Dv T Pq Dv CLEAN_TTYS
95 The system is in the process of stopping processes
96 associated with terminal devices.
97 .It Dv c Pq Dv CATATONIA
98 The system is in the process of shutting down and will
99 not create new processes.
100 .El
101 .It Fl s
102 List only the name, line and time fields.
103 This is the default.
104 .It Fl T
105 Print a character after the user name indicating the state of the
106 terminal line:
107 .Sq +
108 if the terminal is writable;
109 .Sq -
110 if it is not;
111 and
112 .Sq \&?
113 if a bad line is encountered.
114 .It Fl t
115 Print last system clock change.
116 .It Fl u
117 Print the idle time for each user, and the associated process ID.
118 .It Fl v
119 When printing of more information is requested with
120 .Fl u ,
121 this switch can be used to also printed
122 process termination signals,
123 process exit status,
124 session id for windowing
125 and the type of the entry, see documentation of ut_type in
126 .Xr getutxent 3 .
127 .It Ar \&am I
128 Returns the invoker's real user name.
129 .It Ar file
130 By default,
131 .Nm
132 gathers information from the file
133 .Pa /var/run/utmpx .
134 An alternative
135 .Ar file
136 may be specified which is usually
137 .Pa /var/log/wtmpx
138 (or
139 .Pa /var/log/wtmp ,
140 or
141 .Pa /var/log/wtmpx.[0-6]
142 or
143 .Pa /var/log/wtmp.[0-6]
144 depending on site policy as
145 .Pa wtmpx
146 can grow quite large and daily versions may or may not
147 be kept around after compression by
148 .Xr ac 8 ) .
149 The
150 .Pa wtmpx
151 and
152 .Pa wtmp
153 file contains a record of every login, logout,
154 crash, shutdown and date change
155 since
156 .Pa wtmpx
157 and
158 .Pa wtmp
159 were last truncated or
160 created.
161 .El
162 .Pp
163 If
164 .Pa /var/log/wtmpx
165 or
166 .Pa /var/log/wtmp
167 are being used as the file, the user name may be empty
168 or one of the special characters '|', '}' and '~'.
169 Logouts produce an output line without any user name.
170 For more information on the
171 special characters, see
172 .Xr utmp 5 .
173 .Sh FILES
174 .Bl -tag -width /var/log/wtmp.[0-6] -compact
175 .It Pa /var/run/utmp
176 .It Pa /var/run/utmpx
177 .It Pa /var/log/wtmp
178 .It Pa /var/log/wtmp.[0-6]
179 .It Pa /var/log/wtmpx
180 .It Pa /var/log/wtmpx.[0-6]
181 .El
182 .Sh SEE ALSO
183 .Xr last 1 ,
184 .Xr mesg 1 ,
185 .Xr users 1 ,
186 .Xr getuid 2 ,
187 .Xr utmp 5 ,
188 .Xr utmpx 5
189 .Sh STANDARDS
190 The
191 .Nm
192 utility is expected to conform to
193 .St -p1003.2-92 .
194 .Sh HISTORY
195 A
196 .Nm
197 utility appeared in
198 .At v6 .