Public/swayidle-ctrl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme.

Browse Source
This commit is contained in:
kattudden
2025-01-07 16:24:59 +01:00
parent 242b99d075
commit c991eb9c00
1 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,32 +1,30 @@
# swayidle-ctrl # swayidle-ctrl
This Go application allows you to manage a swayidle process for screen and display timeout on Sway desktops. This Go application allows you to enable or disable the swayidle service.
It would also be possible to do it directly with systemctl...
## Features ## Features
- Starts a swayidle process in the background with configurable timeouts. - stop / start the swayidle service.
- Terminates any existing swayidle process before starting a new one.
- Provides a flag to disable screen and display timeout functionalities.
## Usage ## Usage
This application can be run from the command line. Here's how: This application can be run from the command line. Here's how:
``` ```txt
swayidle-ctrl -t1 <timeout1> -t2 <timeout2> [-off] swayidle-ctrl [-on|-off]
Arguments: Arguments:
-t1 (default: 300): Sets the timeout in seconds for screen lock activation. -on (default: false): Enables screen lock and display timeout functionalities.
-t2 (default: 600): Sets the timeout in seconds for display power off.
-off (default: false): Disables screen lock and display timeout functionalities. -off (default: false): Disables screen lock and display timeout functionalities.
``` ```
### Example: ### Examples
Start swayidle with 5 minutes screen lock timeout and 10 minutes display power off timeout: Enable screen lock and display timeout:
``` bash ``` bash
swayidle-ctrl -t1 300 -t2 600 swayidle-ctrl -on
``` ```
Disable screen lock and display timeout: Disable screen lock and display timeout:
@@ -45,13 +43,12 @@ swayidle-ctrl -off
### Additional Notes ### Additional Notes
* This application uses `sh -c` to execute the swayidle command. You might need to adjust this based on your specific setup. - This application uses `sh -c` to execute the swayidle command. You might need to adjust this based on your specific setup.
* The application terminates any existing `swayidle` process before starting a new one. This ensures you don't have multiple instances running concurrently. - The application terminates any existing `swayidle` process before starting a new one. This ensures you don't have multiple instances running concurrently.
* Consider adding support for additional swayidle functionalities or configuration options in future versions. - Consider adding support for additional swayidle functionalities or configuration options in future versions.
This readme provides a basic overview of the application. You can customize it further by adding information about: This readme provides a basic overview of the application. You can customize it further by adding information about:
* Contributing guidelines - Contributing guidelines
* License information - License information
* Troubleshooting tips - Troubleshooting tips