Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / rup / rup.1
1 .\" -*- nroff -*-
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. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\" $FreeBSD: src/usr.bin/rup/rup.1,v 1.7.2.7 2002/06/21 15:29:00 charnier Exp $
35 .\"
36 .Dd June 7, 1993
37 .Dt RUP 1
38 .Os
39 .Sh NAME
40 .Nm rup
41 .Nd remote status display
42 .Sh SYNOPSIS
43 .Nm
44 .Op Ar host ...
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility displays a summary of the current system status of a particular
49 .Ar host
50 or all hosts on the local network.
51 The output shows the current time of day, how long the system has
52 been up,
53 and the load averages.
54 The load average numbers give the number of jobs in the run queue
55 averaged over 1, 5 and 15 minutes.
56 .Pp
57 The
58 .Xr rpc.rstatd 8
59 daemon must be running on the remote host for this command to
60 work.
61 The
62 .Nm
63 utility uses an RPC protocol defined in
64 .Pa /usr/include/rpcsvc/rstat.x .
65 .Sh EXAMPLES
66 .Bd -literal
67 example% rup otherhost
68 otherhost   7:36am  up 6 days, 16:45,  load average: 0.20, 0.23, 0.18
69 example%
70 .Ed
71 .Sh DIAGNOSTICS
72 .Bl -diag
73 .It rup: RPC: Program not registered
74 The
75 .Xr rpc.rstatd 8
76 daemon has not been started on the remote host.
77 .It rup: RPC: Timed out
78 A communication error occurred.  Either the network is
79 excessively congested, or the
80 .Xr rpc.rstatd 8
81 daemon has terminated on the remote host.
82 .It rup: RPC: Port mapper failure - RPC: Timed out
83 The remote host is not running the portmapper (see
84 .Xr portmap 8 ) ,
85 and cannot accommodate any RPC-based services.  The host may be down.
86 .El
87 .Sh SEE ALSO
88 .Xr portmap 8 ,
89 .Xr rpc.rstatd 8
90 .Sh HISTORY
91 The
92 .Nm
93 command
94 appeared in
95 .Em Sun-OS .
96 .Sh BUGS
97 The sorting options are not implemented.