make the echo more noticable
[dana/openbox.git] / doc / bsetbg.1
1 .TH bsetbg 1 "February 2002" "bsetbg" "v2.0"
2 .SH NAME
3 bsetbg \- utility to manipulate the appearance of the X11 desktop's root window.
4 .SH SYNOPSIS
5 \fBbsetbg\fR [options] \fIimage\fR
6 .SH DESCRIPTION
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.
12
13 .SH OPTIONS
14 .TP
15 \fB\-f\fR, \fB\-full\fR \fIimage\fR
16 \fIimage\fR is stretched to fill the entire desktop.
17 .TP
18 \fB\-t\fR, \fB\-tile\fR \fIimage\fR
19 \fIimage\fR is tiled on the desktop.
20 .TP
21 \fB\-c\fR, \fB\-center\fR \fIimage\fR
22 \fIimage\fR is centered on the desktop.
23 .TP
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.
27
28 If a \fIfallback\-arg\fR is supplied (\fB\-full\fR, \fB\-tile\fR, or \fB\-center\fR
29 as described above),
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.
33
34 See the \fBEXAMPLES\fR section for more information on \fB\-exec\fR.
35 .TP
36 \fB\-p\fR, \fB\-post\fR \fIlist\fR
37 Specifies a list of arguments to pass to the $POST_COMMAND.
38 .TP
39 \fB\-d\fR, \fB\-debug\fR
40 Debugging mode. \fBbsetbg\fR will print commands without executing them.
41 .TP
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.
46 .TP
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.
54 .TP
55 \fB\-v\fR, \fB\-version\fR
56 Output version number.
57 .TP
58 \fB\-h\fR, \fB\-help\fR
59 Output a brief usage message.
60
61 .SH OTHER OPTIONS
62 \fBbsetbg\fR will also accept all of the arguments for \fIbsetroot\fR.
63 Consult the \fIbsetroot\fR(1) man page for further information.
64
65 .SH CONFIGURATION
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, 
70 display, and xsetbg).
71 \fP
72 \fI~/.bsetbgrc\fR should contain the following variables:
73 .TP
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.
77
78 .TP
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.
82
83 .TP
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.
87
88 .TP
89 \fB    DEFAULT=\fR\fI"string"\fR
90 Action to take place by default if none of the above have been specified.
91
92 .TP
93 The following variables are optional:
94
95 .TP
96 \fB    NO_EXEC=\fR\fI"boolean"\fR
97 If this variable is set, bsetbg will never modify the root window.
98
99 .TP
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.
103
104 .TP
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
107 successful commands.
108
109 .TP
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 .
113
114 .TP
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.
116
117 .SH EXAMPLES
118 In this example, bsetbg will set the image in centered mode:
119
120     bsetbg -center foo.png
121
122 An example of the \fB-exec\fR argument:
123
124     bsetbg -exec xv -root -quit -rmode 5 -rbg rgb:2/2/2 \\
125         -center foo.png
126
127 An example in which bsetbg creates a configuration file using xv and qiv:
128
129     bsetbg -g xv qiv > ~/.bsetbgrc
130
131 An example of the use of the \fB-app\fR argument:
132
133     bsetbg  -app qiv "-o rgb:d6/c5/a2 -x" -c foo.png
134
135 .SH AUTHOR
136 The author of
137 .B bsetbg
138 may be reached at \fItmk@lordzork.com\fR.
139
140 .SH SEE ALSO
141 \fIblackbox\fR(1), \fIbsetroot\fR(1), \fIqiv\fR(1), \fIxli\fR(1), \fIxv\fR(1), \fIdisplay\fR(1), 
142 \fIwmsetbg\fR(1)