[doc] configuration

This commit is contained in:
Pavan Jadhaw 2019-01-23 12:12:01 +05:30
parent 07a548b0cf
commit 1045af0afb
No known key found for this signature in database
GPG key ID: C5EF103236859A91

View file

@ -22,6 +22,7 @@ betterlockscreen --lock blur
- [how it works](#how-it-works) - [how it works](#how-it-works)
- [requirements](#requirements) - [requirements](#requirements)
- [installation](#installation) - [installation](#installation)
- [configuration](#configuration)
- [usage](#usage) - [usage](#usage)
- [background](#set-desktop-background-on-startup) - [background](#set-desktop-background-on-startup)
- [keybinding](#keybindings) - [keybinding](#keybindings)
@ -95,6 +96,12 @@ export PATH="${PATH}:${HOME}/.local/bin/"
UtkarshVerma was so kind to provide an installation script for debian based systems, ![check it out here](https://github.com/UtkarshVerma/installer-scripts). UtkarshVerma was so kind to provide an installation script for debian based systems, ![check it out here](https://github.com/UtkarshVerma/installer-scripts).
### Configuration
You can customise various colors for betterlockscreen, copy config file from examples directory to `~/.config/betterlockscreenrc` and edit it accordingly.
If configuration file is not found then default configurations will be used.
### Usage ### Usage
Run `betterlockscreen` and point it to either a directory (`betterlockscreen -u "path/to/dir"`) or an image (`betterlockscreen -u "/path/to/img.jpg"`) and that's all. `betterlockscreen` will change update its cache with image you provided. Run `betterlockscreen` and point it to either a directory (`betterlockscreen -u "path/to/dir"`) or an image (`betterlockscreen -u "/path/to/img.jpg"`) and that's all. `betterlockscreen` will change update its cache with image you provided.
@ -172,6 +179,8 @@ exec --no-startup-id source ~/.fehbg
### Keybindings ### Keybindings
To lockscreen using keyboard shortcut
#### i3wm #### i3wm
Add this line to your `~/.config/i3/config` Add this line to your `~/.config/i3/config`