xkcdlock/README.md

33 lines
875 B
Markdown
Raw Normal View History

2016-07-28 02:01:50 +00:00
# xkcdlock
2021-02-20 00:00:04 +00:00
A wrapper around screen lockers to display xkcd images
Currently supported are i3lock and swaylack
2016-07-28 22:06:34 +00:00
Depending on the given arguments xkcdlock shows a random image, the latest
image or an image of choice.
2021-02-20 00:03:41 +00:00
Note that 'latest' needs an internet connection for the download
2016-07-28 22:06:34 +00:00
If the download fails it falls back to a specific hard-coded image
Builtin is a function to download all images.
2021-02-20 00:00:04 +00:00
## Dependencies
rbash, xrandr, awk, curl, convert (from imagick)
2016-07-28 22:06:34 +00:00
2021-02-20 00:00:04 +00:00
## Usage
2021-02-20 00:03:41 +00:00
Use ```xkcdlock -h``` to show the command help
2021-02-20 00:08:18 +00:00
```
$ xkcdlock -h
2021-02-20 00:24:11 +00:00
xkcdlock 23
2021-02-20 00:08:18 +00:00
Available options are:
2021-02-20 00:24:11 +00:00
-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
2021-02-20 00:08:18 +00:00
```