bsetbg(1)

1bsetbg(1)                            v2.0                            bsetbg(1)
2
3
4

NAME

6       bsetbg - utility to manipulate the appearance of the X11 desktop's root
7       window.
8

SYNOPSIS

10       bsetbg [options] image
11

DESCRIPTION

13       bsetbg is intended to provide a standard method for the Blackbox window
14       manager  to  alter  the background of the root window (although it will
15       work with any other window manager as well). bsetbg acts as  a  wrapper
16       both  to bsetroot and to a flexible variety of third-party applications
17       that it uses when handling images files.
18
19

OPTIONS

21       -f, -full image
22              image is stretched to fill the entire desktop.
23
24       -t, -tile image
25              image is tiled on the desktop.
26
27       -c, -center image
28              image is centered on the desktop.
29
30       -e, -exec program options fallback-arg image
31              This option tells bsetbg to run a separate command by  executing
32              program with options, where options are arguments to program.
33
34              If  a  fallback-arg  is  supplied  (-full,  -tile, or -center as
35              described above), bsetbg will assume that the last argument is a
36              filename.  In  the  case  that  program  exits non-zero or isn't
37              available on the target system, bsetbg will try  to  handle  the
38              file with the fallback argument.
39
40              See the EXAMPLES section for more information on -exec.
41
42       -p, -post list
43              Specifies a list of arguments to pass to the $POST_COMMAND.
44
45       -d, -debug
46              Debugging  mode.  bsetbg  will  print commands without executing
47              them.
48
49       -g, -generate list
50              Output a list of  default  configuration  values,  suitable  for
51              redirecting  into  ~/.bsetbgrc.  Any arguments that are supplied
52              will be considered applications to  search  for  in  the  system
53              path, overriding bsetbg's internal defaults.
54
55       -app imageApp
56              Use  this  flag  to specify which image application to use. This
57              application may be one of the pre-defined list or  any  applica‐
58              tion  capable  of  displaying  an image on the root window. This
59              flag may be used in conjunction with  passing  application  spe‐
60              cific   parameters to the application, in which case they should
61              be enclosed in double quotes.
62
63       -v, -version
64              Output version number.
65
66       -h, -help
67              Output a brief usage message.
68
69

OTHER OPTIONS

71       bsetbg will also accept all of the arguments for bsetroot.  Consult the
72       bsetroot(1) man page for further information.
73
74

CONFIGURATION

76       bsetbg  will read its configuration values from the file ~/.bsetbgrc if
77       it exists. Otherwise, it will scan the system path  for  a  pre-defined
78       list of image applications to use (currently this list consists of qiv,
79       xli, xv, wmsetbg, Esetroot, display, and xsetbg).   ~/.bsetbgrc  should
80       contain the following variables:
81
82           CENTER="string"
83              Application  and  arguments to be used to center an image on the
84              root window when the -center argument is specified.
85
86
87           FULL="string"
88              Application and arguments to be used to stretch an image to fill
89              the root window when the -full argument is specified.
90
91
92           TILE="string"
93              Application  and  arguments  to  be used to tile an image on the
94              root window when the -tile argument is specified.
95
96
97           DEFAULT="string"
98              Action to take place by default if none of the above  have  been
99              specified.
100
101
102       The following variables are optional:
103
104
105           NO_EXEC="boolean"
106              If  this variable is set, bsetbg will never modify the root win‐
107              dow.
108
109
110           POST_COMMAND="string"
111              This variable specifies a command that  bsetbg  will  run  after
112              every successful modification of the root window.
113
114
115           LOG_LAST_CMD="boolean"
116              If  this variable is set, bsetbg will keep a logfile of the last
117              two successful commands.
118
119
120           LOGFILE="string"
121              This  variable  can  specify  the  logfile  to  be   used   when
122              $LOG_LAST_CMD is defined.  The default is ~/.bsetbg_last_cmd .
123
124
125       As  mentioned above, bsetbg will function perfectly for the majority of
126       users without having a configuration file. Power users  who  want  more
127       control  over bsetbg's behavior should run bsetbg -g and use the output
128       to create a ~/.bsetbgrc which may then be tweaked by hand.
129
130

EXAMPLES

132       In this example, bsetbg will set the image in centered mode:
133
134           bsetbg -center foo.png
135
136       An example of the -exec argument:
137
138           bsetbg -exec xv -root -quit -rmode 5 -rbg rgb:2/2/2 \       -center
139       foo.png
140
141       An  example  in  which bsetbg creates a configuration file using xv and
142       qiv:
143
144            bsetbg -g xv qiv > ~/.bsetbgrc
145
146       An example of the use of the -app argument:
147
148           bsetbg  -app qiv "-o rgb:d6/c5/a2 -x" -c foo.png
149
150

AUTHOR

152       The author of bsetbg may be reached at tmk@lordzork.com.
153
154