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