aboutsummaryrefslogtreecommitdiffstats
path: root/desktop/modules/vm/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-14 12:38:36 +0200
committerDanilo M. <danix@danix.xyz>2026-09-14 12:38:36 +0200
commit901e7d83f8af3defe2c602daad98fd3c67e1dd7c (patch)
tree75d64e7c30ce018ca8237eba4535877f0162d50b /desktop/modules/vm/README.md
parent54f028ed563daed9b49bf1fabee9d47060335304 (diff)
downloadquickshell-901e7d83f8af3defe2c602daad98fd3c67e1dd7c.tar.gz
quickshell-901e7d83f8af3defe2c602daad98fd3c67e1dd7c.zip
docs: correct drawer exit behaviour and dead module commands
The README claimed a click outside returns to the grid; it closes the drawer, and only Escape-with-a-page or the back arrow return to the grid. The three moved module READMEs' run and IPC commands still named the deleted volume-osd, mail-overview and vm-manager paths, so point them at qs -p desktop and ipc call drawer open sound|mail|vm.
Diffstat (limited to 'desktop/modules/vm/README.md')
-rw-r--r--desktop/modules/vm/README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/desktop/modules/vm/README.md b/desktop/modules/vm/README.md
index 03ad1b5..79c60f5 100644
--- a/desktop/modules/vm/README.md
+++ b/desktop/modules/vm/README.md
@@ -3,8 +3,9 @@
> **Now the `vm` module of the `desktop/` shell.** It is no longer a
> standalone component: start the shell with `qs -p desktop` and open the page
> from the drawer, or deep-link with `qs -p desktop ipc call drawer open vm`.
-> The `vm-manager` paths and the `panel toggle` IPC below are historical. See
-> `desktop/README.md`.
+> See `desktop/README.md`; the `blur-vm-manager` namespace in the Theme section
+> below is historical, since this page now rides the drawer's
+> `quickshell-desktop` surface.
A drawer for libvirt virtual machines: state, live statistics, the actions
that make sense in the current state, and the snapshot list. It replaces the
@@ -20,17 +21,18 @@ menu half of `rofi-qemu.sh`, which could only ever show a list of strings.
## Running it
- qs -p .
+ qs -p ./desktop
-`SUPER+v` toggles it, through an IPC call, so the shell has to be running
-first. Both are wired in the Hyprland config:
+The vm page is reached from the drawer, or deep-linked directly with
+`qs -p ./desktop ipc call drawer open vm`. `SUPER+v` does exactly that, so the
+shell has to be running first. Both are wired in the Hyprland config:
-- autostart.lua
- hl.exec_cmd("qs -p ~/Programming/GIT/quickshell/vm-manager")
+ hl.exec_cmd("qs -p ~/Programming/GIT/quickshell/desktop")
-- keybindings.lua
hl.bind(mainMod .. " + v", hl.dsp.exec_cmd(
- "qs -p ~/Programming/GIT/quickshell/vm-manager ipc call panel toggle"))
+ "qs -p ~/Programming/GIT/quickshell/desktop ipc call drawer open vm"))
Write those two paths out in full in the real config: `exec_cmd` runs the
command directly, with no shell to expand `~`.