freebsd-dev/usr.bin/w/w.1

.\" Copyright (c) 1980, 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)w.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd November 5, 2014
.Dt W 1
.Os
.Sh NAME
.Nm w
.Nd "display who is logged in and what they are doing"
.Sh SYNOPSIS
.Nm
.Op Fl -libxo
.Op Fl dhin
.Op Fl M Ar core
.Op Fl N Ar system
.Op Ar user ...
.Sh DESCRIPTION
The
.Nm
utility prints a summary of the current activity on the system,
including what each user is doing.
The first line displays the current time of day, how long the system has
been running, the number of users logged into the system, and the load
averages.
The load average numbers give the number of jobs in the run queue averaged
over 1, 5 and 15 minutes.
.Pp
The fields output are the user's login name, the name of the terminal the
user is on, the host from which the user is logged in, the time the user
logged on, the time since the user last typed anything,
and the name and arguments of the current process.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl d
dumps out the entire process list on a per controlling
tty basis, instead of just the top level process.
.It Fl h
Suppress the heading.
.It Fl i
Output is sorted by idle time.
.It Fl M
Extract values associated with the name list from the specified
core instead of the default
.Pa /dev/kmem .
.It Fl N
Extract the name list from the specified system instead of the
default
.Pa /boot/kernel/kernel .
.It Fl n
Do not attempt to resolve network addresses (normally
.Nm
interprets addresses and attempts to display them as names).
.El
.Pp
If one or more
.Ar user
names are specified, the output is restricted to those users.
.Sh FILES
.Bl -tag -width ".Pa /var/run/utx.active" -compact
.It Pa /var/run/utx.active
list of users on the system
.El
.Sh COMPATIBILITY
The
.Fl f ,
.Fl l ,
.Fl s ,
and
.Fl w
flags are no longer supported.
.Sh SEE ALSO
.Xr finger 1 ,
.Xr ps 1 ,
.Xr uptime 1 ,
.Xr who 1 ,
.Xr libxo 3 ,
.Xr xo_parse_args 3
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
.Sh BUGS
The notion of the
.Dq current process
is muddy.
The current algorithm is
.Do
the highest numbered process on the terminal
that is not ignoring interrupts, or, if there is none, the highest numbered
process on the terminal
.Dc .
This fails, for example, in critical sections of programs like the shell
and editor, or when faulty programs running in the background fork and fail
to ignore interrupts.
(In cases where no process can be found,
.Nm
prints
.Ql \- . )
.Pp
The
.Tn CPU
time is only an estimate, in particular, if someone leaves a background
process running after logging out, the person currently on that terminal is
.Dq charged
with the time.
.Pp
Background processes are not shown, even though they account for
much of the load on the system.
.Pp
Sometimes processes, typically those in the background, are printed with
null or garbaged arguments.
In these cases, the name of the command is printed in parentheses.
.Pp
The
.Nm
utility does not know about the new conventions for detection of background
jobs.
It will sometimes find a background job instead of the right one.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1980, 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)w.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Document that w(1) supports libxo(3). 2014-11-05 23:59:52 +00:00			`.Dd November 5, 2014`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt W 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm w`
Reword using who.1 as a good example of where to start. Submitted by: bde 1998-03-22 17:39:08 +00:00			`.Nd "display who is logged in and what they are doing"`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Document that w(1) supports libxo(3). 2014-11-05 23:59:52 +00:00			`.Op Fl -libxo`
Document newly added -d option and fix usage string 1997-09-12 02:26:12 +00:00			`.Op Fl dhin`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl M Ar core`
			`.Op Fl N Ar system`
New w ability: you can list multiple users on the command line and it will match with all of them, rather than only supporting a single user. PR: 11121 Kinda submitted by: James Howard <howardjp@byzantine.student.umd.edu> Reviewed by: DES 1999-07-28 19:29:46 +00:00			`.Op Ar user ...`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
Typo in usage(). Err -> errx when testing allocations. 1997-08-25 06:42:19 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility prints a summary of the current activity on the system,`
			`including what each user is doing.`
			`The first line displays the current time of day, how long the system has`
			`been running, the number of users logged into the system, and the load`
			`averages.`
			`The load average numbers give the number of jobs in the run queue averaged`
			`over 1, 5 and 15 minutes.`
			`.Pp`
			`The fields output are the user's login name, the name of the terminal the`
			`user is on, the host from which the user is logged in, the time the user`
			`logged on, the time since the user last typed anything,`
			`and the name and arguments of the current process.`
			`.Pp`
			`The options are as follows:`
