Skip to content

docs(ipc): idle inhibit persists across restarts, plus the two undocumented verbs - #138

Merged
purian23 merged 1 commit into
AvengeMedia:masterfrom
Mark2Mac:document-idle-inhibit-persistence
Aug 23, 2026
Merged

docs(ipc): idle inhibit persists across restarts, plus the two undocumented verbs#138
purian23 merged 1 commit into
AvengeMedia:masterfrom
Mark2Mac:document-idle-inhibit-persistence

Conversation

@Mark2Mac

Copy link
Copy Markdown
Contributor

Companion to AvengeMedia/DankMaterialShell#3123, which makes the idle inhibitor survive a shell restart.

Persistence. Before that change the inhibitor lived only in memory, so dms restart — or systemd bringing the service back under Restart=on-failure — silently turned it off. Worth stating in the docs, because "Keep Awake" that quietly stops keeping the machine awake is the kind of thing you only notice once the screen has locked.

Two missing verbs. While in this section: inhibit implements five functions and the table listed three. Both additions were checked against a running shell rather than read off the source:

dms ipc call inhibit status      → Idle inhibit is enabled
dms ipc call inhibit reason ""   → Current reason: Keep system awake

reason is documented as taking a required argument because the CLI rejects the bare form (Too few arguments provided) even though the QML handler treats an empty string as a read — so the empty string is the documented way to query it.

Edited docs/ only, not versioned_docs/: the persistence change lands in a release that has not been cut yet. Happy to split the two verbs into their own PR if you would rather keep this one to the persistence note.

Persistence: the inhibitor now survives a shell restart (AvengeMedia/DankMaterialShell#3123).
Before that change it lived only in memory, so `dms restart` — or systemd
bringing the service back under Restart=on-failure — silently turned it off.
Worth stating explicitly, because "Keep Awake" that quietly stops keeping the
machine awake is the kind of thing you only notice when the screen locks.

While in this section, two verbs the shell implements were missing from the
table. Both checked against a running shell rather than read off the source:

  dms ipc call inhibit status      -> "Idle inhibit is enabled"
  dms ipc call inhibit reason ""   -> "Current reason: Keep system awake"

`reason` is documented as taking a required argument because the CLI rejects
the bare form ("Too few arguments provided") even though the QML handler treats
an empty string as a read.

Edited docs/ only, not versioned_docs/: the persistence lands in a release that
has not been cut yet.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants