docs(greeter): document [idle] timeout blanking#189
Merged
Conversation
Document optional greeter.toml idle blanking: timeout seconds, wake behavior (keys/buttons/touch vs motion), env override, and NixOS settings. Add troubleshooting for never-blanks / never-wakes cases. Refs noctalia-dev/noctalia-greeter#56
6 tasks
There was a problem hiding this comment.
Pull request overview
Documents the greeter’s optional [idle].timeout configuration for “idle blanking” in the v5 documentation, including config reference entries, examples, and troubleshooting guidance.
Changes:
- Added
[idle].timeoutto the configuration reference (admin-only key table +greeter.tomlexample). - Introduced a new Idle blanking section describing behavior, valid ranges, wake/activity rules, and overrides (including NixOS).
- Expanded greeter index troubleshooting to cover “never blanks” and “won’t wake” scenarios with links to the new section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/content/docs/v5/greeter/index.mdx | Adds idle-blanking references and troubleshooting links in the greeter index page. |
| src/content/docs/v5/greeter/configuration.mdx | Documents the new [idle].timeout key and adds a dedicated Idle blanking section with examples and overrides. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Optional environment override (wins when set), useful because greetd starts greeters with an empty environment: | ||
|
|
||
| ```sh | ||
| NOCTALIA_GREETER_IDLE_TIMEOUT=300 |
Contributor
Author
There was a problem hiding this comment.
Good catch — updated the example to set the variable on the greetd session command via env NOCTALIA_GREETER_IDLE_TIMEOUT=300 ….
Bare NOCTALIA_GREETER_IDLE_TIMEOUT=300 does not export into the greeter process. Document it as an env prefix on the greetd session command.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the optional
[idle].timeoutkey from noctalia-greeter#56:greeter.tomlNOCTALIA_GREETER_IDLE_TIMEOUToverride, NixOS settingsContext
Paired with the idle blanking greeter PR.
Test plan
/v5/greeter/configuration/#idle-blanking