-
Notifications
You must be signed in to change notification settings - Fork 1
/
bwp.1
150 lines (127 loc) · 4.04 KB
/
bwp.1
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
.nh
.TH BWP 1 2022-05-26 budlabs "User Manuals"
.SH NAME
.PP
bwp - budlabs wallpaper selector
.SH SYNOPSIS
.PP
.RS
.nf
bwp [--prev|-p --next|-n --random|-r] WALLPAPER
bwp --blur|-b [--prev|-p --next|-n --random|-r] WALLPAPER
bwp --lock|-l [--lock-options|-L OPTIONS] [--image-options|-I OPTIONS] [--wallpaper|-w --random|-r] WALLPAPER
bwp --delete|-d [--force|-f] WALLPAPER
bwp --add|-a [--force|-f] FILE|DIR
bwp --rename|-x NEWNAME WALLPAPER
bwp --verbose|-V
bwp --help|-h
bwp --version|-v
.fi
.RE
.SH USAGE
.PP
The argument WALLPAPER is available for all
actions except \fB\fC--add\fR and can be either the name
of a file in \fB\fCBWP_DIR/walls\fR or the path to a
file (\fIif the file doesn't exist in the library,
it will get added before the action is applied\fP).
If the WALLPAPER argument is omitted and no
navigate action (\fB\fC--next\fR,\fB\fC--pre\fR,\fB\fC--random\fR) is
specified the action will get applied to
the \fBcurrentwall\fP (\fIthe file that
\fB\fCBWP_DIR/currentwall\fR links to.*\fP)
.PP
*except for the \fB\fC--lock\fR action that will use
\fB\fCBWP_DIR/currentlock\fR\&.
.SH OPTIONS
.PP
.RS
.nf
-a, --add | add FILE or files in DIRECTORY to the library.
-b, --blur | toggle/set blur.
-d, --delete | delete WALLPAPER from library and history.
-f, --force | change behavior of --delete and --add options
-h, --help | print help and exit
-I, --image-options OPTIONS | options passed to `convert` before locking the screen
-l, --lock | locks the computer with `i3lock(1)`.
-L, --lock-options OPTIONS | Additional command line options passed to `i3lock`.
-n, --next | set next wallpaper according to BWP_DIR/history
-p, --prev | set previous wallpaper according to BWP_DIR/history
-r, --random | get a random wallpaper from BWP_DIR/walls
-x, --rename NEWNAME | rename WALLPAPER to NEWNAME
-V, --verbose | louder output
-v, --version | print version info and exit
-w, --wallpaper | use current wallpaper when --lock is used
.fi
.RE
.SS -a, --add
.PP
Use --force option to overwrite existing files.
.SS -b, --blur
.PP
If no WALLPAPER is specified the blur state of the
current wallpaper will get toggled.
.SS -d, --delete
.PP
Use \fB\fC--force\fR option to skip prompt.
.SS -I, --image-options OPTIONS
.PP
If OPTIONS is the path to a file, the content of
that file will be used. This options overrides
the environment variable:
\fB\fCBWP_LOCK_IMAGE_OPTIONS\fR
.SS -l, --lock
.PP
If no WALLPAPER is specified, the last image used
for lockscreen background will be used.
.SS -L, --lock-options OPTIONS
.PP
If OPTIONS is the path to a file, the content of
that file will be used. This options overrides
the environment variable: \fB\fCBWP_LOCK_OPTIONS\fR
.SH ENVIRONMENT
.SS BWP_DIR
.PP
Directory where wallpapers and history file will get
stored.
defaults to: \fB\fC$HOME/.cache/wallpapers\fR
.SS BWP_GEOMETRY
.PP
($WIDTHx$HEIGHT) if set, images added to the library will
be resized (if needed) to the dimensions specified. If not
set, images will be resized (if needed) to the same
dimensions as the currently active monitor.
defaults to: \fB\fC""\fR
.SS BWP_COMMAND
.PP
Command used to set the wallpaper.
defaults to: \fB\fCfeh --no-fehbg --bg-fill\fR
.SS BWP_LOCK_OPTIONS
.PP
Additional command line options passed to \fB\fCi3lock\fR\&.
\fB\fC--lock-options\fR will override this variable if set.
defaults to: \fB\fC""\fR
.SS BWP_LOCK_IMAGE_OPTIONS
.PP
Additional command line options passed to \fB\fCconvert\fR before
locking the screen. \fB\fC--image-options\fR will override this
variable if set.
defaults to: \fB\fC""\fR
.SH CONTACT
.PP
Send bugs and feature requests to:
.br
https://github.com/budlabs/bwp/issues
.SH COPYRIGHT
.PP
Copyright (c) 2019-2022, budRich of budlabs
.br
SPDX-License-Identifier: MIT
.SH DEPENDENCIES
.PP
bash gawk sed ImageMagick
.br
i3lock (optional)
.SH SEE ALSO
.PP
\fB\fCi3lock(1)\fR, \fB\fCImageMagick(1)\fR, \fB\fCparallel(1)\fR, \fB\fCpngquant(1)\fR