Configuring lircd (the LIRC daemon)

1. Check if there is already a config file in /usr/local/etc/lircd.conf. If not
2. check if there is a config file available for your remote control at the LIRC homepage and copy it to /usr/local/etc/lircd.conf. If not
3. start irrecord (finish all applications that access /dev/lirc first) and follow the instructions given to you by this program. Copy the resulting file to /usr/local/etc/lircd.conf.

If you want to use more than one remote control you can simply concatenate the config files: cat config1 config2 >config

Note: If you already have a config file for the libirman package you can convert it using the irman2lirc script that you can find in the contrib directory.

The lircd.conf file format

There's no description of the file format available. In fact you don't need to know anything about it except that it's maybe the most important part of the package.

Configuring lircmd (the LIRC mouse daemon)

lircmd can be used to emulate a mouse with your remote control. Depending on the config file described in the next section it converts IR signals into mouse events. It currently supports two mouse protocols. For compatibility reasons the default protocol is the MouseSystems protocol but the preferred is the IMPS/2 protocol. The advantage of this protocol is its wheel-mouse support. That way you can for example configure Netscape to scroll if you press certain buttons.

lircmd can basically be used with two applications: X11 and gpm
Configuration of both is described here:

X11

3.x

Just put this section in your XF86Config file to use the mouse in addition to your normal one.

    Section "XInput"
        Subsection "Mouse"
            Protocol    "IMPS/2"
            Device      "/dev/lircm"
            DeviceName  "Remote"
            AlwaysCore
        EndSubsection
    EndSection

        Buttons 5

Make sure you use a current version of X11. There seems to be a bug in X version 3.3 that can make X crash if you use both mouse and remote control mouse simultaneously. At least I couldn't reproduce this with other versions. I also received some notes that lircmd does not work with certain X11 versions. But almost always at least one of the protocols did work. So try them both before trying another X11 version. But always remember that you have to modify both XF86Config and lircmd.conf so they use the same protocol.

4.x

I received this configuration from a user. I didn't test it myself yet.

Section "InputDevice"
        Identifier  "Mouse2"
        Driver      "mouse"
        Option      "Protocol" "ImPS/2"
        Option      "Device" "/dev/lircm"
        Option      "DeviceName" "Remote"
        Option      "AlwaysCore"
        Option      "Buttons" "5"
EndSection

gpm

