RATSLAP(1)

πŸ“¦ version 0.4.1, in nixos 26.05, nixpkgs unstable

πŸ’– RATSLAP(1) β€” like, the Logitech mouse configurator, bestie πŸ’–

okay so real quick, this is a User Commands page for ratslap, and honestly? she's iconic. let's get into it ✨


🌸 NAME 🌸

ratslap β€” the configuration tool for Logitech mice (and rn it only does the G300/G300S, no cap).


πŸ¦‹ SYNOPSIS πŸ¦‹

ratslap -h|--help
ratslap -V|--version
ratslap --listkeys
ratslap -s|--select MODE
ratslap -p|--print MODE
ratslap -m|--modify MODIFY_OPTIONS...

✨ DESCRIPTION ✨

So the whole vibe of RatSlap is: give you a way to configure your configurable Logitech mice from inside Linux. That's it, that's the mission, and she ate πŸ’…

The Logitech G300/G300s has 3 button modes. And for each one of those modes you can assign an LED colour, a report rate (that's the speed at which the mouse communicates with the computer), DPI setting(s), and button/key combinations. like a whole little personality for each mode, obsessed πŸŽ€

Want the full list of available keys and buttons you can bind each mouse button to? Just run ratslap with the --listkeys option. easy 🫢

NOTE: You literally cannot remap the scrollwheel. Nope. These generate button 4 (up) and 5 (down) and cannot be changed. that's just the rules, periodt πŸ’€

Most of the OPTIONS below can be chained together, like this:

ratslap -p F3 -m F4 -c blue -s F4

The above command would print out F3; select F4 for modification and change it's LED colour to blue; then select F4 as the current mode. see how she flows? 🌈

This is most useful when you want to configure more than one mode at once, such as restoring a specific state for the entire mouse. honestly a lifesaver 😭


πŸ‘‘ OPTIONS πŸ‘‘

RatSlap more or less follows the usual GNU command line syntax, with long options starting with two dashes (-), and short with one. classic, we love a traditional icon ⭐

  • -h, --help β€” Show summary of options. your little guide bestie πŸ’–
  • -V, --version β€” Show version of program.
  • --listkeys β€” Lists all possible modifiers, buttons and keys for assignment. the full menu, iykyk πŸ“
  • -s MODE, --select MODE β€” Switches to MODE. Valid *MODE*s are "F3", "F4" and "F5" (case insensative). pick your girl πŸ¦‹
  • -p MODE, --print MODE β€” Prints out MODE's current button mapping. show me what you're working with πŸ’…
  • -m MODE, --modify MODE β€” Modifies MODE using MODIFY_OPTIONS (see below). glow-up time ✨

🧚 MODIFY_OPTIONS 🧚

The following options modify the current MODE selected for modification (using -m|--modify, see above). so like, you gotta pick a mode first or these are just floating, bestie πŸ™ˆ

  • -r RATE, --rate RATE β€” Set the report rate of the mouse to RATE. Valid *RATE*s are "125", "250", "500", "1000", measured in hertz (times per second). speed check πŸ”₯
  • -A DPI, --D1 DPI β€” Sets the DPI value for sensitivity level 1 to DPI. Valid *DPI*s range from 250 to 4000, at intervals of 250.
  • -B DPI, --D2 DPI β€” Sets the DPI value for sensitivity level 2 to DPI. Valid *DPI*s range from 250 to 4000, at intervals of 250.
  • -C DPI, --D3 DPI β€” Sets the DPI value for sensitivity level 3 to DPI. Valid *DPI*s range from 250 to 4000, at intervals of 250.
  • -D DPI, --D4 DPI β€” Sets the DPI value for sensitivity level 4 to DPI. Valid *DPI*s range from 250 to 4000, at intervals of 250.
  • -F LEVEL, --default-dpi LEVEL β€” Selects which DPI sensitivity level (1–4) is the default. main character level πŸ’œ
  • -S [DPI], --dpishift [DPI] β€” Enables the DPI shift function. If DPI is specified, also sets the shifted DPI to that value. Valid *DPI*s range from 250 to 4000, at intervals of 250.
  • -U, --no-dpishift β€” Disables the DPI shift function. The currently set value is not changed. no take-backs on the number itself 🫢
  • -c COLOUR, --colour COLOUR, --color COLOUR β€” Set the colour of the mouse to COLOUR. Valid *COLOUR*s are "BLACK" (off), "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN" and "WHITE" (case insensative). aesthetic upgrade, periodt 🌈
  • -1 KEYS, --left KEYS β€” Binds mouse button 1 (the left mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -2 KEYS, --right KEYS β€” Binds mouse button 2 (the right mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -3 KEYS, --middle KEYS β€” Binds mouse button 3 (the middle mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -4 KEYS, --G4 KEYS β€” Binds mouse button 4 (the G4 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -5 KEYS, --G5 KEYS β€” Binds mouse button 5 (the G5 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -6 KEYS, --G6 KEYS β€” Binds mouse button 6 (the G6 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -7 KEYS, --G7 KEYS β€” Binds mouse button 7 (the G7 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -8 KEYS, --G8 KEYS β€” Binds mouse button 8 (the G8 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.
  • -9 KEYS, --G9 KEYS β€” Binds mouse button 9 (the G9 mouse button) to KEYS. For a list of valid modifiers, keys and buttons that can be assigned, use the --listkeys option.

and that's the whole page, bestie!! πŸŽ€πŸ’–βœ¨

okay final sign-off, this is ratslap version 0.4.1, dated August 2020, and that's genuinely the whole manual page. go configure your mouse, she's waiting πŸ’…πŸ¦‹πŸ‘‘

πŸ“¦ where this page comes from