This is an automatic generated email to let you know that the following patch were queued at the http://git.linuxtv.org/v4l-utils.git tree:
Subject: ir-keytable.1 Add standard manpage markup codes Author: Hans de Goede <[email protected]> Date: Tue Jan 25 12:37:05 2011 +0100 Add standard manpage markup codes to bold the command name and arguments, italic the argument options, etc. Signed-off-by: Hans de Goede <[email protected]> utils/keytable/ir-keytable.1 | 145 ++++++++++++++++++++++++++---------------- 1 files changed, 90 insertions(+), 55 deletions(-) --- http://git.linuxtv.org/v4l-utils.git?a=commitdiff;h=1d83485731d2395b4fb126f045a41372252851ef diff --git a/utils/keytable/ir-keytable.1 b/utils/keytable/ir-keytable.1 index dbd6ebe..3598b9f 100644 --- a/utils/keytable/ir-keytable.1 +++ b/utils/keytable/ir-keytable.1 @@ -1,68 +1,103 @@ -.TH ir-keytable 1 2011-01-24 http://linuxtv.org/ "Media v4l2-utils commands" swiss-knife tool to handle Remote Controllers +.TH "IR\-KEYTABLE" "1" "January 2011" "v4l-utils" "User Commands" .SH NAME -ir-keytable - a swiss-knife tool to handle Remote Controllers. +ir\-keytable \- a swiss\-knife tool to handle Remote Controllers. .SH SYNOPSIS -Usage: ir-keytable [OPTION...] --device [/dev/input/event* device] - or: ir-keytable [OPTION...] --sysdev [ir class (f. ex. rc0)] - or: ir-keytable [OPTION...] [for using the rc0 sysdev] +.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 to get/set IR keycode/scancode tables, test events generated by IR, and to adjust other options to it. - -Note: You need to have read permissions on /dev/input for most of the options to work. +ir\-keytable is a tool that lists the Remote Controller devices, allows 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 - -a, --auto-load=CFGFILE Auto-load a table, based on a configuration file. - Only works with sysdev. - -c, --clear clears the old table - -d, --device=DEV ir device to control - -k, --set-key=SCANKEY Change scan/key pairs - -p, --protocol=PROTOCOL Protocol to enable (the other ones will be - disabled). To enable more than one, use the option - more than one time - -r, --read reads the current scancode/keycode table - -s, --sysdev=SYSDEV ir class device to control - -t, --test test if IR is generating events - -v, --verbose enables debug messages - -w, --write=TABLE write (adds) the scancodes to the device - scancode/keycode table from an specified file - -?, --help Prints the help message - --usage Give a short usage message - -V, --version Print the v4l2-utils version - +.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\-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\-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. - -On the options bellow, the arguments are: - DEV - the /dev/input/event* device to control - SYSDEV - the ir class as found at /sys/class/rc - TABLE - a file wit a set of scancode=keycode value pairs - SCANKEY - a set of scancode1=keycode1,scancode2=keycode2.. value pairs - PROTOCOL - protocol name (nec, rc-5, rc-6, other) to be enabled - CFGFILE - configuration file that associates a driver/table name with a keymap file - +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 (nec, rc\-5, rc\-6, other) to be enabled +.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 - Common usages are: +To list all connected Remote Controller devices: +.br + \fBir\-keytable\fR .PP - To list all connected Remote Controller devices: +To clean the keycode table and use a newer one: +.br + \fBir\-keytable \-c \-w /etc/rc_keymaps/nec_terratec_cinergy_xs\fR .PP - ir-keytable +To append more codes to the existing table: +.br + \fBir\-keytable \-w /etc/rc_keymaps/nec_terratec_cinergy_xs\fR .PP - To clean the keycode table and use a newer one: -.PP - ir-keytable -c -w /etc/rc_keymaps/nec_terratec_cinergy_xs -.PP - To append more codes to the existing table: -.PP - ir-keytable -w /etc/rc_keymaps/nec_terratec_cinergy_xs -.PP - To read the current keytable, on the second remote controller: -.PP - ir-keytable -s rc1 -r - +To read the current keytable, on the second remote controller: + \fBir\-keytable \-s rc1 \-r\fR +.SH BUGS +Report bugs to Mauro Carvalho Chehab <[email protected]> .SH COPYRIGHT -Copyright (c) 2010-2011 by Mauro Carvalho Chehab <[email protected]>. -.PP +Copyright (c) 2010\-2011 by Mauro Carvalho Chehab <[email protected]>. +.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. _______________________________________________ linuxtv-commits mailing list [email protected] http://www.linuxtv.org/cgi-bin/mailman/listinfo/linuxtv-commits
