ratbagctl - inspect and modify configurable mice

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.18                                          RATBAGCTL(1)

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

       buttoncount
               Print the number of buttons

       buttonNget
               Print the selected button

       buttonNactionget
               Print the button action

       buttonNactionsetbuttonB
               Set the button action to button B

       buttonNactionsetspecialS
               Set the button action to special action S

       buttonNactionsetmacro...
               Set the button action to the given macro

       Macrosyntax:

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

               KEY_A   Press and release 'a'

               +KEY_A  Press 'a'

               -KEY_A  Release 'a'

               t300    Wait 300ms

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

       This tool usually needs ratbagd to be running.

info    Print information about a device

       name    Print the device name

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

       dpiget Print the dpi value

       dpiget-all
               Print the supported dpi values

       dpisetN
               Set the dpi value to N

       ratbagctl profile active get eventX

       ratbagctl profile 0 resolution active set 4 eventX

       ratbagctl profile 0 resolution 1 dpi get eventX

       ratbagctl resolution 4 rate get eventX

       ratbagctl dpi set 800 eventX

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

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

       ledget Print the current led values

       ledNget
               Print the selected LED value

       ledN{COMMAND}
               Use led N for COMMAND

       AvailableCOMMANDs:mode[on|off|cycle|breathing]
                      The mode to set as current

              colorRRGGBB
                      The color to set as current (the color should be in the hexadecimal format).

              rateR  The rate to set as current

              brightnessB
                      The brightness to set as current

       ratbagctl - inspect and modify configurable mice

       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.

--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.

profileactiveget
               Print the currently active profile

       profileactivesetN
               Set profile N as to the active profile

       profileN{COMMAND}
               Use profile N for COMMAND

       AvailableCOMMANDs:get     Print selected profile information

              nameget
                      Print the name of the profile

              namesetblah
                      Set the name of the profile

              enable  Enable a profile

              disable Disable a profile

              [resolution|dpi|rate|button|led]...
                      Use profile N for the specified command.

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

       rateget
               Print the report rate in ms

       rateget-all
               Print the supported report rates in ms

       ratesetN
               Set the report rate in N ms

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

       resolutionactiveget
               Print the currently active resolution

       resolutionactivesetN
               Set resolution N as the active resolution

       resolutiondefaultget
               Print the current default resolution

       resolutiondefaultsetN
               Set resolution N as the default resolution

       resolutionN{COMMAND}
               Use resolution N for COMMAND

       AvailableCOMMANDs:get     Print selected resolution

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

ratbagctl [<options>] listratbagctl [<options>] <device> <command> ...