xkcdlock/README.md

33 lines
875 B
Markdown

# xkcdlock
A wrapper around screen lockers to display xkcd images
Currently supported are i3lock and swaylack
Depending on the given arguments xkcdlock shows a random image, the latest
image or an image of choice.
Note that 'latest' needs an internet connection for the download
If the download fails it falls back to a specific hard-coded image
Builtin is a function to download all images.
## Dependencies
rbash, xrandr, awk, curl, convert (from imagick)
## Usage
Use ```xkcdlock -h``` to show the command help
```
$ xkcdlock -h
xkcdlock 23
Available options are:
-d Download images to current working directory
-h Show this help
-i Show specific image file - overrides '-m'
-l Lock program: one of i3lock/swaylock
-m Mode: latest | random default: random
-v Be verbose
-V Show version
```