-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathrgb_keyboard.1
93 lines (93 loc) · 3.41 KB
/
rgb_keyboard.1
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
.TH RGB_KEYBOARD 1
.SH NAME
rgb_keyboard \- Controls the RGB lighting on some keyboards.
.SH SYNOPSIS
.B rgb_keyboard
[\fIOPTIONS\fR]...
.SH DESCRIPTION
Controls the RGB lighting on keyboards with VID 0x0c45 and PID 0x652f or 0x7903.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Print a help message.
.TP
\fB\-Y\fR, \fB\-\-layout\fR
Select the keyboard layout: ansi (default), brazil, brazil_k552rgb1, iso. This affects custom led patterns, keymapping and the keynames.
.TP
\fB\-L\fR, \fB\-\-list\-keys\fR=\fIARGUMENT\fR
List valid keynames (argument: led, map, option)
.TP
\fB\-p\fR, \fB\-\-profile\fR=\fINUMBER\fR
Set profile to which the settings are applied (1-3)
.TP
\fB\-a\fR, \fB\-\-active\fR=\fINUMBER\fR
Set currently active profile (1-3)
.TP
\fB\-c\fR, \fB\-\-color\fR=\fICOLOR\fR
Sets color of the current animation (format: rrggbb or "multi")
.TP
\fB\-b\fR, \fB\-\-brightness\fR=\fINUMBER\fR
Sets brightness of the current animation (0-9, 0-5 for keyboards that use control transfer mode like the Ajazz AK33)
.TP
\fB\-s\fR, \fB\-\-speed\fR=\fINUMBER\fR
Sets speed of the current animation (0-3)
.TP
\fB\-d\fR, \fB\-\-direction\fR=\fIARGUMENT\fR
Sets direction of the current animation ("left", "right", "up", "down", "inwards", "outwards")
.TP
\fB\-l\fR, \fB\-\-leds\fR=\fIARGUMENT\fR
Sets the led mode (pattern), valid values are: fixed, sine, rain, waterfall, vortex, swirl, breathing, breathing\-color, reactive\-ripple, reactive\-single, reactive\-horizontal, reactive-color, horizontal\-wave, vertical\-wave, diagonal\-wave, pulse, hurricane, ripple, custom, off
.TP
\fB\-v\fR, \fB\-\-variant\fR=\fIARGUMENT\fR
Sets the variant of the reactive color mode ("red", "yellow", "green", "blue")
.TP
\fB\-P\fR, \fB\-\-custom\-pattern\fR=\fIFILE\fR
Sets pattern in custom mode from specified file
.TP
\fB\-K\fR, \fB\-\-custom\-keys\fR=\fIARGUMENT\fR
Sets pattern in custom mode from commandline
.TP
\fB\-R\fR, \fB\-\-report\-rate\fR=\fINUMBER\fR
Sets USB report rate (125, 250, 500, 1000) Hz
.TP
\fB\-M\fR, \fB\-\-keymap\fR=\fIFILE\fR
Load keymap from specified file (WARNING: this risks permanent damage to the keyboard)
.TP
\fB\-r\fR, \fB\-\-read\fR
Read and print stored settings from the keyboard (experimental).
.TP
\fB\-B\fR, \fB\-\-bus\fR=\fINUMBER\fR
Specify USB bus id, must be used with --device
.TP
\fB\-D\fR, \fB\-\-device\fR=\fINUMBER\fR
Specify USB device number, must be used with --bus
.TP
\fB\-k\fR, \fB\-\-kernel\-driver\fR
Do not attempt to detach the kernel drivers. Useful for compatibility on some systems.
.TP
\fB\-I\fR, \fB\-\-interface0\fR
Do not open usb interface 0. Allows input to occur while settings are applied.
.TP
\fB\-C\fR, \fB\-\-control\fR=\fItrue|false\fR
Enables or disables experimental support for keyoards that use USB control transfers to send data, e.g. the Ajazz AK33 or Redragon keyboards. This option replaced the \fB\-A\fR (\fB\-\-ajazzak33\fR) option.
.SH EXAMPLES
To set a specific led mode, color, speed and brightness.
.PP
.nf
.RS
rgb_keyboard --brightness 5 --speed 2 --color 00ff00 --leds rain
.RE
.fi
.PP
To set a custom pattern from a file,
.PP
.nf
.RS
rgb_keyboard --custom-pattern example.conf
.RE
.fi
.PP
.SH FILES
Examples can be found in \fI/usr/share/doc/rgb_keyboard\fR.
.SH COPYRIGHT
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.