... | ... |
@@ -6,6 +6,32 @@ Set [X Window System][] [background][] image/video. |
6 | 6 |
[X Window System]: https://en.wikipedia.org/wiki/X_Window_System |
7 | 7 |
[background]: https://en.wikipedia.org/wiki/Wallpaper_(computing) |
8 | 8 |
|
9 |
+## Usage |
|
10 |
+ |
|
11 |
+`background --help`: |
|
12 |
+ |
|
13 |
+``` |
|
14 |
+background 1.0 |
|
15 |
+ |
|
16 |
+Set X Window System background image/video. |
|
17 |
+ |
|
18 |
+usage: |
|
19 |
+ background [-v|--video] [--] [<path>] |
|
20 |
+ background -h|--help |
|
21 |
+ background --version |
|
22 |
+ |
|
23 |
+options: |
|
24 |
+ -v, --video |
|
25 |
+ Changes the default <path> to |
|
26 |
+ ${XDG_DATA_HOME:-$HOME/.local/share}/backgrounds-video. |
|
27 |
+arguments: |
|
28 |
+ <path> |
|
29 |
+ If not a directory, set it as background. If a directory, search |
|
30 |
+ recursively in it (resolving symlinks) and set a random file as |
|
31 |
+ background. |
|
32 |
+ [default: ${XDG_DATA_HOME:-$HOME/.local/share}/backgrounds] |
|
33 |
+``` |
|
34 |
+ |
|
9 | 35 |
## License |
10 | 36 |
|
11 | 37 |
Licensed under the [ISC License][] unless otherwise noted, see the |
... | ... |
@@ -5,3 +5,11 @@ Set [X Window System][] [background][] image/video. |
5 | 5 |
[`background`]: https://git.rcrnstn.net/rcrnstn/background |
6 | 6 |
[X Window System]: https://en.wikipedia.org/wiki/X_Window_System |
7 | 7 |
[background]: https://en.wikipedia.org/wiki/Wallpaper_(computing) |
8 |
+ |
|
9 |
+## License |
|
10 |
+ |
|
11 |
+Licensed under the [ISC License][] unless otherwise noted, see the |
|
12 |
+[`LICENSE`][] file. |
|
13 |
+ |
|
14 |
+[ISC License]: https://choosealicense.com/licenses/isc/ |
|
15 |
+[`LICENSE`]: LICENSE |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,7 @@ |
1 |
+# [`background`][] |
|
2 |
+ |
|
3 |
+Set [X Window System][] [background][] image/video. |
|
4 |
+ |
|
5 |
+[`background`]: https://git.rcrnstn.net/rcrnstn/background |
|
6 |
+[X Window System]: https://en.wikipedia.org/wiki/X_Window_System |
|
7 |
+[background]: https://en.wikipedia.org/wiki/Wallpaper_(computing) |