| RATBAGCTL(1) | General Commands Manual | RATBAGCTL(1) |
NAME¶
ratbagctl - inspect and modify configurable mice
SYNOPSIS¶
ratbagctl [<options>] list
ratbagctl [<options>] <device>
<command> ...
DESCRIPTION¶
The ratbagctl tool queries or changes a device's settings.
This tool usually needs ratbagd to be running.
OPTIONS¶
- --version, -V
- Show program's version number and exit.
- --verbose, -v
- Print debugging output. Multiple -v options increase the verbosity. For example, -vvv will show the protocol output.
- --nocommit
- Do not immediately write the settings to the mouse. This allows multiple parameters to be set in a script, and the last call to ratbagctl will write them all.
- --help, -h
- Print the help.
General Commands¶
- list
- List supported devices (does not take a device argument)
Device Commands¶
Profile Commands¶
- profile active get
- Print the currently active profile
- profile active set N
- Set profile N as to the active profile
- profile N {COMMAND}
- Use profile N for COMMAND
Available COMMANDs:
Resolution Commands¶
Resolution commands work on the given profile, or on the active profile if none is given.
- resolution active get
- Print the currently active resolution
- resolution active set N
- Set resolution N as the active resolution
- resolution default get
- Print the current default resolution
- resolution default set N
- Set resolution N as the default resolution
- resolution N {COMMAND}
- Use resolution N for COMMAND
Available COMMANDs:
- get
- Print selected resolution
- [dpi|rate] ...
- Use resolution N for the specified command.
DPI Commands¶
DPI commands work on the given profile and resolution, or on the active resolution of the active profile if none are given.
- dpi get
- Print the dpi value
- dpi get-all
- Print the supported dpi values
- dpi set N
- Set the dpi value to N
Rate Commands¶
Rate commands work on the given profile and resolution, or on the active resolution of the active profile if none are given.
- rate get
- Print the report rate in ms
- rate get-all
- Print the supported report rates in ms
- rate set N
- Set the report rate in N ms
Button Commands¶
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.
LED Commands¶
LED commands work on the given profile, or on the active profile if none is given.
- led get
- Print the current led values
- led N get
- Print the selected LED value
- led N {COMMAND}
- Use led N for COMMAND
Available COMMANDs:
- mode [on|off|cycle|breathing]
- The mode to set as current
- color RRGGBB
- The color to set as current (the color should be in the hexadecimal format).
- rate R
- The rate to set as current
- brightness B
- The brightness to set as current
Examples¶
NOTES¶
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.
AUTHORS¶
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.17 |