Skip to content

Improve config file documentation #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve config file documentation #177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d7ae5e
Detail command quoting/escaping in man page
sirlark Dec 14, 2024
1107201
Add example config file to man page
sirlark Dec 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion swayidle.1.scd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ command line and in the config file.
session after <timeout> seconds. Adding an idlehint event will also cause
swayidle to call SetIdleHint(false) when run, on resume, unlock, etc.

All commands are executed in a shell.
All commands are executed in a shell, and should be quoted or escaped appropriately if the command contains whitespace of other special shell characters.

# SIGNALS

Expand Down Expand Up @@ -98,6 +98,16 @@ It will also lock your screen before your computer goes to sleep.
To make sure swayidle waits for swaylock to lock the screen before it releases the
inhibition lock, the *-w* options is used in swayidle, and *-f* in swaylock.

The events can alternatively be put into a configuration file as follows:

```
timeout 300 'swaylock -f -c 000000'
timeout 600 'swaymsg "output * power off"' resume 'swaymsg "output * power on"'
before-sleep 'swaylock -f -c 000000'
```

If a default location is chosen, the swayidle instantiation is then simply `swayidle -w`.

# AUTHORS

Maintained by Drew DeVault <[email protected]>, who is assisted by other open
Expand Down