aboutsummaryrefslogtreecommitdiffstats
path: root/utils/keytable/ir-keytable.1.in
blob: db1843b3c56ef3446c0fc44eaf8dd792f248c80c (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
.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 [\fIir 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 IR keycode/scancode tables, test events generated by IR, 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 sysdev.
.TP 
\fB\-c\fR, \fB\-\-clear\fR
clears the old table
.TP 
\fB\-d\fR, \fB\-\-device\fR=\fIDEV\fR
ir device to control
.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
Change scan/key pairs
.TP 
\fB\-p\fR, \fB\-\-protocol\fR=\fIPROTOCOL\fR
Protocol to enable (the other ones will be disabled). To enable more than one, 
use the option more than one time
.TP
\fB\-P\fR, \fB\-\-period\fR\=\fiPERIOD\fR
Sets the period to repeat a keystroke
.TP 
\fB\-r\fR, \fB\-\-read\fR
reads the current scancode/keycode table
.TP 
\fB\-s\fR, \fB\-\-sysdev\fR=\fISYSDEV\fR
ir class device to control
.TP 
\fB\-t\fR, \fB\-\-test\fR
test if IR is generating events
.TP 
\fB\-v\fR, \fB\-\-verbose\fR
enables debug messages
.TP 
\fB\-w\fR, \fB\-\-write\fR=\fITABLE\fR
write (adds) the scancodes to the device scancode/keycode table from the
specified \fITABLE\fR file
.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 ir class as found at /sys/class/rc
.IP \fITABLE\fR
a file wit a set of scancode=keycode value pairs
.IP \fISCANKEY\fR
a set of scancode1=keycode1,scancode2=keycode2.. value pairs
.IP \fIPROTOCOL\fR
protocol name to be enabled (case insensitive). Supported protocols are: NEC, RC-5, RC-6, JVC, SONY, SANYO, LIRC, RC-5-SZ, SHARP, MCE-KBD, XMP, other, all.
.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\fR
.PP
To append more codes to the existing table:
.br
	\fBir\-keytable \-w /etc/rc_keymaps/nec_terratec_cinergy_xs\fR
.PP
To read the current keytable, on the second remote controller:
	\fBir\-keytable \-s rc1 \-r\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.

Privacy Policy