summaryrefslogtreecommitdiffstats
path: root/libexec/xtend
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2000-12-20 13:26:01 +0000
committerru <ru@FreeBSD.org>2000-12-20 13:26:01 +0000
commit9dc3f06fd900f168f5526a72bcf2e9b475b65cab (patch)
treebb46b8ffd411b7dddd7d145d383eae5c30fd568e /libexec/xtend
parenteb97254875db6165bb8026cb48f86010e80f075a (diff)
downloadFreeBSD-src-9dc3f06fd900f168f5526a72bcf2e9b475b65cab.zip
FreeBSD-src-9dc3f06fd900f168f5526a72bcf2e9b475b65cab.tar.gz
Prepare for mdoc(7)NG.
Diffstat (limited to 'libexec/xtend')
-rw-r--r--libexec/xtend/xtend.878
1 files changed, 37 insertions, 41 deletions
diff --git a/libexec/xtend/xtend.8 b/libexec/xtend/xtend.8
index 3b0668f..4dd0c78 100644
--- a/libexec/xtend/xtend.8
+++ b/libexec/xtend/xtend.8
@@ -29,7 +29,6 @@
.\"
.\" $FreeBSD$
.\"
-.Th XTEND 8 "30 Oct 1993"
.Dd October 30, 1993
.Dt XTEND 8
.Os FreeBSD
@@ -61,13 +60,19 @@ script.
.Pp
Sending
.Nm
-a SIGHUP causes it to close and reopen its log file. This is useful
+a
+.Dv 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
-receives a SIGTERM, it shuts down gracefully and exits.
-A SIGPIPE causes
+receives a
+.Dv SIGTERM ,
+it shuts down gracefully and exits.
+A
+.Dv SIGPIPE
+causes
.Nm
to abort the current client connection.
.Pp
@@ -77,65 +82,56 @@ 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:
-.Bl -tag
-.It status H U
-.El
-.Pp
-where H is a single letter house code, and U is a numeric unit code,
+understands four types of commands:
+.Bl -tag -width "monitor H U
+.It Ic status Ar H U
+where
+.Ar H
+is a single letter house code, and
+.Ar U
+is a numeric unit code,
causes
.Nm
to respond with one line of status information about the specified device.
-The command:
-.Bl -tag
-.It send H U N
-.El
-.Pp
-where H is a single-letter house code, U is either a numeric unit code
+.It Ic send Ar H U N
+where
+.Ar H
+is a single-letter house code,
+.Ar U
+is either a numeric unit code
or a function code (see source file
-.Pa xtend/packet.c
-) for a list, and N is a number indicating the number of times (usually 2)
+.Pa xtend/packet.c )
+for a list, and
+.Ar N
+is a number indicating the number of times (usually 2)
the packet is to be transmitted without gaps,
causes
.Nm
to perform the specified X-10 transmission. If the transmission was apparently
successful, a single-line response containing
-.B
-OK
+.Sy OK
is issued, otherwise a single-line response containing
-.B
-ERROR
+.Sy ERROR
is produced.
-The command:
-.Bl -tag
-.It dump
-.El
-.Pp
+.It Ic dump
causes
.Nm
to dump the current status of all devices to an
.Tn ASCII
file in the spool
directory. The response
-.B
-OK
+.Sy OK
is issued, regardless of whether the status dump was successful.
-The command:
-.Bl -tag
-.It monitor H U
-.El
-.Pp
+.It Ic monitor Ar H U
causes
.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
-.B
-OK
+.Sy OK
is returned if the maximum (currently 5) number of such clients was not
exceeded, otherwise
-.B
-ERROR
+.Sy ERROR
is returned.
.Nm Xtend
then returns to its normal mode of accepting connections from clients.
@@ -144,18 +140,18 @@ cause
.Nm
to write one line of status information for the device (in the same
format as produced by the
-.B
-status
+.Ic status
command) to the saved socket. This feature is useful for writing programs
that need to monitor the activity of devices, like motion detectors, that can
perform X-10 transmissions.
+.El
.Sh OPTIONS
None.
.Sh SEE ALSO
.Xr xten 1 ,
.Xr tw 4
.Sh FILES
-.Bl -tag -width /var/spool/xten/Status -compact
+.Bl -tag -width /var/spool/xten/status.out -compact
.It Pa /dev/tw0
the TW523 special file
.It Pa /var/run/tw523
OpenPOWER on IntegriCloud