gold: Fix hardcoded library search path
[dragonfly.git] / libexec / xtend / xtend.8
CommitLineData
984263bc
MD
1.\" Copyright (c) 1992, 1993 Eugene W. Stark
2.\" 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 Eugene W. Stark.
15.\" 4. The name of the author may not be used to endorse or promote products
16.\" derived from this software without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY EUGENE W. STARK (THE AUTHOR) ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
22.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD: src/libexec/xtend/xtend.8,v 1.11.2.4 2001/08/16 10:44:22 ru Exp $
be67b412 31.\" $DragonFly: src/libexec/xtend/xtend.8,v 1.4 2007/12/16 02:55:38 thomas Exp $
984263bc
MD
32.\"
33.Dd October 30, 1993
34.Dt XTEND 8
35.Os
36.Sh NAME
37.Nm xtend
38.Nd X-10 daemon
39.Sh SYNOPSIS
40.Nm /usr/libexec/xtend
41.Sh DESCRIPTION
42.Nm Xtend
43interfaces between user-level programs and the TW523 X-10 controller.
44It logs all packets received from the TW523, attempts to track the
45status of all X-10 devices, and accepts socket connections from user-level
46client programs that need to manipulate X-10 devices.
47.Pp
48When
49.Nm
50is started, it forks, releases the controlling terminal, then opens
51its log file, where it subsequently records all X-10 activity and
52diagnostic messages. It then begins processing packets received from
53the TW523 and accepting connections one at a time from clients
54wishing to issue X-10 commands.
984263bc
MD
55.Pp
56Sending
57.Nm
58a
59.Dv SIGHUP
60causes it to close and reopen its log file. This is useful
61in shell scripts that rotate the log files to keep them from growing
62indefinitely.
63If
64.Nm
65receives a
66.Dv SIGTERM ,
67it shuts down gracefully and exits.
68A
69.Dv SIGPIPE
70causes
71.Nm
72to abort the current client connection.
73.Pp
74.Nm Xtend
75communicates with client processes by a simple protocol in which a one-line
76command is sent by the client, and is acknowledged by a one-line response
77from the daemon.
78.Pp
79.Nm Xtend
80understands four types of commands:
9f3fc534 81.Bl -tag -width "monitor H U"
984263bc
MD
82.It Ic status Ar H U
83where
84.Ar H
85is a single letter house code, and
86.Ar U
87is a numeric unit code,
88causes
89.Nm
90to respond with one line of status information about the specified device.
91.It Ic send Ar H U N
92where
93.Ar H
94is a single-letter house code,
95.Ar U
96is either a numeric unit code
97or a function code (see source file
98.Pa xtend/packet.c )
99for a list, and
100.Ar N
101is a number indicating the number of times (usually 2)
102the packet is to be transmitted without gaps,
103causes
104.Nm
105to perform the specified X-10 transmission. If the transmission was apparently
106successful, a single-line response containing
107.Sy OK
108is issued, otherwise a single-line response containing
109.Sy ERROR
110is produced.
111.It Ic dump
112causes
113.Nm
114to dump the current status of all devices to an
115.Tn ASCII
116file in the spool
117directory. The response
118.Sy OK
119is issued, regardless of whether the status dump was successful.
120.It Ic monitor Ar H U
121causes
122.Nm
123to add the current client socket connection to a list of clients that are to
124be notified about activity concerning the specified X-10 device.
125The single-line acknowledgement
126.Sy OK
127is returned if the maximum (currently 5) number of such clients was not
128exceeded, otherwise
129.Sy ERROR
130is returned.
131.Nm Xtend
132then returns to its normal mode of accepting connections from clients.
133However, each subsequent change in the status of the specified device will
134cause
135.Nm
136to write one line of status information for the device (in the same
137format as produced by the
138.Ic status
139command) to the saved socket. This feature is useful for writing programs
140that need to monitor the activity of devices, like motion detectors, that can
141perform X-10 transmissions.
142.El
143.Sh OPTIONS
144None.
984263bc
MD
145.Sh FILES
146.Bl -tag -width /var/spool/xten/status.out -compact
147.It Pa /dev/tw0
148the TW523 special file
149.It Pa /var/run/tw523
150socket for client connections
151.It Pa /var/run/xtend.pid
152pid file
153.It Pa /var/spool/xten/Log
154log file
155.It Pa /var/spool/xten/Status
156device status file (binary)
157.It Pa /var/spool/xten/status.out
158.Tn ASCII
159dump of device status
160.El
d600454b
SW
161.Sh SEE ALSO
162.Xr xten 1 ,
163.Xr tw 4
164.Sh AUTHORS
165.An Eugene W. Stark Aq stark@cs.sunysb.edu
984263bc
MD
166.Sh BUGS
167There is currently no timeout on client socket connections, so a hung
168client program can prevent other clients from accessing the daemon.
169.Pp
170.Nm Xtend
171does the best it can at trying to track device status, but there is
172usually no way it can tell when a device has been operated manually.
173This is due to the fact that most X-10 devices are not able to
174respond to queries about their status.