.\"
.\"
.\"	IRBOX, an Ivy driver for infra-red remote controls
.\"
.\"	Copyright 1998-1999 
.\"	Centre d'Etudes de la Navigation Aerienne
.\"
.\"	man page for irbox
.\"
.\"	Authors: Stephane Chatty <chatty@cena.dgac.fr>
.\"
.\"	$Id$
.\"
.\"	Please refer to file version.h for the
.\"	copyright notice regarding this software
.\"

.TH irbox 8 "17 Dec 1999"
.ds )H CENA, France.
.ds ]W V1.2
.SH NAME
irbox - an Ivy agent that manages an IRMAN infra-red receiver
.SH SYNOPSIS
.B "irbox [-b bus] [-s serial_device] [-n agent_name] [-p table_dir]"
.SH DESCRIPTION
.B irbox
is an Ivy agent that decodes signals received on a serial link from an IRMAN
infra-red receiver (see http://www.evation.com/irman/) and emits the
corresponding events on an Ivy bus. This can be used to write Ivy agents that
react to an infra-red remote control.

Thanks to the quasi-uniqueness of the codes emitted by an IRMAN receiver and to
translation tables provided for many types of remote controls,
.B irbox
is able to distinguish and decode key presses from many different remote controls.

.SH OPTIONS
.RS
.TP
.B -s serial_device
Use the device connected to the serial link defined by
.I serial_device.
If this option is not used, the value of the environment variable
.B IRBOX_DEVICE
is used. The default value is /dev/ttyS0.

.TP
.B -p table_dir
Retrieve translation tables from directory
.I table_dir.
If this option is not used, the value of the environment variable
.B IRBOX_DIR
is used. The default value is /usr/lib/irbox.

.TP
.B -b bus
Emit events on the Ivy bus defined by the address
.I bus.
The syntax of bus addresses is
.I [network[,network]][:port],
where
.I port
is the UDP port used to broadcast information on the Ivy bus, and
.I network[,network]
is a set of network addresses on which information is
broadcast. Examples of bus adresses are 192.75:2000, :2001 or 192.75,192.76.
The default port is
.I 2010,
and the default network is
.I 127,
ie. loopback on the
local host.

.TP
.B -n agent_name
Use
.I agent_name
as the application name in the events emitted.

.SH EXAMPLE
.LP
This example connects
.B irbox
to an IRMAN receiver plugged into the /dev/ttyS0 port, and remits events on the
bus :2010 (port 2010 on local host).

.IP
.B irbox \-b
.I :2010
.B \-s
.I /dev/ttyS0
.LP
If the user aims an Aiko VCR control at the IRMAN receiver and depresses the
.I power
key, the following event will be emitted:
.IP
.B localhost:IRBOX Down control=AikoVCR button=power

.SH ENVIRONMENT VARIABLES
The variable
.B IRBOX_DEVICE
can be used to specify the serial link to be used instead of using the -s option.
The variable
.B IRBOX_DIR
can be used to specify the data directory for translation tables instead of using the -p option.

.SH SIGNALS

Upon a
.B SIGHUP
signal,
.B irbox
rereads all the translation tables present in the data directory.

.SH LAUNCH AT BOOT TIME
.B irman
can be launched at boot time like many daemons. It comes with launch files
for Debian and RedHat Linux.

.SH ERRORS
If it gets no response from the IRMAN receiver at launch time,
.B irbox
exits after a few seconds.

.SH SEE ALSO
.PP
irbox(5),
Ivy(1)