Fix markup. 2006-12-14 19:02:48 +00:00			`.Bl -tag -width indent`
Document newly added -d option and fix usage string 1997-09-12 02:26:12 +00:00			`.It Fl d`
			`dumps out the entire process list on a per controlling`
			`tty basis, instead of just the top level process.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl h`
			`Suppress the heading.`
			`.It Fl i`
			`Output is sorted by idle time.`
			`.It Fl M`
			`Extract values associated with the name list from the specified`
			`core instead of the default`
Fix markup. 2006-12-14 19:02:48 +00:00			`.Pa /dev/kmem .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl N`
			`Extract the name list from the specified system instead of the`
			`default`
Fix markup. 2006-12-14 19:02:48 +00:00			`.Pa /boot/kernel/kernel .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl n`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`Do not attempt to resolve network addresses (normally`
Typo in usage(). Err -> errx when testing allocations. 1997-08-25 06:42:19 +00:00			`.Nm`
When -n is specified, don't attempt to turn hostnames found in utmp into addresses as we have no idea what address family they belong to. When -n is not specified, resolve IPv6 as well as IPv4 addresses found in the host field of utmp. Use realhostname_sa() to resolve addresses (the old code was wrong). Rename ``x'' to ``x_suffix'' to avoid confusion. Hard code the host column width to 16 (against the imminent increase of UT_HOSTSIZE in utmp.h). 2001-07-26 19:20:13 +00:00			`interprets addresses and attempts to display them as names).`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
			`.Pp`
New w ability: you can list multiple users on the command line and it will match with all of them, rather than only supporting a single user. PR: 11121 Kinda submitted by: James Howard <howardjp@byzantine.student.umd.edu> Reviewed by: DES 1999-07-28 19:29:46 +00:00			`If one or more`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ar user`
New w ability: you can list multiple users on the command line and it will match with all of them, rather than only supporting a single user. PR: 11121 Kinda submitted by: James Howard <howardjp@byzantine.student.umd.edu> Reviewed by: DES 1999-07-28 19:29:46 +00:00			`names are specified, the output is restricted to those users.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh FILES`
Remove stale references to utmp(5) and its corresponding filenames. I removed utmp and its manpage, but not other manpages referring to it. 2010-01-21 17:25:12 +00:00			`.Bl -tag -width ".Pa /var/run/utx.active" -compact`
			`.It Pa /var/run/utx.active`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`list of users on the system`
			`.El`
Sort sections. 2005-01-18 13:43:56 +00:00			`.Sh COMPATIBILITY`
			`The`
			`.Fl f ,`
			`.Fl l ,`
			`.Fl s ,`
			`and`
			`.Fl w`
			`flags are no longer supported.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
			`.Xr finger 1 ,`
			`.Xr ps 1 ,`
Sort cross references. 1997-01-15 23:25:55 +00:00			`.Xr uptime 1 ,`
Sort the references in "SEE ALSO" by section first; then alphabetically. Pointed out by: brueffer@ 2014-11-06 16:17:41 +00:00			`.Xr who 1 ,`
			`.Xr libxo 3 ,`
			`.Xr xo_parse_args 3`
Sort sections. 2005-01-18 13:43:56 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 3.0 .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh BUGS`
			`The notion of the`
			`.Dq current process`
			`is muddy.`
Fix markup. 2006-12-14 19:02:48 +00:00			`The current algorithm is`
			`.Do`
			`the highest numbered process on the terminal`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`that is not ignoring interrupts, or, if there is none, the highest numbered`
Fix markup. 2006-12-14 19:02:48 +00:00			`process on the terminal`
			`.Dc .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`This fails, for example, in critical sections of programs like the shell`
			`and editor, or when faulty programs running in the background fork and fail`
			`to ignore interrupts.`
			`(In cases where no process can be found,`
Typo in usage(). Err -> errx when testing allocations. 1997-08-25 06:42:19 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`prints`
Fix markup. 2006-12-14 19:02:48 +00:00			`.Ql \- . )`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
			`The`
			`.Tn CPU`
			`time is only an estimate, in particular, if someone leaves a background`
			`process running after logging out, the person currently on that terminal is`
			`.Dq charged`
			`with the time.`
			`.Pp`
			`Background processes are not shown, even though they account for`
			`much of the load on the system.`
			`.Pp`
			`Sometimes processes, typically those in the background, are printed with`
			`null or garbaged arguments.`
			`In these cases, the name of the command is printed in parentheses.`
			`.Pp`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`The`
Typo in usage(). Err -> errx when testing allocations. 1997-08-25 06:42:19 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility does not know about the new conventions for detection of background`
			`jobs.`
			`It will sometimes find a background job instead of the right one.`