Skip to content
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

Jump to bottom

document xsuspender's autostart capability #30

Merged
merged 6 commits into from
Dec 21, 2021
Merged

document xsuspender's autostart capability #30

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2183079
document xsuspenders autostart capability
tpo Dec 18, 2021
067210b
improve autostart documentation
tpo Dec 21, 2021
8ed3cba
Update README.md
tpo Dec 21, 2021
1e49cf7
make documentation of log location stand out
tpo Dec 21, 2021
1dfaafd
Add correct hyperlink to issue
tpo Dec 21, 2021
d89c30f
Apply suggestions from code review
kernc Dec 21, 2021
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
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,19 @@ For brief usage instructions, run:
xsuspender --help
```

#### Automatically starting xsuspender

Upon installation there will be a `/etc/xdg/autostart/xsuspender.dektop`
file which allows you to autostart xsuspender on the start of your
desktop. You need to explicitly enable autostarting xsuspender in your
desktop's session management settings - this amounts to the same as copying
`/etc/xdg/autostart/xsuspender.dektop` to `~/.config/autostart/` and setting
`Hidden=false`.

If you let xsuspender autostart, then you need to be aware of spurious
suspended app lock-ups such as in [GH-11](https://github.com/kernc/xsuspender/issues/11)
and be ready to mitigate them.

#### Configuration debugging

To have it print verbose debug messages about what it is doing, run the
Expand All @@ -112,8 +125,10 @@ program with environmental variable `G_MESSAGES_DEBUG=xsuspender` set:
This is _strongly recommended_ to confirm your customized configuration
rules indeed work as you expect.

If xsuspender is auto run by your X session manager, you might find clues
to its unexpected behavior in _~/.xsession-errors_.
#### Logs

If xsuspender is autostarted by your X session manager, you might find clues
to its unexpected behavior in `~/.xsession-errors`.

Notes
-----
Expand Down