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$
  34 .\"
  35 .Dd December 11, 1993
  36 .Dt RWHOD 8
  37 .Os
  38 .Sh NAME
  39 .Nm rwhod
  40 .Nd system status server
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl i
  44 .Op Fl p
  45 .Op Fl l
  46 .Op Fl m Op Ar ttl
  47 .Sh DESCRIPTION
  48 .Nm Rwhod
  49 is the server which maintains the database used by the
  50 .Xr rwho 1
  51 and
  52 .Xr ruptime 1
  53 programs.  Its operation is predicated on the ability to
  54 .Em broadcast
  55 or
  56 .Em multicast
  57 messages on a network.
  58 .Pp
  59 .Nm Rwhod
  60 operates as both a producer and consumer of status information,
  61 unless the
  62 .Fl l
  63 (listen mode) option is specified, in which case
  64 it acts as a consumer only.
  65 As a producer of information it periodically
  66 queries the state of the system and constructs
  67 status messages which are broadcasted or multicasted on a network.
  68 As a consumer of information, it listens for other
  69 .Nm
  70 servers' status messages, validating them, then recording
  71 them in a collection of files located in the directory
  72 .Pa /var/rwho .
  73 .Pp
  74 The
  75 .Fl i
  76 option enables insecure mode, which causes
  77 .Nm
  78 to ignore the source port on incoming packets.
  79 .Pp
  80 The
  81 .Fl p
  82 option tells
  83 .Nm
  84 to ignore all
  85 .Dv POINTOPOINT
  86 interfaces.  This is useful if you do not wish to keep dial on demand
  87 interfaces permanently active.
  88 .Pp
  89 The
  90 .Fl l
  91 option enables listen mode, which causes
  92 .Nm
  93 to not broadcast any information.
  94 This allows you to monitor other machines'
  95 .Nm
  96 information, without broadcasting your own.
  97 .Pp
  98 The
  99 .Fl m
 100 option causes
 101 .Nm
 102 to use IP multicast (instead of
 103 broadcast) on all interfaces that have
 104 the IFF_MULTICAST flag set in their "ifnet" structs
 105 (excluding the loopback interface).  The multicast
 106 reports are sent with a time-to-live of 1, to prevent
 107 forwarding beyond the directly-connected subnet(s).
 108 .Pp
 109 If the optional
 110 .Ar ttl
 111 argument is supplied with the
 112 .Fl m
 113 flag,
 114 .Nm
 115 will send IP multicast datagrams with a
 116 time-to-live of
 117 .Ar ttl ,
 118 via a SINGLE interface rather
 119 than all interfaces.
 120 .Ar ttl
 121 must be between 0 and
 122 32 (or MAX_MULTICAST_SCOPE).  Note that
 123 .Fl m Ar 1
 124 is different from
 125 .Fl m ,
 126 in that
 127 .Fl m Ar 1
 128 specifies transmission on one interface only.
 129 .Pp
 130 When
 131 .Fl m
 132 is used without a
 133 .Ar ttl
 134 argument, the program accepts multicast
 135 .Nm
 136 reports from all multicast-capable interfaces.  If a
 137 .Ar ttl
 138 argument is given, it accepts multicast reports from only one interface, the
 139 one on which reports are sent (which may be controlled via the host's routing
 140 table).  Regardless of the
 141 .Fl m
 142 option, the program accepts broadcast or
 143 unicast reports from all interfaces.  Thus, this program will hear the
 144 reports of old, non-multicasting
 145 .Nm Ns s ,
 146 but, if multicasting is used,
 147 those old
 148 .Nm Ns s
 149 won't hear the reports generated by this program.
 150 .Pp
 151 The server transmits and receives messages at the port indicated
 152 in the ``who'' service specification; see
 153 .Xr services 5 .
 154 The messages sent and received, are of the form:
 155 .Bd -literal -offset indent
 156 struct  outmp {
 157         char    out_line[8];            /* tty name */
 158         char    out_name[8];            /* user id */
 159         long    out_time;               /* time on */
 160 };
 161
 162 struct  whod {
 163         char    wd_vers;
 164         char    wd_type;
 165         char    wd_fill[2];
 166         int     wd_sendtime;
 167         int     wd_recvtime;
 168         char    wd_hostname[32];
 169         int     wd_loadav[3];
 170         int     wd_boottime;
 171         struct  whoent {
 172                 struct  outmp we_utmp;
 173                 int     we_idle;
 174         } wd_we[1024 / sizeof (struct whoent)];
 175 };
 176 .Ed
 177 .Pp
 178 All fields are converted to network byte order prior to
 179 transmission.  The load averages are as calculated by the
 180 .Xr w 1
 181 program, and represent load averages over the 5, 10, and 15 minute
 182 intervals prior to a server's transmission; they are multiplied by 100
 183 for representation in an integer.  The host name
 184 included is that returned by the
 185 .Xr gethostname 3
 186 system call, with any trailing domain name omitted.
 187 The array at the end of the message contains information about
 188 the users logged in to the sending machine.  This information
 189 includes the contents of the
 190 .Xr utmp 5
 191 entry for each non-idle terminal line and a value indicating the
 192 time in seconds since a character was last received on the terminal line.
 193 .Pp
 194 Messages received by the
 195 .Nm rwho
 196 server are discarded unless they originated at an
 197 .Nm rwho
 198 server's port or the
 199 .Fl i
 200 option was specified.  In addition, if the host's name, as specified
 201 in the message, contains any unprintable
 202 .Tn ASCII
 203 characters, the
 204 message is discarded.  Valid messages received by
 205 .Nm
 206 are placed in files named
 207 .Pa whod.hostname
 208 in the directory
 209 .Pa /var/rwho .
 210 These files contain only the most recent message, in the
 211 format described above.
 212 .Pp
 213 Status messages are generated approximately once every
 214 3 minutes.
 215 .Nm Rwhod
 216 performs an
 217 .Xr nlist 3
 218 on
 219 .Pa /boot/kernel/kernel
 220 every 30 minutes to guard against
 221 the possibility that this file is not the system
 222 image currently operating.
 223 .Sh SEE ALSO
 224 .Xr ruptime 1 ,
 225 .Xr rwho 1
 226 .Sh BUGS
 227 Status information should be sent only upon request rather than continuously.
 228 People often interpret the server dying
 229 or network communication failures
 230 as a machine going down.
 231 .Sh HISTORY
 232 The
 233 .Nm
 234 command appeared in
 235 .Bx 4.2 .