usr.sbin/rwhod/rwhod.8

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rwhod.8     8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/usr.sbin/rwhod/rwhod.8,v 1.13.2.4 2003/03/11 22:31:33 trhodes Exp $
  34 .\" $DragonFly: src/usr.sbin/rwhod/rwhod.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
  35 .\"
  36 .Dd December 11, 1993
  37 .Dt RWHOD 8
  38 .Os
  39 .Sh NAME
  40 .Nm rwhod
  41 .Nd system status server
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl i
  45 .Op Fl p
  46 .Op Fl l
  47 .Op Fl m Op Ar ttl
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility is the server which maintains the database used by the
  52 .Xr rwho 1
  53 and
  54 .Xr ruptime 1
  55 programs.  Its operation is predicated on the ability to
  56 .Em broadcast
  57 or
  58 .Em multicast
  59 messages on a network.
  60 .Pp
  61 The
  62 .Nm
  63 utility operates as both a producer and consumer of status information,
  64 unless the
  65 .Fl l
  66 (listen mode) option is specified, in which case
  67 it acts as a consumer only.
  68 As a producer of information it periodically
  69 queries the state of the system and constructs
  70 status messages which are broadcasted or multicasted on a network.
  71 As a consumer of information, it listens for other
  72 .Nm
  73 servers' status messages, validating them, then recording
  74 them in a collection of files located in the directory
  75 .Pa /var/rwho .
  76 .Pp
  77 The
  78 .Fl i
  79 option enables insecure mode, which causes
  80 .Nm
  81 to ignore the source port on incoming packets.
  82 .Pp
  83 The
  84 .Fl p
  85 option tells
  86 .Nm
  87 to ignore all
  88 .Dv POINTOPOINT
  89 interfaces.  This is useful if you do not wish to keep dial on demand
  90 interfaces permanently active.
  91 .Pp
  92 The
  93 .Fl l
  94 option enables listen mode, which causes
  95 .Nm
  96 to not broadcast any information.
  97 This allows you to monitor other machines'
  98 .Nm
  99 information, without broadcasting your own.
 100 .Pp
 101 The
 102 .Fl m
 103 option causes
 104 .Nm
 105 to use IP multicast (instead of
 106 broadcast) on all interfaces that have
 107 the IFF_MULTICAST flag set in their "ifnet" structs
 108 (excluding the loopback interface).  The multicast
 109 reports are sent with a time-to-live of 1, to prevent
 110 forwarding beyond the directly-connected subnet(s).
 111 .Pp
 112 If the optional
 113 .Ar ttl
 114 argument is supplied with the
 115 .Fl m
 116 flag,
 117 .Nm
 118 will send IP multicast datagrams with a
 119 time-to-live of
 120 .Ar ttl ,
 121 via a SINGLE interface rather
 122 than all interfaces.
 123 .Ar ttl
 124 must be between 0 and
 125 32 (or MAX_MULTICAST_SCOPE).  Note that
 126 .Fl m Ar 1
 127 is different from
 128 .Fl m ,
 129 in that
 130 .Fl m Ar 1
 131 specifies transmission on one interface only.
 132 .Pp
 133 When
 134 .Fl m
 135 is used without a
 136 .Ar ttl
 137 argument, the program accepts multicast
 138 .Nm
 139 reports from all multicast-capable interfaces.  If a
 140 .Ar ttl
 141 argument is given, it accepts multicast reports from only one interface, the
 142 one on which reports are sent (which may be controlled via the host's routing
 143 table).  Regardless of the
 144 .Fl m
 145 option, the program accepts broadcast or
 146 unicast reports from all interfaces.  Thus, this program will hear the
 147 reports of old, non-multicasting
 148 .Nm Ns s ,
 149 but, if multicasting is used,
 150 those old
 151 .Nm Ns s
 152 won't hear the reports generated by this program.
 153 .Pp
 154 The server transmits and receives messages at the port indicated
 155 in the ``who'' service specification; see
 156 .Xr services 5 .
 157 The messages sent and received, are of the form:
 158 .Bd -literal -offset indent
 159 struct  outmp {
 160         char    out_line[8];            /* tty name */
 161         char    out_name[8];            /* user id */
 162         long    out_time;               /* time on */
 163 };
 164
 165 struct  whod {
 166         char    wd_vers;
 167         char    wd_type;
 168         char    wd_fill[2];
 169         int     wd_sendtime;
 170         int     wd_recvtime;
 171         char    wd_hostname[32];
 172         int     wd_loadav[3];
 173         int     wd_boottime;
 174         struct  whoent {
 175                 struct  outmp we_utmp;
 176                 int     we_idle;
 177         } wd_we[1024 / sizeof (struct whoent)];
 178 };
 179 .Ed
 180 .Pp
 181 All fields are converted to network byte order prior to
 182 transmission.  The load averages are as calculated by the
 183 .Xr w 1
 184 program, and represent load averages over the 5, 10, and 15 minute
 185 intervals prior to a server's transmission; they are multiplied by 100
 186 for representation in an integer.  The host name
 187 included is that returned by the
 188 .Xr gethostname 3
 189 system call, with any trailing domain name omitted.
 190 The array at the end of the message contains information about
 191 the users logged in to the sending machine.  This information
 192 includes the contents of the
 193 .Xr utmp 5
 194 entry for each non-idle terminal line and a value indicating the
 195 time in seconds since a character was last received on the terminal line.
 196 .Pp
 197 Messages received by the
 198 .Nm rwho
 199 server are discarded unless they originated at an
 200 .Nm rwho
 201 server's port or the
 202 .Fl i
 203 option was specified.  In addition, if the host's name, as specified
 204 in the message, contains any unprintable
 205 .Tn ASCII
 206 characters, the
 207 message is discarded.  Valid messages received by
 208 .Nm
 209 are placed in files named
 210 .Pa whod.hostname
 211 in the directory
 212 .Pa /var/rwho .
 213 These files contain only the most recent message, in the
 214 format described above.
 215 .Pp
 216 Status messages are generated approximately once every
 217 3 minutes.
 218 .Nm Rwhod
 219 performs an
 220 .Xr nlist 3
 221 on
 222 .Pa /kernel
 223 every 30 minutes to guard against
 224 the possibility that this file is not the system
 225 image currently operating.
 226 .Sh SEE ALSO
 227 .Xr ruptime 1 ,
 228 .Xr rwho 1
 229 .Sh BUGS
 230 Status information should be sent only upon request rather than continuously.
 231 People often interpret the server dying
 232 or network communication failures
 233 as a machine going down.
 234 .Sh HISTORY
 235 The
 236 .Nm
 237 utility appeared in
 238 .Bx 4.2 .