.\"
.\"
.\"	IRBOX, an Ivy driver for infra-red remote controls
.\"
.\"	Copyright 1998-1999 
.\"	Centre d'Etudes de la Navigation Aerienne
.\"
.\"	man page for irbox tables
.\"
.\"	Authors: Stephane Chatty <chatty@cena.dgac.fr>
.\"
.\"	$Id$
.\"
.\"	Please refer to file version.h for the
.\"	copyright notice regarding this software
.\"
.TH irbox 5 "17 Dec 1999"
.ds )H CENA, France.
.ds ]W V1.2
.SH NAME
irbox \- format of the remote control tables
.SH "DESCRIPTION"
When a key is pressed on a remote control aimed at an IRMAN receiver, the
receiver emits a series of 6 bytes. It happens that with very few exceptions
every series of 6 bytes is unique and corresponds to a given key of a given
remote control type.

For each type of infra-red remote control you want your IRMAN receiver to deal
with there should be a table indicating that tells
.B irbox
how to map the bytes it receives to keys on the remote control.

Tables are read when
.B irbox
is launched, or when it receives a
.B SIGHUP
signal.

.SH "FORMAT"
Tables are text files structured in lines. A table can contain the following lines:

.SS name <table_name>
specifies the name that will be used to characterize this type of remote control
in Ivy events when a key described in the table is detected.

.SS type: <appliance_kind>
specifies the type of device the remote control is normally used for (TV, VCR, cable,
etc.). For programmable remote controls, it specifies in which mode they should
be set to use this table. This information is ignored by
.B irbox
.

.SS brand: <remote_control_ reference>
specifies what remote control can be associated to this table. The reference can 
be that of the control itself or that of the appliance it controls. In the case of 
a programmable remote control, this line can be used to remember how it should
be programmed to trigger this table.  This information is ignored by
.B irbox
.
There can be more than one such line: there can be several remote control
references that have the same behaviour.

.SS <key>: <byte1> <byte2> <byte3> <byte4> <byte5> <byte6>
tells
.B irbox
to associate this series of 6 bytes to
.I
key
.

Comments start with '#'.

.SH EXAMPLE
The following table describes the remote control for Aiko VCRs. It was obtained
from a RCA programmable remote control in the Aiko VCR mode.
.sp
.RS +.4i
.ta 1.5i
.nf
name AikoVCR
type: VCR

brand: Aiko
brand: RCA SystemLink 3 [mode 027]

# obtained on an RCA SystemLink 3 in VCR mode 027

power:  168 212 000 000 000 000
channel up:     168 244 000 000 000 000
channel down:   168 140 000 000 000 000
rew:    168 132 000 000 000 000
play:   168 184 000 000 000 000
ff:     168 248 000 000 000 000
rec:    168 164 000 000 000 000
stop:   168 216 000 000 000 000
pause:  168 196 000 000 000 000
.fi
.RE
.sp

If the user depresses the
.I power
key of an Aiko VCR remote control,
.B
irbox
will emit the following event on its Ivy bus:
.IP
.B localhost:IRBOX Down control=AikoVCR button=power

.SH "FILES"
Tables are usually found in
.BR /usr/lib/irbox/*.ir

.SH "SEE ALSO"
.BR irbox (8)

.SH AUTHOR
This manual page was written by Stéphane Chatty <chatty@cena.dgac.fr>
for the GNU/Linux system.