1RATBAGCTL(1)                General Commands Manual               RATBAGCTL(1)
2
3
4

NAME

6       ratbagctl - inspect and modify configurable mice
7

SYNOPSIS

9       ratbagctl [<options>] list
10       ratbagctl [<options>] <device> <command> ...
11

DESCRIPTION

13       The ratbagctl tool queries or changes a device's settings.
14
15       This tool usually needs ratbagd to be running.
16

OPTIONS

18       --version, -V
19               Show program's version number and exit.
20
21       --verbose, -v
22               Print  debugging  output. Multiple -v options increase the ver‐
23               bosity. For example, -vvv will show the protocol output.
24
25       --nocommit
26               Do not immediately write the settings to the mouse. This allows
27               multiple parameters to be set in a script, and the last call to
28               ratbagctl will write them all.
29
30       --help, -h
31               Print the help.
32

General Commands

34       list    List supported devices (does not take a device argument)
35

Device Commands

37       info    Print information about a device
38
39       name    Print the device name
40

Profile Commands

42       profile active get
43               Print the currently active profile
44
45       profile active set N
46               Set profile N as to the active profile
47
48       profile N {COMMAND}
49               Use profile N for COMMAND
50
51       Available COMMANDs:
52
53              get     Print selected profile information
54
55              name get
56                      Print the name of the profile
57
58              name set blah
59                      Set the name of the profile
60
61              enable  Enable a profile
62
63              disable Disable a profile
64
65              [resolution|dpi|rate|button|led] ...
66                      Use profile N for the specified command.
67

Resolution Commands

69       Resolution commands work on the given profile, or on the active profile
70       if none is given.
71
72       resolution active get
73               Print the currently active resolution
74
75       resolution active set N
76               Set resolution N as the active resolution
77
78       resolution default get
79               Print the current default resolution
80
81       resolution default set N
82               Set resolution N as the default resolution
83
84       resolution N {COMMAND}
85               Use resolution N for COMMAND
86
87       Available COMMANDs:
88
89              get     Print selected resolution
90
91              [dpi|rate] ...
92                      Use resolution N for the specified command.
93

DPI Commands

95       DPI commands work on the given profile and resolution, or on the active
96       resolution of the active profile if none are given.
97
98       dpi get Print the dpi value
99
100       dpi get-all
101               Print the supported dpi values
102
103       dpi set N
104               Set the dpi value to N
105

Rate Commands

107       Rate commands work on the given profile and resolution, or on  the  ac‐
108       tive resolution of the active profile if none are given.
109
110       rate get
111               Print the report rate in ms
112
113       rate get-all
114               Print the supported report rates in ms
115
116       rate set N
117               Set the report rate in N ms
118

Button Commands

120       Button  commands work on the given profile, or on the active profile if
121       none is given.
122
123       button count
124               Print the number of buttons
125
126       button N get
127               Print the selected button
128
129       button N action get
130               Print the button action
131
132       button N action set button B
133               Set the button action to button B
134
135       button N action set special S
136               Set the button action to special action S
137
138       button N action set macro ...
139               Set the button action to the given macro
140
141       Macro syntax:
142
143       A macro is a series of key events or  waiting  periods.  Keys  must  be
144               specified in linux/input-event-codes.h key names.
145
146               KEY_A   Press and release 'a'
147
148               +KEY_A  Press 'a'
149
150               -KEY_A  Release 'a'
151
152               t300    Wait 300ms
153

LED Commands

155       LED  commands  work  on  the given profile, or on the active profile if
156       none is given.
157
158       led get Print the current led values
159
160       led N get
161               Print the selected LED value
162
163       led N {COMMAND}
164               Use led N for COMMAND
165
166       Available COMMANDs:
167
168              mode [on|off|cycle|breathing]
169                      The mode to set as current
170
171              color RRGGBB
172                      The color to set as current (the color should be in  the
173                      hexadecimal format).
174
175              rate R  The rate to set as current
176
177              brightness B
178                      The brightness to set as current
179

Examples

181       ratbagctl profile active get eventX
182
183       ratbagctl profile 0 resolution active set 4 eventX
184
185       ratbagctl profile 0 resolution 1 dpi get eventX
186
187       ratbagctl resolution 4 rate get eventX
188
189       ratbagctl dpi set 800 eventX
190

NOTES

192       There  is  currently  no  guarantee that the output format of ratbagctl
193       will not change in the future. There should be some stability with  the
194       commands  mentioned  in this man page, but do not expect it to stay the
195       same.
196

AUTHORS

198       ratbagctl was written by David Herrmann, Peter  Hutterer  and  Benjamin
199       Tissoires.
200
201       This manual page was written by Stephen Kitt <skitt@debian.org> for the
202       Debian GNU/Linux system (but may be used by others).
203
204
205
206                                     0.17                         RATBAGCTL(1)