Solaar/docs
danielbanariba 2e3ec225e1 docs: add a worked-through MX Master 3/3S configuration page
Users arriving from Logitech Options+ or LogiOps look for a list of behaviours
and instead have to discover that a button does nothing until its diversion is
changed, and that some things are settings with no rule at all. That split is
the usual reason a first rule appears not to fire.

Add a page that walks through one device end to end: which of its buttons can be
diverted and under what names, the settings that need no rules, a diverted button
driving a key combination, mouse gestures, and the thumb wheel — including the
integer argument to the thumb wheel tests, without which a wheel action fires far
too often to be useful.

Also covers what does not carry over from LogiOps: control ids are not used,
key names are X11 key symbols rather than evdev names, and running both daemons
against one device makes settings appear to revert at random.

Records which conditions are limited under Wayland, since actions go through
uinput and do work there, while Modifiers and Process do not.

Contents checked against an MX Master 3S on a Logi Bolt receiver.
2026-08-13 23:06:29 -06:00
..
devices centurion: support PRO X 2 LIGHTSPEED headphones Centurion features (#3150) 2026-04-14 11:43:23 -04:00
img docs: Use mkdocs for public documentation (#2527) 2024-07-01 08:03:50 -04:00
screenshots docs: Move screenshots into dedicated folder 2024-05-16 15:55:44 -04:00
.gitignore pre-commit: initial fix 2020-07-07 15:11:15 +01:00
20121210110342697.pdf new UI mock-up from Julien Gascard 2012-12-12 21:45:37 +02:00
LICENSE.txt docs: update files shown in documentation 2025-10-23 09:28:52 -04:00
PRO_X2_SUPERSTRIKE_CLI.md device: Add PRO X 2 Superstrike mouse support with HITS tuning settings (#3132) 2026-04-12 09:53:47 -04:00
README.text docs: update files shown in documentation 2025-10-23 09:28:52 -04:00
capabilities.md docs: document haptic capability 2026-04-18 16:31:17 -04:00
debian.md cleanup and lint the docs 2020-08-02 11:25:00 -04:00
devices.md docs: mention Centurion protocol in documentation 2026-04-14 12:31:33 -04:00
features.md device: Add PRO X 2 Superstrike mouse support with HITS tuning settings (#3132) 2026-04-12 09:53:47 -04:00
hidpp-documentation.txt docs: remove logitech files and outdated information; update supported features 2020-07-11 15:36:49 -04:00
i18n.md po: add Irish translation (#3256) 2026-06-11 15:50:43 -04:00
implementation.md docs: improve documentation on onboard profiles 2025-03-29 09:22:59 -04:00
index.md docs: mention Centurion protocol in documentation 2026-04-18 16:31:17 -04:00
installation.md docs: document change to use uinput only 2026-03-08 20:58:43 -04:00
issues.md release 1.1.20rc2 2026-05-24 10:14:45 -04:00
mx-master.md docs: add a worked-through MX Master 3/3S configuration page 2026-08-13 23:06:29 -06:00
rules.md docs: add a worked-through MX Master 3/3S configuration page 2026-08-13 23:06:29 -06:00
uninstallation.md docs: give uninstallation file correct name 2025-09-08 13:28:39 -04:00
usage.md docs: improve documentation for cli actions 2024-08-23 20:03:54 -04:00
usb.ids.txt docs: update the USB IDs list 2019-12-29 14:46:59 +00:00

README.text

# Documentation Readme

This project's documentation is hosted using GitHub pages, which serves static pages using Jekyll.
[Please refer to the official documentation for instructions for how to build the site locally.](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)