1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107 | diff --git a/Makefile b/Makefile
index 1faa9af..72e7900 100644
--- a/Makefile
+++ b/Makefile
@@ -8,13 +8,11 @@ install: build
sudo install -d ./templates/ /etc/walrs/templates
sudo cp -r templates/ /etc/walrs/
bash ./autocomplete.sh
+ sudo cp ./walrs.1 /usr/share/man/man1/
sudo cp -r colorschemes/ /etc/walrs/
uninstall:
- sudo rm -f /usr/bin/walrs
- sudo rm -rf /etc/walrs/
- sudo rm -rf ~/.config/walrs
-
+ sudo rm -rf /usr/bin/walrs /etc/walrs/ ~/.config/walrs/ /usr/share/man/man1/walrs.1
clean:
cargo clean
diff --git a/walrs.1 b/walrs.1
new file mode 100644
index 0000000..da48150
--- /dev/null
+++ b/walrs.1
@@ -0,0 +1,81 @@
+.TH WALRS 1 "June 2025" "Version 1.1.1" "User Commands"
+.SH NAME
+walrs \- Fast Rust-based wallpaper and colorscheme generator
+.SH SYNOPSIS
+.B walrs
+[\-i <image|directory>] [\-k <backend>] [\-b <value>] [\-s <value>]
+[\-r | \-R] [\-t <theme|themes>] [\-g <theme_name>] [\-q]
+.SH DESCRIPTION
+.B walrs
+is a command-line utility that generates a color scheme from the dominant colors in an image. This palette can then be applied system-wide and on the fly in various programs.
+.SH OPTIONS
+.TP
+.B \-i <image|directory>
+Generate colorscheme from specified image or a random image in the directory.
+.TP
+.B \-k <backend>
+Select color extraction backend. Options: kmeans, color_thief, palette_extract, all (default).
+.TP
+.B \-b <value>
+Adjust brightness. Range: -128 to 127.
+.TP
+.B \-s <value>
+Adjust saturation. Range: -128 to 127.
+.TP
+.B \-r
+Reload colors without changing wallpaper.
+.TP
+.B \-R
+Reload colors and reset wallpaper.
+.TP
+.B \-t <theme|themes>
+Apply specified theme or list available themes.
+.TP
+.B \-g <theme_name>
+Save current colors as a new theme with the given name.
+.TP
+.B \-q
+Quiet mode. Suppress output, useful for scripts.
+.SH EXAMPLES
+Generate colorscheme from an image:
+.B
+walrs \-i ~/Pictures/sunset.jpg
+.PP
+Generate colorscheme using kmeans backend:
+.B
+walrs \-i photo.jpg \-k kmeans
+.PP
+Adjust brightness and saturation:
+.B
+walrs \-i image.jpg \-b 20 \-s 40
+.PP
+Apply existing theme:
+.B
+walrs \-t vscode
+.PP
+Save current colors as a new theme:
+.B
+walrs \-g my_sunset_theme
+.SH FILES
+.TP
+~/.config/walrs/
+Configuration directory.
+.TP
+~/.config/walrs/templates/
+Templates directory.
+.TP
+~/.config/wal/colorschemes/
+Themes directory.
+.TP
+~/.cache/wal/colors
+Generated colors file.
+.TP
+~/.cache/wal/colors.json
+Generated colors in JSON format.
+.TP
+~/.cache/wal/wal
+Current wallpaper path.
+.SH AUTHOR
+Developed by Pixel.
+.SH LICENSE
+GNU General Public License v3.0
|
