ir-keytable(1)

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]...
10

DESCRIPTION

12       ir-keytable  is  a  tool that lists Remote Controller devices, loads rc
13       keymaps, tests events, and adjusts other Remote Controller options.
14
15       Rather than loading a rc keymap, it is also possible  to  set  protocol
16       decoders and set rc scancode to keycode mappings directly.
17
18       Note:  You  need to have read permissions on /dev/input for most of the
19       options to work.
20

OPTIONS

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

EXIT STATUS

105       On success, it returns 0. Otherwise, it will return the error code.
106

EXAMPLES

108       To list all connected Remote Controller devices:
109            ir-keytable
110
111       To clean the keycode mapping and use a newer one:
112            ir-keytable -c -w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml
113
114       To append more codes to the existing table:
115            ir-keytable -w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml
116
117       To read the current scancode to keycode mapping on  the  second  remote
118       controller:
119            ir-keytable -s rc1 -r
120
121       To  enable  NEC  protocol and load a BPF protocol, with a parameter for
122       the BPF protocol:
123            ir-keytable -p nec,pulse_distance -e pulse_header=9000
124
125       If you do not know what protocol a remote uses, it can  be  helpful  to
126       first  try  with  all kernel decoders enabled. The decoded protocol and
127       scancodes will be displayed in the output:
128            ir-keytable -c -p all -t
129
130

BUGS

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

COPYRIGHT

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