xref: /openbsd/usr.bin/rup/rup.1 (revision 09467b48)
1.\"	$OpenBSD: rup.1,v 1.14 2014/04/24 15:03:04 tedu Exp $
2.\"
3.\" Copyright (c) 1985, 1991 The Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"
31.Dd $Mdocdate: April 24 2014 $
32.Dt RUP 1
33.Os
34.Sh NAME
35.Nm rup
36.Nd remote status display
37.Sh SYNOPSIS
38.Nm rup
39.Op Fl dhlt
40.Op Ar host ...
41.Sh DESCRIPTION
42.Nm
43displays a summary of the current system status of a particular
44.Ar host
45or all hosts on the local network.
46The output shows the current time of day, how long the system has
47been up,
48and the load averages.
49The load average numbers give the number of jobs in the run queue
50averaged over 1, 5, and 15 minutes.
51.Pp
52The options are as follows:
53.Bl -tag -width Ds
54.It Fl d
55For each host, report what its local time is.
56This is useful for checking time synchronization on a network.
57.It Fl h
58Sort the display alphabetically by host name.
59.It Fl l
60Sort the display by load average.
61.It Fl t
62Sort the display by up time.
63.El
64.Pp
65The
66.Xr rpc.rstatd 8
67daemon must be running on the remote host for this command to
68work.
69.Nm
70uses an RPC protocol defined in
71.Pa /usr/include/rpcsvc/rstat.x .
72.Sh EXAMPLES
73.Bd -literal -offset indent
74$ rup otherhost
75otherhost      up 6 days, 16:45,  load average: 0.20, 0.23, 0.18
76.Ed
77.Sh DIAGNOSTICS
78.Bl -diag
79.It rup: RPC: Program not registered
80The
81.Xr rpc.rstatd 8
82daemon has not been started on the remote host.
83.It rup: RPC: Timed out
84A communication error occurred.
85Either the network is excessively congested, or the
86.Xr rpc.rstatd 8
87daemon has terminated on the remote host.
88.It rup: RPC: Port mapper failure - RPC: Timed out
89The remote host is not running the portmapper (see
90.Xr portmap 8 ) ,
91and cannot accommodate any RPC-based services.
92The host may be down.
93.El
94.Sh SEE ALSO
95.Xr portmap 8 ,
96.Xr rpc.rstatd 8
97.Sh HISTORY
98The
99.Nm
100command
101appeared in SunOS.
102