RATBAGCTL(1) General Commands Manual RATBAGCTL(1)

ratbagctl - inspect and modify configurable mice

ratbagctl [OPTIONS] {COMMAND} ... device

The ratbagctl tool queries or changes a device's settings.

This tool usually needs ratbagd to be running.

Show program's version number and exit.
Print debugging output. Multiple -v options increase the verbosity. For example, -vvv will show the protocol output.
Do not immediately write the settings to the mouse. This allows to set multiple parameters in a script, and the last call to ratbagctl will write them all.
Print the help.

List supported devices (does not take a device argument)

Print information about a device
Print the device name

Print the currently active profile
Set profile N as to the active profile
Use profile N for COMMAND

Available COMMANDs:

Print selected profile information
name get
Print the name of the profile
name set blah
Set the name of the profile
Enable a profile
Disable a profile
[resolution|dpi|rate|button|led] ...
Use profile N for the specified command.

Resolution commands work on the given profile, or on the active profile if none is given.

Print the currently active resolution
Set resolution N as the active resolution
Print the current default resolution
Set resolution N as the default resolution
Use resolution N for COMMAND

Available COMMANDs:

Print selected resolution
[dpi|rate] ...
Use resolution N for the specified command.

DPI commands work on the given profile and resolution, or on the active resolution of the active profile if none are given.

Print the dpi value
Print the supported dpi values
Set the dpi value to N

Rate commands work on the given profile and resolution, or on the active resolution of the active profile if none are given.

Print the report rate in ms
Print the supported report rates in ms
Set the report rate in N ms

Button commands work on the given profile, or on the active profile if none is given.

Print the number of buttons
Print the selected button
Print the button action
Set the button action to button B
Set the button action to special action S
Set the button action to the given macro

Macro syntax:

A macro is a series of key events or waiting periods. Keys must be specified in linux/input-event-codes.h key names.

Press and release 'a'
+KEY_A
Press 'a'
Release 'a'
Wait 300ms

LED commands work on the given profile, or on the active profile if none is given.

Print the current led values
Print the selected LED value
Use led N for COMMAND

Available COMMANDs:

The mode to set as current
The color to set as current (the color should be in the hexadecimal format).
The rate to set as current
The brightness to set as current

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

ratbagctl was written by David Herrmann, Peter Hutterer and Benjamin Tissoires.

This manual page was written by Stephen Kitt <skitt@debian.org> for the Debian GNU/Linux system (but may be used by others).

0.16