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