freebsd-skq/usr.bin/ruptime/ruptime.1

.\" Copyright (c) 1983, 1990, 1993, 1994
.\"	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.
.\" 3. 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.
.\"
.\"     @(#)ruptime.1	8.2 (Berkeley) 4/5/94
.\" $FreeBSD$
.\"
.Dd August 8, 2017
.Dt RUPTIME 1
.Os
.Sh NAME
.Nm ruptime
.Nd show host status of local machines
.Sh SYNOPSIS
.Nm
.Op Fl alrtu
.Op Ar host ...
.Sh DESCRIPTION
The
.Nm
utility gives a status line like
.Xr uptime 1
for each machine on the local network; these are formed from packets
broadcast by each host on the network once every three minutes.
.Pp
If no operands are given,
.Nm
displays uptime status for all machines;
otherwise only those hosts specified on the command line are displayed.
If hosts are specified on the command line, the sort order is equivalent
to the order hosts were specified on the command line.
.Pp
Machines for which no status report has been received for 11
minutes are shown as being down, and machines for which no status
report has been received for 4 days are not shown in the list at all.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a
Include all users.
By default, if a user has not typed to the system for
an hour or more, then the user will be omitted from the output.
.It Fl l
Sort by load average.
.It Fl r
Reverse the sort order.
.It Fl t
Sort by uptime.
.It Fl u
Sort by number of users.
.El
.Pp
The default listing is sorted by host name.
.Sh FILES
.Bl -tag -width /var/rwho/whod.* -compact
.It Pa /var/rwho/whod.*
data files
.El
.Sh SEE ALSO
.Xr rwho 1 ,
.Xr uptime 1 ,
.Xr rwhod 8
.Sh HISTORY
A
.Nm
utility appeared in
.Bx 4.2 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1983, 1990, 1993, 1994`
			`.\" 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.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" 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.`
			`.\"`
			`.\" @(#)ruptime.1 8.2 (Berkeley) 4/5/94`
$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			`.\"`
Update manpage date to when the deprecation notice was removed. Reported by: bcr 2017-10-27 21:48:02 +00:00			`.Dd August 8, 2017`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt RUPTIME 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 ruptime`
			`.Nd show host status of local machines`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl alrtu`
Add functionality to only list hosts specified on the command line. If none are specified the old behaviour is old. The submitted applied a much cleaner diff to ruptime.c, however it did not cover cases like listing failures. It would probably be a good idea to move the printing from the ruptime function, and have that function just be used to build the list, as that would unbreak sorting, but this diff is intended to be clear, relative to the original code. As the sort order is the order specified on the command line, for now, such is documented in the manual page accordingly. Submitted by: Edward J. M. Blocklesby <ejb@lythe.org.uk> MFC after: 3 weeks 2003-03-01 23:09:26 +00:00			`.Op Ar host ...`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility gives a status line like`
Do not dot terminate err() string. Cross reference using .Xr 2000-03-26 14:50:56 +00:00			`.Xr uptime 1`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`for each machine on the local network; these are formed from packets`
Specify that `ruptime' data is broadcast once every three minutes, not once every minute. PR: docs/13130 Submitted by: Ben Smithurst <ben@scientia.demon.co.uk> 1999-08-14 01:04:10 +00:00			`broadcast by each host on the network once every three minutes.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
Add functionality to only list hosts specified on the command line. If none are specified the old behaviour is old. The submitted applied a much cleaner diff to ruptime.c, however it did not cover cases like listing failures. It would probably be a good idea to move the printing from the ruptime function, and have that function just be used to build the list, as that would unbreak sorting, but this diff is intended to be clear, relative to the original code. As the sort order is the order specified on the command line, for now, such is documented in the manual page accordingly. Submitted by: Edward J. M. Blocklesby <ejb@lythe.org.uk> MFC after: 3 weeks 2003-03-01 23:09:26 +00:00			`If no operands are given,`
			`.Nm`
			`displays uptime status for all machines;`
			`otherwise only those hosts specified on the command line are displayed.`
			`If hosts are specified on the command line, the sort order is equivalent`
			`to the order hosts were specified on the command line.`
			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Machines for which no status report has been received for 11`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`minutes are shown as being down, and machines for which no status`
Document that hosts for which no status report has been received for 4 days are considered to have LEFT_EARTH(), and will not be shown in the list. PR: docs/14299 Submitted by: Ben Smithurst <ben@scientia.demon.co.uk> 1999-11-01 19:42:02 +00:00			`report has been received for 4 days are not shown in the list at all.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width Ds`
			`.It Fl a`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`Include all users.`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`By default, if a user has not typed to the system for`
Do not dot terminate err() string. Cross reference using .Xr 2000-03-26 14:50:56 +00:00			`an hour or more, then the user will be omitted from the output.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl l`
			`Sort by load average.`
			`.It Fl r`
Do not dot terminate err() string. Cross reference using .Xr 2000-03-26 14:50:56 +00:00			`Reverse the sort order.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl t`
			`Sort by uptime.`
			`.It Fl u`
			`Sort by number of users.`
			`.El`
			`.Pp`
			`The default listing is sorted by host name.`
			`.Sh FILES`
			`.Bl -tag -width /var/rwho/whod.* -compact`
			`.It Pa /var/rwho/whod.*`
			`data files`
			`.El`
			`.Sh SEE ALSO`
add missing comma(s) in .Xr macros 1996-09-23 22:24:39 +00:00			`.Xr rwho 1 ,`
Mention rwhod(8) in the SEE ALSO section 1999-08-21 20:26:59 +00:00			`.Xr uptime 1 ,`
			`.Xr rwhod 8`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`A`
			`.Nm`
			`utility appeared in`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Bx 4.2 .`