aboutsummaryrefslogtreecommitdiff
path: root/doc/fbsetroot.1.in
blob: ddef0d759784e40823237215a0497eb37cbe693b (plain)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
.\"     Title: fbsetroot
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\"      Date: 02/18/2009
.\"    Manual: Fluxbox Manual
.\"    Source: fbsetroot.txt 1.1.2
.\"  Language: English
.\"
.TH "FBSETROOT" "1" "02/18/2009" "fbsetroot\&.txt 1\&.1\&.2" "Fluxbox Manual"
.\" -----------------------------------------------------------------
.\" * (re)Define some macros
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" toupper - uppercase a string (locale-aware)
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\$*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH-xref - format a cross-reference to an SH section
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH - level-one heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
.\" put an extra blank line of space above the head in non-TTY output
.if t \{\
.sp 1
.\}
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SS - level-two heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BB/BE - put background/screen (filled box) around block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BM/EM - put colored marker in margin next to block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
..
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
fbsetroot \- a simple background utility used by the fluxbox(1) window manager, originally written for and by the original blackbox(1) window manager\&.
.SH "Synopsis"
.sp
\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-solid \fIcolor\fR
.sp
\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-mod \fIx\fR \fIy\fR \-fg \fIcolor\fR \-bg \fIcolor\fR
.sp
\fBfbsetroot\fR [\-display \fIdisplay\fR ] \-gradient \fItexture\fR \-from \fIcolor\fR \-to \fIcolor\fR
.sp
\fBfbsetroot\fR \-help
.SH "DESCRIPTION"
.sp
\fBfbsetroot(1)\fR is a utility that can control the appearance of the root window in three ways: Either give it a solid color, or write a two color modula pattern to it, or render a gradient texture, based on two different colors\&.
.sp
fbsetroot resembles \fBxsetroot(1)\fR in this functionality but it supports multiple\-screen displays, and gradient textures the same way as blackbox or fluxbox does\&. It doesn\'t handle cursors etc\&. fbsetroot was originally part of the Blackbox package and was carried over with the code that became Fluxbox\&. It was called bsetroot back in those days\&.
.SH "OPTIONS"
.sp
fbsetroot operates in three ways, you must choose one of the first 3 options:
.PP
\fB\-solid\fR \fIcolor\fR
.RS 4
Sets the root window to specified color\&.
.RE
.PP
\fB\-mod\fR \fIx\fR \fIy\fR
.RS 4
Creates a modula pattern\&. You must specify
\fB\-bg\fR
and
\fB\-fg\fR
colors\&.
.RE
.PP
\fB\-gradient\fR \fItexturestring\fR
.RS 4
Renders the specified texture string to the root window\&.
.PP
\fItexturestring\fR may be one of:
.RS 4

\fBHorizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid\fR
.sp
Select one of these texture types, they only apply when
\fB\-gradient\fR
is specifed\&. You must also specify both a
\fB\-from\fR
and a
\fB\-to\fR
color\&.
.RE
.RE
.PP
\fB\-display\fR \fIdisplay\fR
.RS 4
Tells fbsetroot to connect to the specified display\&.
.RE
.PP
\fB\-bg, \-background\fR \fIcolor\fR
.RS 4
Background color\&. Needed for
\fB\-mod\fR
patterns\&.
.RE
.PP
\fB\-fg, \-foreground\fR \fIcolor\fR
.RS 4
Foreground color\&. Needed for
\fB\-mod\fR
patterns\&.
.RE
.PP
\fB\-from\fR \fIcolor\fR
.RS 4
Start color for rendering textures\&. Needed for
\fB\-gradient\fR
patterns\&.
.RE
.PP
\fB\-to\fR \fIcolor\fR
.RS 4
Ending color for rendering textures\&. Needed for
\fB\-gradient\fR
patterns\&.
.RE
.PP
\fB\-help\fR
.RS 4
Prints version info and short help text\&.
.RE
.SH "AUTHORS"
.sp
fbsetroot is written and maintained by the Fluxbox Development Team
.sp
This manpage was modified by Curt "Asenchi" Micol <\m[blue]\fBasenchi@asenchi\&.com\fR\m[]\&\s-2\u[1]\d\s+2> for the Fluxbox window manager\&.
.sp
Further updates for fluxbox\-1\&.1\&.2 and conversion to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
.SH "SEE ALSO"
.sp
fluxbox(1) fbsetbg(1)
.SH "Notes"
.IP " 1." 4
asenchi@asenchi.com
.RS 4
\%mailto:asenchi@asenchi.com
.RE
.IP " 2." 4
i.am@jimramsay.com
.RS 4
\%mailto:i.am@jimramsay.com
.RE