Merge branch 'vendor/LIBPCAP' (early part)
[dragonfly.git] / usr.bin / who / who.1
1 .\" Copyright (c) 1986, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)who.1       8.2 (Berkeley) 12/30/93
33 .\" $FreeBSD: src/usr.bin/who/who.1,v 1.7.2.5 2003/02/24 23:04:40 trhodes Exp $
34 .\" $DragonFly: src/usr.bin/who/who.1,v 1.3 2004/10/29 17:09:09 liamfoy Exp $
35 .\"
36 .Dd October 25, 2004
37 .Dt WHO 1
38 .Os
39 .Sh NAME
40 .Nm who
41 .Nd display who is on the system
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl bHmqsTu
45 .Op Cm am I
46 .Op Ar file
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility displays information about currently logged in users.
51 By default, this includes the login name, tty name, date and time of login and
52 remote hostname if not local.
53 .Pp
54 The options are as follows:
55 .Bl -tag -width indent
56 .It Fl b
57 Show date and time of last reboot.
58 .It Fl H
59 Write column headings above the output.
60 .It Fl m
61 Show information about the terminal attached to standard input only.
62 .It Fl q
63 .Dq "Quick mode" :
64 List the names and number of logged in users in columns.
65 All other command line options are ignored.
66 .It Fl s
67 Show the name, line and time fields only.
68 This is the default.
69 .It Fl T
70 Indicate whether each user is accepting messages.
71 One of the following characters is written:
72 .Pp
73 .Bl -tag -width 1n -compact
74 .It Li +
75 User is accepting messages.
76 .It Li \&-
77 User is not accepting messages.
78 .It Li \&?
79 An error occurred.
80 .El
81 .It Fl u
82 Show idle time for each user in hours and minutes as
83 .Ar hh Ns : Ns Ar mm ,
84 .Ql \&.
85 if the user has been idle less that a minute, and
86 .Dq Li old
87 if the user has been idle more than 24 hours.
88 .It Cm am I
89 Equivalent to
90 .Fl m .
91 .El
92 .Pp
93 By default,
94 .Nm
95 gathers information from the file
96 .Pa /var/run/utmp .
97 An alternate
98 .Ar file
99 may be specified which is usually
100 .Pa /var/log/wtmp
101 (or
102 .Pa /var/log/wtmp.[0-6]
103 depending on site policy as
104 .Pa wtmp
105 can grow quite large and daily versions may or may not
106 be kept around after compression by
107 .Xr ac 8 ) .
108 The
109 .Pa wtmp
110 file contains a record of every login, logout,
111 crash, shutdown and date change
112 since
113 .Pa wtmp
114 was last truncated or
115 created.
116 .Pp
117 If
118 .Pa /var/log/wtmp
119 is being used as the file, the user name may be empty
120 or one of the special characters '|', '}' and '~'.  Logouts produce
121 an output line without any user name.  For more information on the
122 special characters, see
123 .Xr utmp 5 .
124 .Sh ENVIRONMENT
125 The
126 .Ev COLUMNS , LANG , LC_ALL
127 and
128 .Ev LC_TIME
129 environment variables affect the execution of
130 .Nm
131 as described in
132 .Xr environ 7 .
133 .Sh FILES
134 .Bl -tag -width /var/log/wtmp.[0-6] -compact
135 .It Pa /var/run/utmp
136 .It Pa /var/log/wtmp
137 .It Pa /var/log/wtmp.[0-6]
138 .El
139 .Sh EXIT STATUS
140 .Ex -std
141 .Sh SEE ALSO
142 .Xr last 1 ,
143 .Xr users 1 ,
144 .Xr w 1 ,
145 .Xr utmp 5
146 .Sh STANDARDS
147 The
148 .Nm
149 utility conforms to
150 .St -p1003.1-2001 .
151 .Sh HISTORY
152 A
153 .Nm
154 command appeared in
155 .At v1 .