Use err(3). Add prototypes. Document that startup scripts are rc.i386 and

rc.conf (enable/disable) not rc.local.
Use full pathname in SYNOPSIS section.

1 files changed, 30 insertions, 23 deletions

diff --git a/libexec/xtend/xtend.8 b/libexec/xtend/xtend.8
index fe6209b..41a6677 100644
--- a/libexec/xtend/xtend.8
+++ b/libexec/xtend/xtend.8
@@ -27,16 +27,17 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"	$Id: xtend.8,v 1.6 1997/02/22 14:22:43 peter Exp $
+.\"	$Id: xtend.8,v 1.7 1997/06/24 03:52:15 stark Exp $
 .\"
 .Th XTEND 8 "30 Oct 1993"
 .Dd Oct 30, 1993
 .Dt XTEND 8
 .Os BSD FreeBSD
 .Sh NAME
-xtend \- X-10 daemon
-.Sh SYNOPSIS
 .Nm xtend
+.Nd X-10 daemon
+.Sh SYNOPSIS
+.Nm /usr/libexec/xtend
 .Sh DESCRIPTION
 .Nm Xtend
 interfaces between user-level programs and the TW523 X-10 controller.
@@ -45,26 +46,29 @@ status of all X-10 devices, and accepts socket connections from user-level
 client programs that need to manipulate X-10 devices.
 .Pp
 When
-.Nm xtend
+.Nm
 is started, it forks, releases the controlling terminal, then opens
 its log file, where it subsequently records all X-10 activity and
 diagnostic messages.  It then begins processing packets received from
 the TW523 and accepting connections one at a time from clients
-wishing to issue X-10 commands.  The usual place to start xtend would
-be from the
-.Pa /etc/rc.local
-startup script.
+wishing to issue X-10 commands.
+.Nm Xtend
+is started from
+.Pa /etc/rc.i386
+startup script if enabled in
+.Pa /etc/rc.conf
+script.
 .Pp
 Sending
-.Nm xtend
+.Nm
 a SIGHUP causes it to close and reopen its log file.  This is useful
 in shell scripts that rotate the log files to keep them from growing
 indefinitely.
 If
-.Nm xtend
+.Nm
 receives a SIGTERM, it shuts down gracefully and exits.
 A SIGPIPE causes
-.Nm xtend
+.Nm
 to abort the current client connection.
 .Pp
 .Nm Xtend
@@ -73,16 +77,16 @@ command is sent by the client, and is acknowledged by a one-line response
 from the daemon.
 .Pp
 .Nm Xtend
-understands four types of commands.  The command
+understands four types of commands.  The command:
 .Bl -tag
 .It status H U
 .El
 .Pp
 where H is a single letter house code, and U is a numeric unit code,
 causes
-.Nm xtend
+.Nm
 to respond with one line of status information about the specified device.
-The command
+The command:
 .Bl -tag
 .It send H U N
 .El
@@ -93,7 +97,7 @@ or a function code (see source file
 ) for a list, and N is a number indicating the number of times (usually 2)
 the packet is to be transmitted without gaps,
 causes
-.Nm xtend
+.Nm
 to perform the specified X-10 transmission.  If the transmission was apparently
 successful, a single-line response containing
 .B
@@ -102,25 +106,27 @@ is issued, otherwise a single-line response containing
 .B
 ERROR
 is produced.
-The command
+The command:
 .Bl -tag
 .It dump
 .El
 .Pp
 causes 
-.Nm xtend
-to dump the current status of all devices to an ASCII file in the spool
+.Nm
+to dump the current status of all devices to an
+.Tn ASCII
+file in the spool
 directory.  The response
 .B
 OK
 is issued, regardless of whether the status dump was successful.
-The command
+The command:
 .Bl -tag
 .It monitor H U
 .El
 .Pp
 causes
-.Nm xtend
+.Nm
 to add the current client socket connection to a list of clients that are to
 be notified about activity concerning the specified X-10 device.
 The single-line acknowledgement
@@ -135,7 +141,7 @@ is returned.
 then returns to its normal mode of accepting connections from clients.
 However, each subsequent change in the status of the specified device will
 cause
-.Nm xtend
+.Nm
 to write one line of status information for the device (in the same
 format as produced by the
 .B
@@ -161,7 +167,8 @@ log file
 .It Pa /var/spool/xten/Status
 device status file (binary)
 .It Pa /var/spool/xten/status.out
-ASCII dump of device status
+.Tn ASCII
+dump of device status
 .El
 .Sh BUGS
 There is currently no timeout on client socket connections, so a hung
@@ -173,4 +180,4 @@ usually no way it can tell when a device has been operated manually.
 This is due to the fact that most X-10 devices are not able to
 respond to queries about their status.
 .Sh AUTHOR
-Eugene W. Stark (stark@cs.sunysb.edu)
+.An Eugene W. Stark Aq stark@cs.sunysb.edu