Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[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. 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 .\" $FreeBSD: src/usr.bin/rup/rup.1,v 1.20 2007/02/28 10:22:19 ru Exp $
31 .\" $DragonFly: src/usr.bin/rup/rup.1,v 1.2 2003/06/17 04:29:31 dillon Exp $
32 .\"
33 .Dd June 7, 1993
34 .Dt RUP 1
35 .Os
36 .Sh NAME
37 .Nm rup
38 .Nd remote status display
39 .Sh SYNOPSIS
40 .Nm
41 .Op Ar host ...
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility displays a summary of the current system status of a particular
46 .Ar host
47 or all hosts on the local network.
48 The output shows the current time of day, how long the system has
49 been up,
50 and the load averages.
51 The load average numbers give the number of jobs in the run queue
52 averaged over 1, 5 and 15 minutes.
53 .Pp
54 The
55 .Xr rpc.rstatd 8
56 daemon must be running on the remote host for this command to
57 work.
58 The
59 .Nm
60 utility uses an RPC protocol defined in
61 .In rpcsvc/rstat.x .
62 .Sh EXAMPLES
63 .Bd -literal
64 example% rup otherhost
65 otherhost   7:36am  up 6 days, 16:45,  load average: 0.20, 0.23, 0.18
66 example%
67 .Ed
68 .Sh DIAGNOSTICS
69 .Bl -diag
70 .It rup: RPC: Program not registered
71 The
72 .Xr rpc.rstatd 8
73 daemon has not been started on the remote host.
74 .It rup: RPC: Timed out
75 A communication error occurred.
76 Either the network is
77 excessively congested, or the
78 .Xr rpc.rstatd 8
79 daemon has terminated on the remote host.
80 .It rup: RPC: Port mapper failure - RPC: Timed out
81 The remote host is not running the portmapper (see
82 .Xr rpcbind 8 ) ,
83 and cannot accommodate any RPC-based services.
84 The host may be down.
85 .El
86 .Sh SEE ALSO
87 .Xr rpcbind 8 ,
88 .Xr rpc.rstatd 8
89 .Sh HISTORY
90 The
91 .Nm
92 command
93 appeared in
94 .Tn Sun-OS .
95 .Sh BUGS
96 The sorting options are not implemented.