[apple/shell_cmds.git] / 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: src/usr.bin/w/w.1,v 1.20 2005/02/13 22:25:25 ru Exp $
.\"
.Dd June 6, 1993
.Dt W 1
.Os
.Sh NAME
.Nm w
.Nd "display who is logged in and what they are doing"
.Sh SYNOPSIS
.Nm
.Op Fl hin
.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 Ds
.It Fl h
Suppress the heading.
.It Fl i
Output is sorted by idle time.
.El
.Pp
If one or more
.Ar user
names are specified, the output is restricted to those users.
.Sh COMPATIBILITY
The
.Fl M ,
.FL N ,
.Fl d ,
.Fl f ,
.Fl l ,
.Fl n ,
.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
.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 ``the highest numbered process on the terminal
that is not ignoring interrupts, or, if there is none, the highest numbered
process on the terminal''.
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
.Dq \- . )
.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.
.Pp
Long hostnames and IPv6 addresses may be truncated; however, the
.Xr who 1
utility will display full hostnames.
Commit	Line	Data
44bd5ea7 A	1	.\" Copyright (c) 1980, 1990, 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.
44bd5ea7 A	12	.\" 4. Neither the name of the University nor the names of its contributors
	13	.\" may be used to endorse or promote products derived from this software
	14	.\" without specific prior written permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
	28	.\" @(#)w.1 8.1 (Berkeley) 6/6/93
e1a085ba	29	.\" $FreeBSD: src/usr.bin/w/w.1,v 1.20 2005/02/13 22:25:25 ru Exp $
44bd5ea7 A	30	.\"
	31	.Dd June 6, 1993
	32	.Dt W 1
9bafe280	33	.Os
44bd5ea7 A	34	.Sh NAME
44bd5ea7 A	35	.Nm w
9bafe280	36	.Nd "display who is logged in and what they are doing"
44bd5ea7 A	37	.Sh SYNOPSIS
44bd5ea7 A	38	.Nm
e1a085ba	39	.Op Fl hin
9bafe280	40	.Op Ar user ...
44bd5ea7 A	41	.Sh DESCRIPTION
	42	The
	43	.Nm
	44	utility prints a summary of the current activity on the system,
	45	including what each user is doing.
	46	The first line displays the current time of day, how long the system has
	47	been running, the number of users logged into the system, and the load
	48	averages.
	49	The load average numbers give the number of jobs in the run queue averaged
	50	over 1, 5 and 15 minutes.
	51	.Pp
	52	The fields output are the user's login name, the name of the terminal the
	53	user is on, the host from which the user is logged in, the time the user
	54	logged on, the time since the user last typed anything,
	55	and the name and arguments of the current process.
	56	.Pp
	57	The options are as follows:
	58	.Bl -tag -width Ds
	59	.It Fl h
	60	Suppress the heading.
	61	.It Fl i
	62	Output is sorted by idle time.
44bd5ea7 A	63	.El
44bd5ea7 A	64	.Pp
9bafe280	65	If one or more
44bd5ea7	66	.Ar user
9bafe280	67	names are specified, the output is restricted to those users.
e1a085ba A	68	.Sh COMPATIBILITY
	69	The
	70	.Fl M ,
	71	.FL N ,
	72	.Fl d ,
	73	.Fl f ,
	74	.Fl l ,
	75	.Fl n ,
	76	.Fl s ,
	77	and
	78	.Fl w
	79	flags are no longer supported.
44bd5ea7	80	.Sh SEE ALSO
44bd5ea7 A	81	.Xr finger 1 ,
44bd5ea7 A	82	.Xr ps 1 ,
9bafe280 A	83	.Xr uptime 1 ,
9bafe280 A	84	.Xr who 1
e1a085ba A	85	.Sh HISTORY
	86	The
	87	.Nm
	88	command appeared in
	89	.Bx 3.0 .
44bd5ea7 A	90	.Sh BUGS
	91	The notion of the
	92	.Dq current process
	93	is muddy.
	94	The current algorithm is ``the highest numbered process on the terminal
	95	that is not ignoring interrupts, or, if there is none, the highest numbered
	96	process on the terminal''.
	97	This fails, for example, in critical sections of programs like the shell
	98	and editor, or when faulty programs running in the background fork and fail
	99	to ignore interrupts.
	100	(In cases where no process can be found,
	101	.Nm
	102	prints
	103	.Dq \- . )
	104	.Pp
	105	The
	106	.Tn CPU
	107	time is only an estimate, in particular, if someone leaves a background
	108	process running after logging out, the person currently on that terminal is
	109	.Dq charged
	110	with the time.
	111	.Pp
	112	Background processes are not shown, even though they account for
	113	much of the load on the system.
	114	.Pp
	115	Sometimes processes, typically those in the background, are printed with
	116	null or garbaged arguments.
	117	In these cases, the name of the command is printed in parentheses.
	118	.Pp
9bafe280	119	The
44bd5ea7 A	120	.Nm
	121	utility does not know about the new conventions for detection of background
	122	jobs.
	123	It will sometimes find a background job instead of the right one.
ddb4a88b A	124	.Pp
	125	Long hostnames and IPv6 addresses may be truncated; however, the
	126	.Xr who 1
	127	utility will display full hostnames.