✨ Add the Mouse section (#350)

yannbertrand · amomchilov · yannbertrand · commit 09f4a3c5e355 · 2024-03-25T12:04:51.000+01:00
* ✨ Add mouse linear acceleration command

* ✨ Add mouse scaling command

* 🚚 Move mouse focus follow command

---------

Co-authored-by: Alexander Momchilov &lt;amomchilov@users.noreply.github.com&gt;
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -323,6 +323,17 @@ export default defineConfig({
           },
         ],
       },
+      {
+        text: 'Mouse',
+        items: [
+          { text: 'Disable acceleration', link: '/mouse/linear.md' },
+          {
+            text: 'Set movement speed',
+            link: '/mouse/scaling.md',
+          },
+          { text: 'Focus Follows Mouse', link: '/mouse/focusfollowsmouse.md' },
+        ],
+      },
       {
         text: 'Trackpad',
         items: [
@@ -445,7 +456,6 @@ export default defineConfig({
             text: 'Key held down behavior',
             link: '/misc/applepressandholdenabled.md',
           },
-          { text: 'Focus Follows Mouse', link: '/misc/focusfollowsmouse.md' },
           {
             text: 'Close confirm changes popup',
             link: '/misc/nsclosealwaysconfirmschanges.md',
diff --git a/docs/index.md b/docs/index.md
@@ -134,6 +134,12 @@ defaults rename ${domain} ${old_key} ${new_key}
 - [Flash clock time separators](./menubar/flashdateseparators.md)
 - [Set menubar digital clock format](./menubar/dateformat.md)
 
+### Mouse
+
+- [Disable acceleration](./mouse/linear.md)
+- [Set movement speed](./mouse/scaling.md)
+- [Focus Follows Mouse](./mouse/focusfollowsmouse.md)
+
 ### Trackpad
 
 - [Click weight (threshold)](./trackpad/firstclickthreshold.md)
@@ -182,7 +188,6 @@ defaults rename ${domain} ${old_key} ${new_key}
 - [Show Music song notifications](./misc/userwantsplaybacknotifications.md)
 - [Disable application quarantine message](./misc/lsquarantine.md)
 - [Key held down behavior](./misc/applepressandholdenabled.md)
-- [Focus Follows Mouse](./misc/focusfollowsmouse.md)
 - [Close confirm changes popup](./misc/nsclosealwaysconfirmschanges.md)
 - [Function keys behavior](./misc/applekeyboardfnstate.md)
 
diff --git a/docs/misc/index.md b/docs/misc/index.md
@@ -21,6 +21,5 @@ All the others `defaults` that don't deserve their own category.
 - [Show Music song notifications](./userwantsplaybacknotifications.md)
 - [Disable application quarantine message](./lsquarantine.md)
 - [Key held down behavior](./applepressandholdenabled.md)
-- [Focus Follows Mouse](./focusfollowsmouse.md)
 - [Close confirm changes popup](./nsclosealwaysconfirmschanges.md)
 - [Function keys behavior](./applekeyboardfnstate.md)
diff --git a/docs/mouse/focusfollowsmouse.md b/docs/mouse/focusfollowsmouse.md
@@ -1,10 +1,10 @@
 ---
-title: Focus Follows Mouse | Miscellaneous
+title: Focus Follows Mouse | Mouse
 description: Focus of the Terminal windows when the mouse cursor hovers over them. The focus change only works between the Terminal windows.
 head:
   - - meta
     - property: 'og:title'
-      content: macOS defaults > Miscellaneous > Focus Follows Mouse
+      content: macOS defaults > Mouse > Focus Follows Mouse
   - - meta
     - property: 'og:description'
       content: Focus of the Terminal windows when the mouse cursor hovers over them. The focus change only works between the Terminal windows.
diff --git a/docs/mouse/images/FocusFollowsMouse/false.mp4 b/docs/mouse/images/FocusFollowsMouse/false.mp4
diff --git a/docs/mouse/images/FocusFollowsMouse/true.mp4 b/docs/mouse/images/FocusFollowsMouse/true.mp4
diff --git a/docs/mouse/index.md b/docs/mouse/index.md
@@ -0,0 +1,21 @@
+---
+title: Mouse
+description: The hardware device to control the cursor.
+head:
+  - - meta
+    - property: 'og:title'
+      content: macOS defaults > Mouse
+  - - meta
+    - property: 'og:description'
+      content: The hardware device to control the cursor.
+---
+
+# Mouse
+
+The hardware device to control the cursor.
+
+## Keys
+
+- [Disable acceleration](./linear.md)
+- [Set movement speed](./scaling.md)
+- [Focus Follows Mouse](./focusfollowsmouse.md)
diff --git a/docs/mouse/linear.md b/docs/mouse/linear.md
@@ -0,0 +1,65 @@
+---
+title: Mouse | Acceleration
+description: Disable mouse acceleration.
+head:
+  - - meta
+    - property: 'og:title'
+      content: macOS defaults > Mouse > Acceleration
+  - - meta
+    - property: 'og:description'
+      content: Enable or disable mouse acceleration
+---
+
+# Acceleration
+
+Enable or disable mouse acceleration.
+
+By default, macOS has mouse acceleration enabled, which causes the cursor to move less when you slowly move the mouse, and much more when you move the mouse faster.
+
+The underlying acceleration curve (which determines how much movement you get at any given mouse speed) is not customizable without third party tools.
+
+⚠️ A restart of your Mac is required to apply these changes.
+
+<!-- break lists -->
+
+- **Tested on macOS**:
+  - Sonoma
+- **Parameter type**: bool
+
+## Requirements
+
+This setting was introduced in macOS 14 Sonoma.
+
+## Disable mouse acceleration
+
+Disabling mouse acceleration can be preferable for gaming, because it's more amenable to building muscle-memory.
+
+```bash
+defaults write NSGlobalDomain com.apple.mouse.linear -bool "true"
+```
+
+## Enable mouse acceleration (default value)
+
+Turning on mouse acceleration can be preferable if you have limited desk space for mouse movements, and need to cover a large screen area.
+
+```bash
+defaults write NSGlobalDomain com.apple.mouse.linear -bool "false"
+```
+
+## Read current value
+
+```bash
+defaults read NSGlobalDomain com.apple.mouse.linear
+```
+
+## Reset to default value
+
+```bash
+defaults delete NSGlobalDomain com.apple.mouse.linear
+```
+
+## Set value from UI
+
+1. <a href="x-apple.systempreferences:com.apple.Mouse-Settings.extension">Access Mouse settings from macOS UI</a>
+2. Open the Advanced panel
+3. Toggle "Pointer acceleration" value
diff --git a/docs/mouse/scaling.md b/docs/mouse/scaling.md
@@ -0,0 +1,77 @@
+---
+title: Mouse | Speed
+description: Set movement speed of the mouse cursor.
+head:
+  - - meta
+    - property: 'og:title'
+      content: macOS defaults > Mouse > Speed
+  - - meta
+    - property: 'og:description'
+      content: Set movement speed of the mouse cursor
+---
+
+# Speed
+
+Set movement speed of the mouse cursor.
+
+⚠️ A restart of your Mac is required to apply these changes.
+
+<!-- break lists -->
+
+- **Tested on macOS**:
+  - Sonoma
+  - Venura
+  - Monterey
+  - Big Sur
+  - Catalina
+  - Mojave
+  - High Sierra
+  - Sierra
+  - El Capitan
+  - Yosemite
+  - Mavericks
+  - Mountain Lion
+  - Lion
+  - Snow Leopard
+  - Leopard
+- **Parameter type**: float
+
+## Set to `1` (default value)
+
+By default, the mouse movement scale factor is 1x.
+
+```bash
+defaults write NSGlobalDomain com.apple.mouse.scaling -float "1"
+```
+
+This setting is listed in the Mouse preference pane as the "Tracking speed" slider. Its ticks give the following values:
+
+- `0.0` (which surprisingly, does not mean "no movement")
+- `0.125`
+- `0.5`
+- `0.6875`
+- `0.875`
+- `1.0`
+- `1.5`
+- `2.0`
+- `2.5`
+- `3.0`
+
+This command allows you set a scale factor greater than 3x.
+
+## Read current value
+
+```bash
+defaults read NSGlobalDomain com.apple.mouse.scaling
+```
+
+## Reset to default value
+
+```bash
+defaults delete NSGlobalDomain com.apple.mouse.scaling
+```
+
+## Set value from UI
+
+1. <a href="x-apple.systempreferences:com.apple.Mouse-Settings.extension">Access Mouse settings from macOS UI</a>
+2. Slide "Tracking speed" range value
