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

NAME

6       ratbagctl - inspect and modify configurable mice
7

SYNOPSIS

9       ratbagctl [OPTIONS] {COMMAND} ... device
10

DESCRIPTION

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

OPTIONS

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

General Commands

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

Device Commands

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

Profile Commands

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

Resolution Commands

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

DPI Commands

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

Rate Commands

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

Button Commands

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

LED Commands

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

Examples

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

NOTES

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

AUTHORS

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