rename script to fit repo name (#11)

* rename script to fit repo name

* obviously also update the docu
This commit is contained in:
Philipp Hemmelmayr 2017-12-14 04:10:51 +01:00 committed by Pavan Jadhaw
parent 0799a2ff8d
commit 80a69a42a9
2 changed files with 36 additions and 28 deletions

View file

@ -95,19 +95,19 @@ chmod +x lock.sh
*Grab your favourite image for lockscreen background* *Grab your favourite image for lockscreen background*
``` ```
./lock.sh -u path/to/image.img betterlockscreen -u path/to/image.img
``` ```
*if you want to use random image from specific directory* *if you want to use random image from specific directory*
``` ```
./lock.sh -u path/to/imagedir betterlockscreen -u path/to/imagedir
``` ```
*set random image as desktop background too* *set random image as desktop background too*
``` ```
./lock.sh -u path/to/imagedir && ./lock.sh -w betterlockscreen -u path/to/imagedir && betterlockscreen -w
``` ```
--- ---
@ -117,25 +117,25 @@ chmod +x lock.sh
Original image as background Original image as background
``` ```
./lock.sh -l betterlockscreen -l
``` ```
Use dimmed image as lockscreen background Use dimmed image as lockscreen background
``` ```
./lock.sh -l dim betterlockscreen -l dim
``` ```
Use blurred image as lockscreen background Use blurred image as lockscreen background
``` ```
./lock.sh -l blur betterlockscreen -l blur
``` ```
Use dim + blurred image as lockscreen background Use dim + blurred image as lockscreen background
``` ```
./lock.sh -l dimblur betterlockscreen -l dimblur
``` ```
--- ---
@ -145,25 +145,25 @@ Use dim + blurred image as lockscreen background
Original Image Original Image
``` ```
./lock.sh -w betterlockscreen -w
``` ```
Use dimmed image as desktop background Use dimmed image as desktop background
``` ```
./lock.sh -w dim betterlockscreen -w dim
``` ```
Use blurred image as desktop background Use blurred image as desktop background
``` ```
./lock.sh -w blur betterlockscreen -w blur
``` ```
Use dim + blurred image as desktop background Use dim + blurred image as desktop background
``` ```
./lock.sh -w dimblur betterlockscreen -w dimblur
``` ```
--- ---

View file

@ -4,12 +4,13 @@
# Github Profile : https://github.com/pavanjadhaw # Github Profile : https://github.com/pavanjadhaw
# Project Repository : https://github.com/pavanjadhaw/betterlockscreen # Project Repository : https://github.com/pavanjadhaw/betterlockscreen
# create folder in ~/.cache/i3lock directory # create folder in ~/.cache/i3lock directory
folder="$HOME/.cache/i3lock" folder="$HOME/.cache/i3lock"
# ratio for rectangle to be drawn for time background on lockscreen # ratio for rectangle to be drawn for time background on lockscreen
# Original Image # Original Image
orig_wall="$folder/.wall.png" orig_wall="$folder/wall.png"
# Versions (from here) # Versions (from here)
# You can use these images to set different versions as wallpaper # You can use these images to set different versions as wallpaper
@ -73,10 +74,12 @@ rec_get_random() {
case "$1" in case "$1" in
"") "")
if [ ! -f $l_dim ]; then if [ ! -f $l_dim ]; then
echo "Important : Update the image cache, Ex. ./lock.sh -g path/to/image.jpg"
echo "Important : Update the image cache, Ex. betterlockscreen -u path/to/image.jpg"
echo echo
echo "See also : For other set of options and help use help command." echo "See also : For other set of options and help use help command."
echo "Ex. ./lock.sh -h or ./lock.sh --help" echo "Ex. betterlockscreen -h or betterlockscreen --help"
echo echo
echo "See : https://github.com/pavanjadhaw/betterlockscreen for addition info..." echo "See : https://github.com/pavanjadhaw/betterlockscreen for addition info..."
exit 1 exit 1
@ -85,7 +88,9 @@ case "$1" in
echo "Seems you havent provided any argument, see below for usage info" echo "Seems you havent provided any argument, see below for usage info"
echo echo
echo "See also : For other set of options and help use help command." echo "See also : For other set of options and help use help command."
echo "Ex. ./lock.sh -h or ./lock.sh --help"
echo "Ex. betterlockscreen -h or betterlockscreen --help"
echo echo
echo "See : https://github.com/pavanjadhaw/betterlockscreen for addition info..." echo "See : https://github.com/pavanjadhaw/betterlockscreen for addition info..."
echo echo
@ -94,8 +99,9 @@ case "$1" in
;; ;;
-h | --help) -h | --help)
echo "Important : Update the image cache, Ex: ./lock.sh -u path/to/image.jpg"
echo " Image cache must be updated to initially configure or update wallpaper used" echo "Important : Update the image cache, Ex: betterlockscreen -g path/to/image.jpg"
echo " Image cache must be updated to initially configure or update wallpaper used"
echo echo
echo echo
echo "See : https://github.com/pavanjadhaw/betterlockscreen for additional info..." echo "See : https://github.com/pavanjadhaw/betterlockscreen for additional info..."
@ -104,30 +110,32 @@ case "$1" in
echo "Options:" echo "Options:"
echo echo
echo " -h --help" echo " -h --help"
echo " For help. Ex: ./lock.sh -h or ./lock.sh --help"
echo " For help. Ex: betterlockscreen -h or betterlockscreen --help"
echo echo
echo echo
echo " -u --update" echo " -u --update"
echo " to update image cache, you should do this before using any other options" echo " to update image cache, you should do this before using any other options"
echo " Ex: ./lock.sh -u path/to/image.png when image.png is custom background"
echo " Or you can use ./lock.sh -u path/to/imagedir and a random file will be selected" echo " Ex: betterlockscreen -u path/to/image.png when image.png is custom background"
echo " Or you can use betterlockscreen -u path/to/imagedir and a random file will be selected"
echo echo
echo echo
echo " -l --lock" echo " -l --lock"
echo " to lock screen, Ex. ./lock.sh -l" echo " to lock screen, Ex. betterlockscreen -l"
echo " you can also use dimmed or blurred background for lockscreen" echo " you can also use dimmed or blurred background for lockscreen"
echo " Ex: ./lock.sh -l dim (for dimmed background)" echo " Ex: betterlockscreen -l dim (for dimmed background)"
echo " Ex: ./lock.sh -l blur (for blurred background)" echo " Ex: betterlockscreen -l blur (for blurred background)"
echo " Ex: ./lock.sh -l dimblur (for dimmed + blurred background)" echo " Ex: betterlockscreen -l dimblur (for dimmed + blurred background)"
echo echo
echo echo
echo " -w --wall" echo " -w --wall"
echo " you can also set lockscreen background as wallpaper" echo " you can also set lockscreen background as wallpaper"
echo " to set wallpaper. Ex ./lock.sh -w or ./lock.sh --wall" echo " to set wallpaper. Ex betterlockscreen -w or betterlockscreen --wall"
echo " you can also use dimmed or blurred variants" echo " you can also use dimmed or blurred variants"
echo " Ex: ./lock.sh -w dim (for dimmed wallpaper)" echo " Ex: betterlockscreen -w dim (for dimmed wallpaper)"
echo " Ex: ./lock.sh -w blur (for blurred wallpaper)" echo " Ex: betterlockscreen -w blur (for blurred wallpaper)"
echo " Ex: ./lock.sh -w dimblur (for dimmed + blurred wallpaper)" echo " Ex: betterlockscreen -w dimblur (for dimmed + blurred wallpaper)"
echo echo
;; ;;