1IR-KEYTABLE(1)                   User Commands                  IR-KEYTABLE(1)
2
3
4

NAME

6       ir-keytable - a swiss-knife tool to handle Remote Controllers.
7

SYNOPSIS

9       ir-keytable [OPTION]... --device [/dev/input/event* device]
10       ir-keytable [OPTION]... --sysdev [rc class (f. ex. rc0)]
11       ir-keytable [OPTION]... [for using the rc0 sysdev]
12

DESCRIPTION

14       ir-keytable  is a tool that lists the Remote Controller devices, allows
15       one to get/set rc keycode/scancode tables, set protocol  decoder,  test
16       events  generated by a rc device, and to adjust other Remote Controller
17       options.
18
19       Note: You need to have read permissions on /dev/input for most  of  the
20       options to work.
21

OPTIONS

23       -a, --auto-load=CFGFILE
24              Auto-load  a  table,  based  on a configuration file. Only works
25              with --sysdev.
26
27       -c, --clear
28              Clears the scancode to keycode mappings.
29
30       -d, --device=DEV
31              Use specified input device.
32
33       -D, --delay=DELAY
34              Sets the delay before repeating a keystroke.
35
36       -k, --set-key=SCANKEY
37              Set scancode to keycode mapping.
38
39       -p, --protocol=PROTOCOL
40              Comma separated list of kernel  protocols  or  BPF  protocol  to
41              enable. All other protocols are disabled.
42
43       -e, --parameter=PARAMETER
44              Comma separated list of parameters for the BPF protocol.
45
46       -P, --period=PERIOD
47              Sets the period to repeat a keystroke.
48
49       -r, --read
50              Read and show the current scancode to keycode mapping.
51
52       -s, --sysdev=SYSDEV
53              rc device to control
54
55       -t, --test
56              test if the rc device is generating events
57
58       -v, --verbose
59              Enables debug messages.
60
61       -w, --write=TABLE
62              Reads the protocols and scancode to keycode mapping from the TA‐
63              BLE file, and enables those on the rc device.
64
65       -?, --help
66              Prints the help message
67
68       --usage
69              Give a short usage message
70
71       -V, --version
72              print the v4l2-utils version
73
74       Mandatory or optional arguments to long options are also  mandatory  or
75       optional  for  any corresponding short options. Options can be combined
76       together.
77
78   The options arguments are:
79       DEV    the /dev/input/event* device to control
80
81       SYSDEV the rc class as found at /sys/class/rc
82
83       TABLE  a toml file with a list of protocols  and  scancode  to  keycode
84              mappings.
85
86       SCANKEY
87              a set of scancode1=keycode1,scancode2=keycode2.. value pairs
88
89       PROTOCOL
90              Comma  separated  list  of  kernel protocols to be enabled (case
91              insensitive).  Supported kernel protocols are: nec, rc-5,  rc-6,
92              jvc,  sony,  sanyo,  rc-5-sz,  sharp, mce-kbd, xmp, imon, other,
93              all. It can also be a  BPF  protocol,  e.g.  manchester,  rc_mm,
94              pulse_distance,  pulse_length.   If  it  does  not  match any of
95              these, it is taken to be the path of BPF decoder to be loaded.
96
97       PARAMETERS
98              Comma separated list of parameters for the  BPF  protocol  being
99              loaded.  They  have  the format of name=value, where value is an
100              number.
101
102       DELAY  Delay before repeating a keystroke
103
104       PERIOD Period to repeat a keystroke
105
106       CFGFILE
107              configuration file that associates a driver/table  name  with  a
108              keymap file
109

EXIT STATUS

111       On success, it returns 0. Otherwise, it will return the error code.
112

EXAMPLES

114       To list all connected Remote Controller devices:
115            ir-keytable
116
117       To clean the keycode table and use a newer one:
118            ir-keytable -c -w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml
119
120       To append more codes to the existing table:
121            ir-keytable -w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml
122
123       To  read  the  current  keytable,  on  the  second  remote  controller:
124            ir-keytable -s rc1 -r
125
126       To enable NEC protocol and load a BPF protocol, with  a  parameter  for
127       the BPF protocol:
128            ir-keytable -p nec,pulse_distance -e pulse_header=9000
129

BUGS

131       Report bugs to Linux Media Mailing List <linux-media@vger.kernel.org>
132

134       Copyright (c) 2010-2014 by Mauro Carvalho Chehab.
135
136       License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
137       This  is  free  software:  you  are free to change and redistribute it.
138       There is NO WARRANTY, to the extent permitted by law.
139
140
141
142v4l-utils 1.16.5                Fri Oct 3 2014                  IR-KEYTABLE(1)
Impressum