Commit | Line | Data |
---|---|---|
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/usr.sbin/xten/xten.1,v 1.9.2.3 2002/06/21 16:42:43 charnier Exp $ | |
49781055 | 31 | .\" $DragonFly: src/usr.sbin/xten/xten.1,v 1.3 2006/02/17 19:40:30 swildner Exp $ |
984263bc MD |
32 | .\" |
33 | .Dd October 30, 1993 | |
34 | .Dt XTEN 1 | |
35 | .Os | |
36 | .Sh NAME | |
37 | .Nm xten | |
38 | .Nd transmit X-10 commands | |
39 | .Sh SYNOPSIS | |
40 | .Nm | |
41 | .Op Fl "" | |
42 | .Ar house | |
43 | .Ar key Ns Op : Ns Ar cnt | |
44 | .Oo | |
45 | .Op Ar house | |
46 | .Ar key Ns Op : Ns Ar cnt | |
47 | .Ar ... | |
48 | .Oc | |
49 | .Sh DESCRIPTION | |
50 | The | |
51 | .Nm | |
52 | utility is a command-line interface to the X-10 daemon. | |
53 | When invoked with a one-letter house code (A-P) and a series of key/unit | |
54 | codes as arguments, it requests the X-10 daemon to transmit a corresponding | |
55 | series of X-10 packets. The X-10 daemon makes its best effort to ensure | |
56 | that the packets are all transmitted correctly, though in general it is | |
57 | not possible to tell whether the commands were actually received and | |
58 | executed by the remote X-10 devices. | |
59 | .Pp | |
60 | When invoked with the single argument | |
61 | .Fl "" , | |
62 | .Nm | |
63 | enters an interactive mode in which a line is repeatedly read from the | |
64 | standard input, sent to the X-10 daemon, and the one-line response from | |
65 | the daemon printed on the standard output. | |
66 | .Sh OPTIONS | |
67 | The | |
68 | .Ar house | |
69 | argument is a one-letter house code in the range A-P. | |
70 | All the X-10 requests generated will refer to this house code. | |
71 | Each | |
72 | .Ar key | |
73 | is either a numeric unit code in the range 1-16, or else | |
74 | is a string that specifies an X-10 function. The possible | |
75 | function code strings are: | |
76 | .Bl -diag | |
77 | .It AllUnitsOff | |
78 | .It AllLightsOn | |
79 | .It On | |
80 | .It Off | |
81 | .It Dim | |
82 | .It Bright | |
83 | .It AllLightsOff | |
84 | .It ExtendedCode | |
85 | .It HailRequest | |
86 | .It HailAcknowledge | |
87 | .It PreSetDim0 | |
88 | .It PreSetDim1 | |
89 | .It ExtendedData | |
90 | .It StatusOn | |
91 | .It StatusOff | |
92 | .It StatusRequest | |
93 | .El | |
94 | .Pp | |
95 | Each | |
96 | .Ar key | |
97 | may be followed by an optional numeric | |
98 | .Ar cnt , | |
99 | which specifies the number of packets that are to be sent with that | |
100 | key code without gaps. If this argument is omitted, two packets | |
101 | are transmitted. The ability to specify numbers of packets other than | |
102 | two is used by the X-10 | |
103 | .Em Dim | |
104 | and | |
105 | .Em Bright | |
106 | commands. | |
984263bc MD |
107 | .Sh FILES |
108 | .Bl -tag -width /var/spool/xten/Status -compact | |
109 | .It Pa /dev/tw0 | |
110 | the TW523 special file | |
111 | .El | |
49781055 SW |
112 | .Sh SEE ALSO |
113 | .Xr tw 4 , | |
114 | .Xr xtend 8 | |
984263bc MD |
115 | .Sh AUTHORS |
116 | .An Eugene W. Stark Aq stark@cs.sunysb.edu |