diff --git a/docs/_shortcuts/shortcut-overlay.png b/docs/_shortcuts/shortcut-overlay.png deleted file mode 100644 index 2e444f56..00000000 Binary files a/docs/_shortcuts/shortcut-overlay.png and /dev/null differ diff --git a/docs/cheatsheet.md b/docs/cheatsheet.md index 36a174d0..001a8e34 100644 --- a/docs/cheatsheet.md +++ b/docs/cheatsheet.md @@ -121,6 +121,8 @@ Here are **first steps guides** for each PiKVM device: PiKVM V3 and V4 will automatically reboot after several minutes of being halted. DIY PiKVM will need a power cord reconnection to become available again. +??? note "Sending keyboard shortcuts to target host systems" + {!shortcuts.md!} ----- ## Getting User Support diff --git a/docs/_shortcuts.md b/docs/shortcuts.md similarity index 85% rename from docs/_shortcuts.md rename to docs/shortcuts.md index eda94a92..96cf90a3 100644 --- a/docs/_shortcuts.md +++ b/docs/shortcuts.md @@ -1,5 +1,5 @@ --- -title: Sending shortcuts +title: Sending Shortcuts description: "How to send shortcuts to atarget host system with PiKVM" --- @@ -13,7 +13,7 @@ Operating systems deal with modifier keys differently, so it's difficult to get When you press a magic key, the web UI starts accumulating a sequence of modifier keys you press, for example, `Ctrl L` and `Alt L` in `Ctrl+Alt+Del`, and displays a guiding overlay: -![screenshot](_shortcuts/shortcut-overlay.webp) +![Shortcuts overlay](shortcuts/shortcut-overlay.png) As soon as you press one non-modifier key, the web UI stop accumulating keys and sends the entire sequence of the keys you pressed to the target host system. @@ -68,4 +68,18 @@ PiKVM will send `Win` to the target host system which open the Start menu. ## Setting up a magic key -TBD \ No newline at end of file +You can define which key to use as the magic key. Follow these steps: + +1. In the web UI, open the **System** menu. + +2. Click on the drop-down list next to **Shortcuts magic**. + +3. Select the key the you will use as the magic key. + +![Selecting the magic key](shortcuts/web-ui-magic-key-selector.png) + +PiKVM defaults to `Ctrl Right` on all major desltop systems, but the list of available keys is platform-specific: + +- **Windows**: `Ctrl`, `Alt`, `Shift`, and `Meta`. +- **macOS**: `Ctrl`, `Option`, and `Shift`. +- **Linux**: `Ctrl`, `Alt`, `Shift`, and `Meta`. \ No newline at end of file diff --git a/docs/shortcuts/shortcut-overlay.png b/docs/shortcuts/shortcut-overlay.png new file mode 100644 index 00000000..2bf9aa71 Binary files /dev/null and b/docs/shortcuts/shortcut-overlay.png differ diff --git a/docs/shortcuts/web-ui-magic-key-selector.png b/docs/shortcuts/web-ui-magic-key-selector.png new file mode 100644 index 00000000..3ae3a940 Binary files /dev/null and b/docs/shortcuts/web-ui-magic-key-selector.png differ diff --git a/docs/v1.md b/docs/v1.md index 368ee576..977e2b94 100644 --- a/docs/v1.md +++ b/docs/v1.md @@ -264,6 +264,8 @@ To do that: - **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface. +- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system. + - Tune the HDMI dongle capture device if you're using it: ??? note "Persistent HDMI cable connection with USB dongle" diff --git a/docs/v2.md b/docs/v2.md index 094058b3..c270ced9 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -295,6 +295,8 @@ To do that: - **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface. +- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system. + - Tune the HDMI dongle capture device if you're using it: ??? note "Persistent HDMI cable connection with USB dongle" diff --git a/docs/v3.md b/docs/v3.md index b18123a2..c6e0e269 100644 --- a/docs/v3.md +++ b/docs/v3.md @@ -250,6 +250,8 @@ To do that: - **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface. +- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system. + - **Set up [ATX connection](atx_board.md)** if you need to control the power of the remote system. diff --git a/docs/v4.md b/docs/v4.md index 51180d86..7ac5e6d8 100644 --- a/docs/v4.md +++ b/docs/v4.md @@ -234,6 +234,8 @@ To do that: - **Get to know PiKVM Web UI**: read [this help section](webui.md) to better understand all the possibilities of the web user interface. +- **Configure the magic key**: define which key to use to start [sending shortcuts](shortcuts.md) to the target host system. + - **Set up an [ATX connection](atx_board.md)** if you need to control the power of the remote system. diff --git a/mkdocs.yml b/mkdocs.yml index 422e28eb..6f012b2c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -109,6 +109,7 @@ nav: - "Getting started": - "Cheat Sheet": cheatsheet.md - "Web UI Overview": webui.md + - "Sending Shortcuts": shortcuts.md - "Configuring PiKVM": config.md - "Authentication & 2FA": auth.md - "FAQ & Troubleshooting": faq.md