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