macro and text revision (-mdoc version 3)

[unix-history] / usr / src / usr.sbin / rwhod / rwhod.8

diff --git a/usr/src/usr.sbin/rwhod/rwhod.8 b/usr/src/usr.sbin/rwhod/rwhod.8
index 211f653..6bc8aba 100644 (file)
--- a/usr/src/usr.sbin/rwhod/rwhod.8
+++ b/usr/src/usr.sbin/rwhod/rwhod.8
@@ -1,50 +1,50 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)rwhod.8     6.4 (Berkeley) %G%
+.\"     @(#)rwhod.8    6.5 (Berkeley) %G%

 .\"
 .\"

-.TH RWHOD 8 ""
-.UC 5
-.SH NAME
-rwhod \- system status server
-.SH SYNOPSIS
-.B rwhod
-.SH DESCRIPTION
-.I Rwhod
+.Dd 
+.Dt RWHOD 8
+.Os BSD 4.2
+.Sh NAME
+.Nm rwhod
+.Nd system status server
+.Sh SYNOPSIS
+.Nm rwhod
+.Sh DESCRIPTION
+.Nm Rwhod

 is the server which maintains the database used by the
 is the server which maintains the database used by the

-.IR rwho (1C)
+.Xr rwho 1

 and
 and

-.IR ruptime (1C)
+.Xr ruptime 1

 programs.  Its operation is predicated on the ability to
 programs.  Its operation is predicated on the ability to

-.I broadcast
+.Em broadcast

 messages on a network.
 messages on a network.

-.PP
-.I Rwhod
+.Pp
+.Nm Rwhod

 operates as both a producer and consumer of status information.
 As a producer of information it periodically
 queries the state of the system and constructs
 status messages which are broadcast on a network.
 As a consumer of information, it listens for other
 operates as both a producer and consumer of status information.
 As a producer of information it periodically
 queries the state of the system and constructs
 status messages which are broadcast on a network.
 As a consumer of information, it listens for other

-.I rwhod
+.Nm rwhod

 servers' status messages, validating them, then recording
 them in a collection of files located in the directory
 servers' status messages, validating them, then recording
 them in a collection of files located in the directory

-.IR /var/rwho .
-.PP
+.Pa /var/rwho .
+.Pp

 The server transmits and receives messages at the port indicated
 in the ``rwho'' service specification; see 
 The server transmits and receives messages at the port indicated
 in the ``rwho'' service specification; see 

-.IR services (5).
+.Xr services 5 .

 The messages sent and received, are of the form:
 The messages sent and received, are of the form:

-.PP
-.nf
-.ta 0.5i 1.0i 1.5i
+.Bd -literal -offset indent

 struct outmp {
        char    out_line[8];            /* tty name */
        char    out_name[8];            /* user id */
        long    out_time;               /* time on */
 };
 struct outmp {
        char    out_line[8];            /* tty name */
        char    out_name[8];            /* user id */
        long    out_time;               /* time on */
 };

-.sp
+

 struct whod {
        char    wd_vers;
        char    wd_type;
 struct whod {
        char    wd_vers;
        char    wd_type;


@@ -59,52 +59,62 @@ struct      whod {
                int     we_idle;
        } wd_we[1024 / sizeof (struct whoent)];
 };
                int     we_idle;
        } wd_we[1024 / sizeof (struct whoent)];
 };

-.fi
-.PP
+.Ed
+.Pp

 All fields are converted to network byte order prior to
 transmission.  The load averages are as calculated by the
 All fields are converted to network byte order prior to
 transmission.  The load averages are as calculated by the

-.IR w (1)
+.Xr w 1

 program, and represent load averages over the 5, 10, and 15 minute 
 intervals prior to a server's transmission; they are multiplied by 100
 for representation in an integer.  The host name
 included is that returned by the
 program, and represent load averages over the 5, 10, and 15 minute 
 intervals prior to a server's transmission; they are multiplied by 100
 for representation in an integer.  The host name
 included is that returned by the

-.IR gethostname (2)
+.Xr gethostname 2

 system call, with any trailing domain name omitted.
 The array at the end of the message contains information about
 the users logged in to the sending machine.  This information 
 includes the contents of the 
 system call, with any trailing domain name omitted.
 The array at the end of the message contains information about
 the users logged in to the sending machine.  This information 
 includes the contents of the 

-.IR utmp (5)
+.Xr utmp 5

 entry for each non-idle terminal line and a value indicating the
 time in seconds since a character was last received on the terminal line.
 entry for each non-idle terminal line and a value indicating the
 time in seconds since a character was last received on the terminal line.

-.PP
+.Pp

 Messages received by the
 Messages received by the

-.I rwho
+.Xr rwho

 server are discarded unless they originated at an
 server are discarded unless they originated at an

-.I rwho
+.Xr rwho

 server's port.  In addition, if the host's name, as specified
 server's port.  In addition, if the host's name, as specified

-in the message, contains any unprintable ASCII characters, the
+in the message, contains any unprintable
+.Tn ASCII
+characters, the

 message is discarded.  Valid messages received by
 message is discarded.  Valid messages received by

-.I rwhod
+.Nm rwhod

 are placed in files named
 are placed in files named

-.IR whod . hostname
+.Pa whod.hostname

 in the directory
 in the directory

-.IR /var/rwho .
+.Pa /var/rwho .

 These files contain only the most recent message, in the
 format described above.
 These files contain only the most recent message, in the
 format described above.

-.PP
+.Pp

 Status messages are generated approximately once every
 3 minutes.
 Status messages are generated approximately once every
 3 minutes.

-.I Rwhod
+.Nm Rwhod

 performs an
 performs an

-.IR nlist (3)
-on /vmunix every 30 minutes to guard against
+.Xr nlist 3
+on
+.Pa /vmunix
+every 30 minutes to guard against

 the possibility that this file is not the system
 image currently operating.
 the possibility that this file is not the system
 image currently operating.

-.SH "SEE ALSO"
-rwho(1), ruptime(1)
-.SH BUGS
+.Sh SEE ALSO
+.Xr rwho 1 ,
+.Xr ruptime 1
+.Sh BUGS

 There should be a way to relay status information between networks. 
 Status information should be sent only upon request rather than continuously.
 People often interpret the server dying
 or network communtication failures
 as a machine going down.
 There should be a way to relay status information between networks. 
 Status information should be sent only upon request rather than continuously.
 People often interpret the server dying
 or network communtication failures
 as a machine going down.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .