/usr/share/doc/lirc/html/lircd.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<HTML>
  <HEAD>
    <TITLE>LIRC - Linux Infrared Remote Control</TITLE>
    <LINK REL=stylesheet TYPE="text/css" HREF="../lirc.css">
    <LINK REL="shortcut icon" HREF="../favicon.ico">
    <META NAME="description" CONTENT="LIRC - Linux Infra-red Remote Control">
    <META NAME="keywords" CONTENT="linux, kernel module, remote control, animax, multimedia">
  </HEAD>
  
  <BODY BACKGROUND="../images/marb18.jpg"
    BGCOLOR="#FFFFFF" TEXT="#000000" ALINK="#8080FF">
    <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0">
      <TR>
	<TD CLASS="menu" WIDTH="100%" HEIGHT="150">
	  <IMG SRC="../images/diode.gif" ALT=""
	    WIDTH="300" HEIGHT="150" BORDER="0" HSPACE="20"
	    VSPACE="0" ALIGN="LEFT"> 
	  <IMG SRC="../images/lirc.gif" ALT=""
	    WIDTH="300" HEIGHT="150" BORDER="0" HSPACE="20"
	    VSPACE="0" ALIGN="RIGHT">
	</TD>
      </TR>
      <TR>
	<TD WIDTH="100%">&#160;<BR>
	  <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0">
	    <TR>
	      <TD WIDTH="15%">&#160;<BR></TD>
	      <TD WIDTH="70%" ALIGN="LEFT" VALIGN="TOP">&#160;<BR>

<!-- Text ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

<H1>LIRCD</H1>
<HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

lircd - LIRC daemon decodes infrared signals and provides them on a Unix
domain socket.
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>lircd</B>

[<I>options</I>] [<I>config-file</I>]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

The main task of lircd is to decode the infrared signals and provide
an uniform interface for client applications. Clients can connect to
lircd through a Unix domain socket which is located in
/var/run/lirc/lircd.  Using this socket they will get the infrared
codes received by lircd and they can send commands to lircd.
<DL COMPACT>
<DT><B>-h</B> <B>--help</B><DD>
display this message
<DT><B>-v</B> <B>--version</B><DD>
display version
<DT><B>-n</B> <B>--nodaemon</B><DD>
don't fork to background
<DT><B>-p</B> <B>--permission</B>=<I>mode</I><DD>
file permissions for /var/run/lirc/lircd
<DT><B>-H</B> <B>--driver</B>=<I>driver</I><DD>
use given driver
<DT><B>-d</B> <B>--device</B>=<I>device</I><DD>
read from given device
<DT><B>-l</B> <B>--listen[</B>=<I>[address</I>:]port]<DD>
listen for network connections
<DT><B>-c</B> <B>--connect</B>=<I>host[</I>:port]<DD>
connect to remote lircd server
<DT><B>-o</B> <B>--output</B>=<I>socket</I><DD>
output socket filename
<DT><B>-P</B> <B>--pidfile</B>=<I>file</I><DD>
daemon pid file
<DT><B>-L</B> <B>--logfile</B>=<I>file</I><DD>
daemon log file
<DT><B>-r</B> <B>--release</B>[=<I>suffix</I>]<DD>
auto-generate release events
<DT><B>-a</B> <B>--allow-simulate</B><DD>
accept SIMULATE command
<DT><B>-u</B> <B>--uinput</B><DD>
generate Linux input events
<DT><B>-R</B> <B>--repeat-max</B>=<I>limit</I><DD>
allow at most this many repeats
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>

