Skip to content

Commit

Permalink
docs: mention existence and usefulness of swayidle
Browse files Browse the repository at this point in the history
  • Loading branch information
ifreund committed Oct 26, 2023
1 parent 5474e48 commit 43fb605
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ To unlock the session, type your password and press `Enter`. If the password
is correct, waylock will unlock the session and exit. Otherwise, the color
will change to the `-fail-color` and you may try again.

In order to automatically run waylock after a certain amount of time with no
input or before sleep, the [swayidle](https://github.com/swaywm/swayidle)
utility or a similar program may be used. See the `swayidle(1)` man page
for details.

## Licensing

Waylock is released under the ISC License.
6 changes: 5 additions & 1 deletion doc/waylock.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ To unlock the session, type your password and press Enter. If the password
is correct, waylock will unlock the session and exit. Otherwise, the color
will change to the *-fail-color* and you may try again.

In order to automatically run waylock after a certain amount of time with
no input or before sleep, the *swayidle*(1) utility or a similar program
may be used. See the *swayidle*(1) man page for details.

# AUTHORS

Maintained by Isaac Freund <[email protected]> who is assisted by open
Expand All @@ -67,4 +71,4 @@ https://github.com/ifreund/waylock.

# SEE ALSO

*pam*(8)
*pam*(8), *swayidle*(1)

0 comments on commit 43fb605

Please sign in to comment.