1
.TH bsetbg 1 "February 2002" "bsetbg" "v2.0"
3
bsetbg \- utility to manipulate the appearance of the X11 desktop's root window.
5
\fBbsetbg\fR [options] \fIimage\fR
7
\fBbsetbg\fR is intended to provide a standard method for the \fIBlackbox\fR
8
window manager to alter the background of the root window
9
(although it will work with any other window manager as well). \fBbsetbg\fR
10
acts as a wrapper both to \fIbsetroot\fR
11
and to a flexible variety of third-party applications that it uses when handling images files.
15
\fB\-f\fR, \fB\-full\fR \fIimage\fR
16
\fIimage\fR is stretched to fill the entire desktop.
18
\fB\-t\fR, \fB\-tile\fR \fIimage\fR
19
\fIimage\fR is tiled on the desktop.
21
\fB\-c\fR, \fB\-center\fR \fIimage\fR
22
\fIimage\fR is centered on the desktop.
24
\fB\-e\fR, \fB\-exec\fR \fIprogram\fR \fIoptions\fR \fIfallback\-\fIarg\fR \fIimage\fR
25
This option tells \fBbsetbg\fR to run a separate command by executing \fIprogram\fR with
26
\fIoptions\fR, where \fIoptions\fR are arguments to \fIprogram\fR.
28
If a \fIfallback\-arg\fR is supplied (\fB\-full\fR, \fB\-tile\fR, or \fB\-center\fR
30
\fBbsetbg\fR will assume that the last argument is a filename. In the case that
31
\fIprogram\fR exits non-zero or isn't available on the target system, \fBbsetbg\fR
32
will try to handle the file with the fallback argument.
34
See the \fBEXAMPLES\fR section for more information on \fB\-exec\fR.
36
\fB\-p\fR, \fB\-post\fR \fIlist\fR
37
Specifies a list of arguments to pass to the $POST_COMMAND.
39
\fB\-d\fR, \fB\-debug\fR
40
Debugging mode. \fBbsetbg\fR will print commands without executing them.
42
\fB\-g\fR, \fB\-generate\fR \fIlist\fR
43
Output a list of default configuration values, suitable for redirecting into
44
\fI~/.bsetbgrc\fR. Any arguments that are supplied will be considered applications
45
to search for in the system path, overriding \fBbsetbg\fR's internal defaults.
47
\fB\-app\fR \fIimageApp\fR
48
Use this flag to specify which image application to use. This
49
application may be one of the pre-defined list or any application
50
capable of displaying an image on the root window. This flag may be
51
used in conjunction with passing application specific parameters to
52
the application, in which
53
case they should be enclosed in double quotes.
55
\fB\-v\fR, \fB\-version\fR
56
Output version number.
58
\fB\-h\fR, \fB\-help\fR
59
Output a brief usage message.
62
\fBbsetbg\fR will also accept all of the arguments for \fIbsetroot\fR.
63
Consult the \fIbsetroot\fR(1) man page for further information.
66
\fBbsetbg\fR will read its configuration values from the file \fI~/.bsetbgrc\fR
67
if it exists. Otherwise, it will scan the
68
system path for a pre-defined list of image applications to use
69
(currently this list consists of qiv, xli, xv, wmsetbg, Esetroot,
72
\fI~/.bsetbgrc\fR should contain the following variables:
74
\fB CENTER=\fR\fI"string"\fR
75
Application and arguments to be used to center an image on the root window
76
when the \fB-center\fR argument is specified.
79
\fB FULL=\fR\fI"string"\fR
80
Application and arguments to be used to stretch an image to fill the root window
81
when the \fB-full\fR argument is specified.
84
\fB TILE=\fR\fI"string"\fR
85
Application and arguments to be used to tile an image on the root window
86
when the \fB-tile\fR argument is specified.
89
\fB DEFAULT=\fR\fI"string"\fR
90
Action to take place by default if none of the above have been specified.
93
The following variables are optional:
96
\fB NO_EXEC=\fR\fI"boolean"\fR
97
If this variable is set, bsetbg will never modify the root window.
100
\fB POST_COMMAND=\fR\fI"string"\fR
101
This variable specifies a command that \fBbsetbg\fR will run after every
102
successful modification of the root window.
105
\fB LOG_LAST_CMD=\fR\fI"boolean"\fR
106
If this variable is set, \fBbsetbg\fR will keep a logfile of the last two
110
\fB LOGFILE=\fR\fI"string"\fR
111
This variable can specify the logfile to be used when $LOG_LAST_CMD is defined.
112
The default is ~/.bsetbg_last_cmd .
115
As mentioned above, \fBbsetbg\fR will function perfectly for the majority of users without having a configuration file. Power users who want more control over \fBbsetbg\fR's behavior should run \fBbsetbg -g\fR and use the output to create a \fI~/.bsetbgrc\fR which may then be tweaked by hand.
118
In this example, bsetbg will set the image in centered mode:
120
bsetbg -center foo.png
122
An example of the \fB-exec\fR argument:
124
bsetbg -exec xv -root -quit -rmode 5 -rbg rgb:2/2/2 \\
127
An example in which bsetbg creates a configuration file using xv and qiv:
129
bsetbg -g xv qiv > ~/.bsetbgrc
131
An example of the use of the \fB-app\fR argument:
133
bsetbg -app qiv "-o rgb:d6/c5/a2 -x" -c foo.png
138
may be reached at \fItmk@lordzork.com\fR.
141
\fIblackbox\fR(1), \fIbsetroot\fR(1), \fIqiv\fR(1), \fIxli\fR(1), \fIxv\fR(1), \fIdisplay\fR(1),