File: lircin.docbook

package info (click to toggle)
lcdproc 0.5.9-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,088 kB
  • sloc: ansic: 59,645; sh: 1,740; perl: 681; makefile: 417
file content (200 lines) | stat: -rw-r--r-- 4,640 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<sect1 id="lirc">
<title>The lirc Driver</title>

<para>
The <code>lirc</code> driver enables you to use any IR remote control
that works with <package>LIRC</package> to control the LCDproc server
<application>LCDd</application> and/or clients that can handle input.
</para>

<para>
Of course you need a working LIRC setup. Refer to the
<ulink url="http://www.lirc.org">LIRC project</ulink> for more
information on LIRC itself.
</para>

<sect2 id="lirc-install">
<title>Checking Your LIRC Setup</title>

<para>
Basically all you need is a running <application>lircd</application>.
And of course you have to start <application>lircd</application>
as root.
</para>

<para>
Also, make sure that the permission of <filename>/dev/lircd</filename>
are correct.
</para>

</sect2>

<sect2 id="lirc-configure">
<title>Build LCDd with the lirc Driver</title>

<para>
You need to add lirc to the --enable-drivers=... list.
</para>

<para>
Then simply run make.
</para>

</sect2>

<sect2 id="lirc-configuration">
<title>Configure LCDd to Use the lirc Driver</title>

<para>
First of all you need to activate the driver by adding a <code>Driver=lirc</code> line
to your <filename>LCDd.conf</filename>
</para>

<example id="lirc-configuration.example">
<title><filename>LCDd.conf</filename>: Activate the lirc driver</title>

<programlisting>
 Driver=mtxorb
 Driver=lirc
</programlisting>
</example>

<para>
This activates the <code>mtxorb</code> driver as the output driver
and the <code>lirc</code> driver as the input driver.
</para>

<para>
Then you have to modify the <code>[lirc]</code> section of your
<filename>LCDd.conf</filename>.
</para>

</sect2>

<!-- ## LIRC input driver ## -->
<sect2 id="lirc-config">
<title>Configuration in LCDd.conf</title>

<sect3 id="lirc-config-section">
<title>[lirc]</title>

<variablelist>
<varlistentry>
  <term>
    <property>lircrc</property> =
    <parameter><replaceable>FILENAME</replaceable></parameter>
  </term>
  <listitem>
    <para>
    <anchor id="which-lircrc" />
    Normally all LIRC clients scan the file <filename>~/.lircrc</filename>.
    However, you might want to have a separate file to configure the LCDproc lirc driver only.
    </para>
    <para>
    This option enables you to specify the file you want the lirc driver to scan.
    If not given it defaults to <filename>~/.lircrc</filename>.
    </para>
  </listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>Prog</property> =
    <parameter><replaceable>PROGRAM</replaceable></parameter>
  </term>
  <listitem>
    <para>
    All LIRC keys are assigned to a program using the <literal>prog=...</literal>
    directive in the lirc configuration file.
    </para>
    <para>
    <replaceable>PROGRAM</replaceable> must be the same as in your lirc
    configuration file.
    </para>
  </listitem>
</varlistentry>
</variablelist>

</sect3>

</sect2>

<sect2 id="lircrc">
<title>Modify Your <filename>~/.lircrc</filename></title>

<para>
As mentioned above you can either modify the <filename>~/.lircrc</filename>
or use a separate file for the lirc LCDproc driver (See
<link linkend="which-lircrc">above</link> for details).
</para>

<para>
No matter which file you use, you have to add at least the following
lines to the file:
</para>

<example id="lircrc.example">
<title><filename>~/.lircrc</filename>: Specify the associations from buttons to keys
for the lirc driver</title>

<programlisting>
begin
        prog = lcdd
        button = 2
        config = Up
end

begin
        prog = lcdd
        button = 4
        config = Left
end

begin
        prog = lcdd
        button = 6
        config = Right
end

begin
        prog = lcdd
        button = 8
        config = Down
end

begin
        prog = lcdd
        button = 1
        config = Escape
end

begin
        prog = lcdd
        button = 0
        config = Enter
end
</programlisting>
</example>

<para>
Which buttons you specify here depends on your remote control and your LIRC configuration.
</para>

<para>
The <literal>config</literal> values need to be one of <literal>Up</literal>,
<literal>Down</literal>, <literal>Left</literal>, <literal>Right</literal>,
<literal>Escape</literal> or <literal>Enter</literal>.
For LCDd's server menu at least the keys <literal>Up</literal>, <literal>Escape</literal>
and <literal>Enter</literal> are necessary.
</para>

<para>
<!-- TODO: is this still true with 0.5 ? -->
Of course you can define other keys. Those keys will not be handled by the
server but sent to a client. Refer to the documentation of the client you want
to use, to find out which keys are necessary for that client.
</para>

</sect2>

</sect1>