Fix #941: Update links from http: to https: where possible
[geeqie.git] / doc / docbook / GuideReferenceLIRC.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideReferenceLIRC">
3   <title id="titleGuideReferenceLIRC">Infra-red controller</title>
4   <para>Recent Linux kernels have in-built support for ir devices, making lirc support redundant.</para>
5   <para>If you wish to use lirc with Geeqie, the lirc libraries must be installed. If you are compiling from sources, lirc functionality will be available if the library dependencies are met.</para>
6   <para>If you are using a pre-compiled distribution, availability depends on the package maintainer.</para>
7   <para>
8     The website
9     <ulink url="https://www.lirc.org">Linux Infrared Remote Control</ulink>
10     has detailed information on this subject.
11   </para>
12   <para>
13     You will need to create a configuration file for the controller you will use. This file must be installed at the location specified in
14     <link linkend="GuideReferenceConfig" endterm="titleGuideReferenceConfig" />
15     .
16   </para>
17   <para>
18     Here is an excerpt from an .lircrc file:
19     <programlisting>
20       begin geeqie
21       begin
22       prog = geeqie
23       button = vol_up
24       config = ZOOM_IN 1
25       repeat = 3
26       end
27     </programlisting>
28   </para>
29   <para>The commands Geeqie will respond to are:</para>
30   <table frame="all">
31     <tgroup cols="2" rowsep="1" colsep="1">
32       <thead rowsep="1" colsep="1">
33         <row>
34           <entry>Command</entry>
35           <entry>Mapped to</entry>
36         </row>
37       </thead>
38       <tbody rowsep="1" colsep="1">
39         <row>
40           <entry>DOWN [int]</entry>
41           <entry>Pan down by the specified amount. Default=1</entry>
42         </row>
43         <row>
44           <entry>EXIT</entry>
45           <entry>Exit Geeqie</entry>
46         </row>
47         <row>
48           <entry>FIRST</entry>
49           <entry>Jump to first image</entry>
50         </row>
51         <row>
52           <entry>INFO</entry>
53           <entry>Show image overlay (full screen only)</entry>
54         </row>
55         <row>
56           <entry>LAST</entry>
57           <entry>Jump to last image</entry>
58         </row>
59         <row>
60           <entry>LEFT [int]</entry>
61           <entry>Pan left by the specified amount. Default=1</entry>
62         </row>
63         <row>
64           <entry>NEXT</entry>
65           <entry>Go to next image</entry>
66         </row>
67         <row>
68           <entry>PAUSE</entry>
69           <entry>Pause/unpause slideshow</entry>
70         </row>
71         <row>
72           <entry>PREV</entry>
73           <entry>Go to previous image</entry>
74         </row>
75         <row>
76           <entry>RIGHT [int]</entry>
77           <entry>Pan right by the specified amount. Default=1</entry>
78         </row>
79         <row>
80           <entry>ROTATE_90       ]</entry>
81           <entry>Rotate image 90 degrees clockwise.     .</entry>
82         </row>
83         <row>
84           <entry>ROTATE_90_CC</entry>
85           <entry>Rotate image 90 degrees counter-clockwise..</entry>
86         </row>
87         <row>
88           <entry>SET_INV_ZOOM [int]</entry>
89           <entry>Set Zoom level to 1:N. Default=1x</entry>
90         </row>
91         <row>
92           <entry>SET_ZOOM [int]</entry>
93           <entry>Set Zoom level to N:1. Default=1x</entry>
94         </row>
95         <row>
96           <entry>UP [int]</entry>
97           <entry>Pan up by the specified amount. Default=1</entry>
98         </row>
99         <row>
100           <entry>ZOOM_IN  [int]</entry>
101           <entry>Zoom in. Value specifies the amount of zoom.</entry>
102         </row>
103         <row>
104           <entry>ZOOM_MAX       ]</entry>
105           <entry>Zoom to fit image to window</entry>
106         </row>
107         <row>
108           <entry>ZOOM_OUT [int]</entry>
109           <entry>Zoom out. Value specifies the amount of zoom.</entry>
110         </row>
111       </tbody>
112     </tgroup>
113   </table>
114   <para />
115 </section>