You can also e.g. use multimouse (available at ftp://sunsite.unc.edu/ or mirrors) or gpm to use it parallel to your normal mouse. With:

    gpm -t ps2 -R -M -m /dev/lircm -t imps2

    gpm -t ps2 -R -M -m /dev/lircm -t msc

Note: If you update lircmd.conf you can send the HUP signal to lircmd:

killall -HUP lircmd

The lircmd.conf file format

The config file for lircmd is quite simple. Just look at the example in the contrib directory. Some drivers even already bring their config file for lircmd with them so lircmd is ready to run.

PROTOCOL  <protocol>

You can choose between MouseSystems and IMPS/2 protocol. The default is MouseSystems protocol.

ACCELERATOR  <start> <max> <multiplier>

Change the values here if your mouse pointer is moving too fast/slow. Usually the mouse pointer moves 1 pixel every time it receives a signal. The values here specify how much mouse movement accelerates if you hold down the according button on your remote control for a longer timer. The start value is the threshold that starts acceleration. Then the amount of pixels is calculated with the following formula: x=repeat*multiplier, where repeat is the number of repeated signals. max specifies the maximum number of pixels the pointer can move due to a single command.

ACTIVATE  <remote> <button>

TOGGLE_ACTIVATE  <remote> <button>

I recommend that you use a special button to activate the mouse daemon with this command. You will see whenever the daemon is activated/deactivated directly on the screen. If you omit this command the daemon will always be active.

The difference between ACTIVATE and TOGGLE_ACTIVATE is how you leave the mouse mode. With TOGGLE_ACTIVATE you have to press the button that you use to enter the mode to leave it. With ACTIVATE you will leave mouse mode as soon as you press a button that is not used for any function in the config file.

MOVE_ [ N [ E | W ] | E | S [ E | W ] | W ]  <remote> <button>

The obvious functionality. You can even get better granularity by combing different commands (copied from the config file for AnimaX remotes):

MOVE_N    ANIMAX_MOUSE_PAD   MOUSE_NNE
MOVE_NE   ANIMAX_MOUSE_PAD   MOUSE_NNE

This also demonstrates that all commands are executed beginning at the top.

MOVE_[IN|OUT]  <remote> <button>

This will only work with the IMPS/2 protocol and indicates movement of the wheel.

The .lircrc file format

At this point all you need are the tools, which react on the signals decoded by lircd. To do this you need a file called .lircrc. It should be placed in your home directory. The idea is to have configuration information of all clients in one place. That lets you keep a better overview of clients and simplifies the use of modes explained later.

First I will explain the syntax of the .lircrc file itself. The config file for LIRC tools consists of one or more of the following constructions:

    begin
	prog	= ...
	remote	= ...
	button	= ...
	repeat	= ...
	config	= ...
	mode	= ...
	flags	= ...
    end

Bringing it to the point the above says which program (prog) should do what (config, mode, flags) if you press a certain button (remote, button) a specified time (repeat).

prog

gives the name of the program that should receive the config string given in config.

remote, button

specify a key of a remote control that launches an action. Key sequences can be specified by giving more then one remote/button string. The character '*' can be used as a wild card for remote or button. The default for remote is '*'.

repeat

tells the program what shall happen if a key is repeated. A value of zero tells the program to ignore repeated keys. Any other positive value 'n' tells the program to pass the config string every 'n'-th time to the according application, when a key is repeated. The default for repeat is zero.

config

is the string that will be passed to the according application whenever the specified key sequence is received by lircd. If you give more than one config string, the config strings will be passed to the applications by turns. With this feature you can for example implement toggle buttons.
You can pass non-printable characters to applications with all standard C escape sequences (most common are: \n = line-feed, \r = carriage return, \t = tab, \e = escape, \<n> = ASCII code in octal representation, \x<n> = ASCII code in hexadecimal representation, \\ = backslash). Additionally you can supply Ctrl-X by specifying \X where X is an upper character or @. For example \C is Ctrl-C.

mode

tells the program to enter a special mode. You can group several configurations by putting them into the following, where mode stands for the mode where these configurations should be active:

    begin mode
	...
    end mode

If mode is equal to the name of a client application this application will always start in this mode. Consider this situation: you want to start xawtv with irexec and enter the tv mode. Then irexec would enter the tv mode but xawtv would begin without any mode enabled. By renaming the mode from tv to xawtv you can solve this problem.
Another way to specify a startup mode is by using the startup_mode flag as described bellow.

once

This is only allowed in conjunction with the mode directive. The config string is passed to the application only the first time the mode is entered or you have explicitly left this mode. This is useful for starting an application whenever you enter a special mode.

quit

Usually all configurations are examined if they have to be executed. You can stop this immediately with this flag.

mode

This is only allowed within a mode block. It tells the program to leave this mode.

startup_mode

Tells the program to start in the mode given in the mode keyword. The following example tells the program to start in the browser mode

begin
	flags = startup_mode
	mode = browser
end

Ok, now a simple example for a .lircrc file (supposed you use an AnimaX remote and use the sample files for this remote from the remotes/ directory. If you have another remote change remote= and button= according to your remote [this definitions are made in the lircd.conf file] )

    begin
        remote = ANIMAX
        button = MENU_DOWN
        prog   = irexec
        repeat = 0
        config = echo "Hello world!"
    end

If you have saved this as .lircrc in your home directory, start irexec. Press the button which is selected in the button= line and you will see a 'Hello world!' on your screen. As you can see irexec is a simple program launcher. Of course you can do a lot more than just start programs.

If you start a LIRC client program, it reads your ~/.lircrc and reacts only on prog= entries which point to itself. All programs should give you the possibility to use an alternative config file. If you have included more than one program in your .lircrc, then start all these programs, they react only to their according entries in .lircrc. This also leads to a disadvantage of the mode concept. If you don't start all client programs at a time the mode they have to maintain may differ between applications. Also key sequences might not be recognized equally because all programs then don't have the same starting point.