The --permission option gives the file permission of
/var/run/lirc/lircd if it has to be created in octal
representation. Read the documentation for chmod for further
details. If no --permission option is given when the socket is
initially created the default is to give all users read and write
permissions (0666 in octal representation). If /var/run/lirc/lircd
already exists this option has no effect.
<P>
With the --device option you can select the character device which
lircd should read from. The default currently is /dev/lirc but it
probably will change in future.
<P>
If you're using the dev/input driver, you can use <I>name=STRING</I> or
<I>phys=STRING</I> to select the device; lircd will look in /dev/input
to find a device with a matching description. This is useful in case
the device name isn't fixed. <I>STRING</I> may contain the '*' and '?' 
wildcards and '\' to mark them as literal.
<P>
With the --listen option you can let lircd listen for network
connections on the given address/port. The default address is 0.0.0.0,
which means that connections on all network interfaces will be accepted.
The default port is 8765. No security checks are currently implemented.
The listening lircd instance will send all IR events to the connecting
lircd instances.
<P>
The --connect option allows you to connect to other lircd servers that
provide a network socket at the given host and port number. The number
of such connections is currently limited to 100.
The connecting lircd instance will receive IR events from the lircd
instance it connects to.
<P>
With the --output option you can select Unix domain socket, which
lircd will write remote key codes to. The default currently is
/var/run/lirc/lircd.
<P>
With the --pidfile option you can select the lircd daemon pid file.
The default currently is /var/run/lirc/lircd.pid.
<P>
With the --logfile option you can select the lircd daemon log file.
The default currently is /var/log/lircd. Note that this option will
only be available if you compiled lircd without syslog support.
<P>
The --release option enables automatic generation of release events
for each button press. lircd will append the given suffix to the button
name for each release event. If no suffix is given the default suffix
is '_UP'.
<P>
The --allow-simulate option will enable the SIMULATE command which can
be issued using irsend(1). This will allow simulating arbitrary IR events
from the command line. Use this option with caution because it will give all
users with access to the lircd socket wide control over you system.
E.g. if you have configured your system to shut down by a button press
on your remote control, everybody will be able to shut down
your system from the command line.
<P>
On Linux systems the --uinput option will enable automatic generation
of Linux input events. lircd will open /dev/input/uinput and inject
key events to the Linux kernel. The key code depends on the name that
was given a button in the lircd config file, e.g. if the button is
named KEY_1, the '1' key code will be generated. You will find a
complete list of possible button names in /usr/include/linux/input.h.
<P>
The --repeat-max option sets an upper limit to the number of repeats
when sending a signal. The current default is 600. A SEND_START
request will repeat the signal this many times. Also, if the number of
repeats in a SEND_ONCE request exceeds this number, it will be
replaced by this number.
<A NAME="lbAF">&nbsp;</A>
<H2>FILES</H2>

<P>
The config file for lircd is located in /etc/lirc/lircd.conf. lircd
has its own log file in /var/log/lircd (beginning with LIRC version
0.6.1 you can configure lircd to use syslogd for log messages; then it
depends on your system configuration where log messages will show up).
You can make lircd reread its config file and reopen its log file by
sending the HUP signal to the program. That way you can rotate old log
files.
<A NAME="lbAG">&nbsp;</A>
<H2>DAEMONS</H2>

lircd and lircmd are daemons. You should start them in some init script
depending on your system. There are some example scripts for different
distributions in the contrib directory. lircmd has to be started after
lircd as it connects to the socket lircd provides.
<P>
If you start lircd or lircmd from your shell prompt you will usually get
back immediately to the prompt. Often people think that the program has
died. But this is not an error. lircd and lircmd are daemons. Daemons
always run in background.
<A NAME="lbAH">&nbsp;</A>

<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->

		<BR><BR>
		<CENTER>[<A HREF="http://www.lirc.org/">LIRC homepage</A>]<BR>
		  <I>The LIRC Manual, last update: 24-May-2009</I></CENTER>
		<BR><BR>
	      </TD>
	      <TD WIDTH="15%">&#160;<BR></TD>
	    </TR>
	  </TABLE>
	</TD>
      </TR>
      <TR>
	<TD CLASS="menu" WIDTH="100%">&#160;<BR>
	</TD>
      </TR>
    </TABLE>
  </BODY>
</HTML>
lirc 0.9.0-0ubuntu1 / usr / share / doc / lirc / html / lircd.html
