aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPavan Jadhaw <pavanjadhaw96@gmail.com>2018-09-17 19:10:37 +0530
committerPavan Jadhaw <pavanjadhaw96@gmail.com>2018-09-17 19:10:37 +0530
commitf2639f97114e402b7199859eeff75f6ee9314d9f (patch)
treef7880fd0dc4e3deea077d1fbd50fc2fed979619d /README.md
parent031140d5c440cc613630047d80d564a971e1e70e (diff)
Add instructions to use custom lockscreen text
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 356446b..c43cfed 100644
--- a/README.md
+++ b/README.md
@@ -23,12 +23,18 @@ without the need to apply same effect again and again
```
# Lock screen
betterlockscreen -l | --lock [modifier]
+
+# Lock screen with custom text
+betterlockscreen -l | --lock [modifier] -t | --text "custom lockscreen text"
+E.g: $ betterlockscreen -l dim -t \"Don't touch my machine!\""
+
# Set wallpaper
betterlockscreen -w | --wall [modifier]
# Suspend system
betterlockscreen -s | --suspend [modifier]
# Update image cache
-betterlockscreen -u | --update (path/to/image.png | path/to/directory) [-r | --resolution <resolution>] [-b | --blur <factor>]
+betterlockscreen -u | --update (path/to/image.png | path/to/directory)
+ \ [-r | --resolution <resolution>] [-b | --blur <factor>]
Modifiers:
dim
@@ -40,7 +46,6 @@ betterlockscreen -u path/to/directory -r 1920x1080 -b 0.5
In this case a random image from the directory is chosen, and converted to a 1920x1080 resolution with the blur factor set to 0.5
```
-
## Installation via AUR package
### [release](https://aur.archlinux.org/packages/betterlockscreen/)