ir should be replaced with rc. Signed-off-by: Sean Young <sean@xxxxxxxx> --- utils/keytable/ir-keytable.1.in | 86 ++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 39 deletions(-) diff --git a/utils/keytable/ir-keytable.1.in b/utils/keytable/ir-keytable.1.in index 60f9dfe9..ffd2d705 100644 --- a/utils/keytable/ir-keytable.1.in +++ b/utils/keytable/ir-keytable.1.in @@ -4,83 +4,91 @@ 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 +.br .B ir\-keytable -[\fIOPTION\fR]... \fI\-\-sysdev\fR [\fIir class (f. ex. rc0)\fR] -.br +[\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 IR keycode/scancode tables, test events generated by IR, and to -adjust other Remote Controller options. -.PP +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 +.TP \fB\-a\fR, \fB\-\-auto\-load\fR=\fICFGFILE\fR -Auto\-load a table, based on a configuration file. Only works with sysdev. -.TP +Auto\-load a table, based on a configuration file. Only works with +\fB\-\-sysdev\fR. +.TP \fB\-c\fR, \fB\-\-clear\fR -clears the old table -.TP +Clears the scancode to keycode mappings. +.TP \fB\-d\fR, \fB\-\-device\fR=\fIDEV\fR -ir device to control +Use specified input device. .TP \fB\-D\fR, \fB\-\-delay\fR=\fIDELAY\fR -Sets the delay before repeating a keystroke -.TP +Sets the delay before repeating a keystroke. +.TP \fB\-k\fR, \fB\-\-set\-key\fR=\fISCANKEY\fR -Change scan/key pairs -.TP +Set scancode to keycode mapping. +.TP \fB\-p\fR, \fB\-\-protocol\fR=\fIPROTOCOL\fR -Comma seperated list of protocols to enabled (the other ones will be disabled). Alternatively, this is the path to a BPF protocol to be loaded. +Comma seperated list of kernel protocols or BPF protocol to enable. All +other protocols are disabled. .TP \fB\-e\fR, \fB\-\-parameter\fR=\fIPARAMETER\fR -Commma seperated list of parameters for the BPF protocol +Commma seperated list of parameters for the BPF protocol. .TP \fB\-P\fR, \fB\-\-period\fR\=\fiPERIOD\fR -Sets the period to repeat a keystroke -.TP +Sets the period to repeat a keystroke. +.TP \fB\-r\fR, \fB\-\-read\fR -reads the current scancode/keycode table -.TP +Read and show the current scancode to keycode mapping. +.TP \fB\-s\fR, \fB\-\-sysdev\fR=\fISYSDEV\fR -ir class device to control -.TP +rc device to control +.TP \fB\-t\fR, \fB\-\-test\fR -test if IR is generating events -.TP +test if the rc device is generating events +.TP \fB\-v\fR, \fB\-\-verbose\fR -enables debug messages -.TP +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 +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 +.TP \fB\-\-usage\fR Give a short usage message -.TP +.TP \fB\-V\fR, \fB\-\-version\fR print the v4l2\-utils version -.PP +.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 +the rc class as found at /sys/class/rc .IP \fITABLE\fR -a file wit a set of scancode=keycode value pairs +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 protocols to be enabled (case insensitive). Supported kernel protocols are: NEC, RC-5, RC-6, JVC, SONY, SANYO, LIRC, RC-5-SZ, SHARP, MCE-KBD, XMP, IMON, other, all. There are also BPF protocols: manchester, rc_mm, pulse_distance, grundig. Alternatively, this can be the path to a BPF protocol file to be loaded. +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 seperated list of parameters for the BPF protocol being loaded. They have the format of name=value, where value is an number. .IP \fIDELAY\fR @@ -114,8 +122,8 @@ To enable NEC protocol and load a BPF protocol, with a parameter for the BPF pro Report bugs to \fBLinux Media Mailing List <linux-media@xxxxxxxxxxxxxxx>\fR .SH COPYRIGHT Copyright (c) 2010\-2014 by Mauro Carvalho Chehab. -.PP +.PP License GPLv2: GNU GPL version 2 <http://gnu.org/licenses/gpl.html>. -.br +.br This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. -- 2.11.0
