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