usr.sbin/xten/xten.1

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