Initial import from FreeBSD RELENG_4:
[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 .\"
35 .Dd May 8, 2002
36 .Dt WHO 1
37 .Os
38 .Sh NAME
39 .Nm who
40 .Nd display who is on the system
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl HmqsTu
44 .Op Cm am I
45 .Op Ar file
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility displays information about currently logged in users.
50 By default, this includes the login name, tty name, date and time of login and
51 remote hostname if not local.
52 .Pp
53 The options are as follows:
54 .Bl -tag -width indent
55 .It Fl H
56 Write column headings above the output.
57 .It Fl m
58 Show information about the terminal attached to standard input only.
59 .It Fl q
60 .Dq "Quick mode" :
61 List the names and number of logged in users in columns.
62 All other command line options are ignored.
63 .It Fl s
64 Show the name, line and time fields only.
65 This is the default.
66 .It Fl T
67 Indicate whether each user is accepting messages.
68 One of the following characters is written:
69 .Pp
70 .Bl -tag -width 1n -compact
71 .It Li +
72 User is accepting messages.
73 .It Li \&-
74 User is not accepting messages.
75 .It Li \&?
76 An error occurred.
77 .El
78 .It Fl u
79 Show idle time for each user in hours and minutes as
80 .Ar hh Ns : Ns Ar mm ,
81 .Ql \&.
82 if the user has been idle less that a minute, and
83 .Dq Li old
84 if the user has been idle more than 24 hours.
85 .It Cm am I
86 Equivalent to
87 .Fl m .
88 .El
89 .Pp
90 By default,
91 .Nm
92 gathers information from the file
93 .Pa /var/run/utmp .
94 An alternate
95 .Ar file
96 may be specified which is usually
97 .Pa /var/log/wtmp
98 (or
99 .Pa /var/log/wtmp.[0-6]
100 depending on site policy as
101 .Pa wtmp
102 can grow quite large and daily versions may or may not
103 be kept around after compression by
104 .Xr ac 8 ) .
105 The
106 .Pa wtmp
107 file contains a record of every login, logout,
108 crash, shutdown and date change
109 since
110 .Pa wtmp
111 was last truncated or
112 created.
113 .Pp
114 If
115 .Pa /var/log/wtmp
116 is being used as the file, the user name may be empty
117 or one of the special characters '|', '}' and '~'.  Logouts produce
118 an output line without any user name.  For more information on the
119 special characters, see
120 .Xr utmp 5 .
121 .Sh ENVIRONMENT
122 The
123 .Ev COLUMNS , LANG , LC_ALL
124 and
125 .Ev LC_TIME
126 environment variables affect the execution of
127 .Nm
128 as described in
129 .Xr environ 7 .
130 .Sh FILES
131 .Bl -tag -width /var/log/wtmp.[0-6] -compact
132 .It Pa /var/run/utmp
133 .It Pa /var/log/wtmp
134 .It Pa /var/log/wtmp.[0-6]
135 .El
136 .Sh DIAGNOSTICS
137 .Ex -std
138 .Sh SEE ALSO
139 .Xr last 1 ,
140 .Xr users 1 ,
141 .Xr w 1 ,
142 .Xr utmp 5
143 .Sh STANDARDS
144 The
145 .Nm
146 utility conforms to
147 .St -p1003.1-2001 .
148 .Sh HISTORY
149 A
150 .Nm
151 command appeared in
152 .At v1 .