aboutsummaryrefslogtreecommitdiffstats
path: root/utils/keytable/ir-keytable.1.in
blob: ef4aabce6ec188a686fbda1ffac3405f00bab68a (plain)
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
.TH "IR\-KEYTABLE" "1" "Fri Oct 3 2014" "v4l-utils @PACKAGE_VERSION@" "User Commands"
.SH NAME
ir\-keytable \- a swiss\-knife tool to handle Remote Controllers.
.SH SYNOPSIS
.B ir\-keytable
[\fIOPTION\fR]... \fI\-\-device\fR [\fI/dev/input/event* device\fR]
.br
.B ir\-keytable
[\fIOPTION\fR]... \fI\-\-sysdev\fR [\fIrc class (f. ex. rc0)\fR]
.br
.B ir\-keytable
[\fIOPTION\fR]... [\fIfor using the rc0 sysdev\fR]
.SH DESCRIPTION
ir\-keytable is a tool that lists the Remote Controller devices, allows one to
get/set rc keycode/scancode tables, set protocol decoder, test events
generated by a rc device, and to adjust other Remote Controller options.
.PP
Note: You need to have read permissions on /dev/input for most of the
options to work.
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-auto\-load\fR=\fICFGFILE\fR
Auto\-load a table, based on a configuration file. Only works with
\fB\-\-sysdev\fR.
.TP
\fB\-c\fR, \fB\-\-clear\fR
Clears the scancode to keycode mappings.
.TP
\fB\-d\fR, \fB\-\-device\fR=\fIDEV\fR
Use specified input device.
.TP
\fB\-D\fR, \fB\-\-delay\fR=\fIDELAY\fR
Sets the delay before repeating a keystroke.
.TP
\fB\-k\fR, \fB\-\-set\-key\fR=\fISCANKEY\fR
Set scancode to keycode mapping.
.TP
\fB\-p\fR, \fB\-\-protocol\fR=\fIPROTOCOL\fR
Comma separated list of kernel protocols or BPF protocol to enable. All
other protocols are disabled.
.TP
\fB\-e\fR, \fB\-\-parameter\fR=\fIPARAMETER\fR
Comma separated list of parameters for the BPF protocol.
.TP
\fB\-P\fR, \fB\-\-period\fR\=\fiPERIOD\fR
Sets the period to repeat a keystroke.
.TP
\fB\-r\fR, \fB\-\-read\fR
Read and show the current scancode to keycode mapping.
.TP
\fB\-s\fR, \fB\-\-sysdev\fR=\fISYSDEV\fR
rc device to control
.TP
\fB\-t\fR, \fB\-\-test\fR
test if the rc device is generating events
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enables debug messages.
.TP
\fB\-w\fR, \fB\-\-write\fR=\fITABLE\fR
Reads the protocols and scancode to keycode mapping from the \fITABLE\fR file,
and enables those on the rc device.
.TP
\fB\-?\fR, \fB\-\-help\fR
Prints the help message
.TP
\fB\-\-usage\fR
Give a short usage message
.TP
\fB\-V\fR, \fB\-\-version\fR
print the v4l2\-utils version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options. Options can be combined together.
.SS The options arguments are:
.IP \fIDEV\fR
the /dev/input/event* device to control
.IP \fISYSDEV\fR
the rc class as found at /sys/class/rc
.IP \fITABLE\fR
a toml file with a list of protocols and scancode to keycode mappings.
.IP \fISCANKEY\fR
a set of scancode1=keycode1,scancode2=keycode2.. value pairs
.IP \fIPROTOCOL\fR
Comma separated list of kernel protocols to be enabled (case insensitive).
Supported kernel protocols are: \fBnec\fR, \fBrc\-5\fR, \fBrc\-6\fR, \fBjvc\fR,
\fBsony\fR, \fBsanyo\fR, \fBrc\-5\-sz\fR, \fBsharp\fR, \fBmce\-kbd\fR,
\fBxmp\fR, \fBimon\fR, \fBother\fR, \fBall\fR. It can also be a BPF protocol,
e.g. \fBmanchester\fR, \fBrc_mm\fR, \fBpulse_distance\fR, \fBpulse_length\fR.
If it does not match any of these, it is taken to be the path of BPF decoder
to be loaded.
.IP \fIPARAMETERS\fR
Comma separated list of parameters for the BPF protocol being loaded. They have the format of name=value, where value is an number.
.IP \fIDELAY\fR
Delay before repeating a keystroke
.IP \fIPERIOD\fR
Period to repeat a keystroke
.IP \fICFGFILE\fR
configuration file that associates a driver/table name with a keymap file
.SH EXIT STATUS
On success, it returns 0. Otherwise, it will return the error code.
.SH EXAMPLES
To list all connected Remote Controller devices:
.br
	\fBir\-keytable\fR
.PP
To clean the keycode table and use a newer one:
.br
	\fBir\-keytable \-c \-w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml\fR
.PP
To append more codes to the existing table:
.br
	\fBir\-keytable \-w /etc/rc_keymaps/nec_terratec_cinergy_xs.toml\fR
.PP
To read the current keytable, on the second remote controller:
	\fBir\-keytable \-s rc1 \-r\fR
.PP
To enable NEC protocol and load a BPF protocol, with a parameter for the BPF protocol:
.br
	\fBir\-keytable \-p nec,pulse_distance \-e pulse_header=9000
.PP
If you do not know what protocol a remote uses, it can be helpful to first
try with all kernel decoders enabled. The decoded protocol and scancodes
will be displayed in the output:
.br
	\fBir\-keytable \-c \-p all \-t\fR

.SH BUGS
Report bugs to \fBLinux Media Mailing List <linux-media@vger.kernel.org>\fR
.SH COPYRIGHT
Copyright (c) 2010\-2014 by Mauro Carvalho Chehab.
.PP
License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH SEE ALSO
To transmit IR or receive raw IR, see ir\-ctl(1).

Privacy Policy