summaryrefslogtreecommitdiff
path: root/doc/asciidoc/fbsetroot.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc/fbsetroot.txt')
-rw-r--r--doc/asciidoc/fbsetroot.txt88
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/asciidoc/fbsetroot.txt b/doc/asciidoc/fbsetroot.txt
new file mode 100644
index 0000000..74d5fa8
--- /dev/null
+++ b/doc/asciidoc/fbsetroot.txt
@@ -0,0 +1,88 @@
1fbsetroot(1)
2============
3Jim Ramsay <i.am@jimramsay.com>
4v1.1.2, 18 February 2009
5:man source: fbsetroot.txt
6:man version: {revision}
7:man manual: Fluxbox Manual
8
9NAME
10----
11fbsetroot - a simple background utility used by the fluxbox(1) window manager,
12originally written for and by the original blackbox(1) window manager.
13
14SYNOPSIS
15--------
16*fbsetroot* [-display 'display'] -solid 'color'
17
18*fbsetroot* [-display 'display'] -mod 'x' 'y' -fg 'color' -bg 'color'
19
20*fbsetroot* [-display 'display'] -gradient 'texture' -from 'color' -to 'color'
21
22*fbsetroot* -help
23
24DESCRIPTION
25-----------
26*fbsetroot(1)* is a utility that can control the appearance of the root window
27in three ways: Either give it a solid color, or write a two color modula pattern
28to it, or render a gradient texture, based on two different colors.
29
30fbsetroot resembles *xsetroot(1)* in this functionality but it supports
31multiple-screen displays, and gradient textures the same way as blackbox or
32fluxbox does. It doesn't handle cursors etc. fbsetroot was originally part of
33the Blackbox package and was carried over with the code that became Fluxbox. It
34was called bsetroot back in those days.
35
36If any errors are encountered, fbsetroot will use either *gxmessage(1)* or
37*xmessage(1)* to inform the user of errors.
38
39OPTIONS
40-------
41fbsetroot operates in three ways, you must choose one of the first 3
42options:
43
44*-solid* 'color'::
45Sets the root window to specified color.
46
47*-mod* 'x' 'y'::
48Creates a modula pattern. You must specify *-bg* and *-fg* colors.
49
50*-gradient* 'texturestring'::
51Renders the specified texture string to the root window.
52+
53'texturestring' may be one of:;;
54 *Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic /
55Rectangle / Pyramid*
56+
57Select one of these texture types, they only apply when *-gradient* is
58specifed. You must also specify both a *-from* and a *-to* color.
59
60*-display* 'display'::
61Tells fbsetroot to connect to the specified display.
62
63*-bg, -background* 'color'::
64Background color. Needed for *-mod* patterns.
65
66*-fg, -foreground* 'color'::
67Foreground color. Needed for *-mod* patterns.
68
69*-from* 'color'::
70Start color for rendering textures. Needed for *-gradient* patterns.
71
72*-to* 'color'::
73Ending color for rendering textures. Needed for *-gradient* patterns.
74
75*-help*::
76Prints version info and short help text.
77
78AUTHORS
79-------
80This manpage was modified by Curt "Asenchi" Micol <asenchi at asenchi.com>
81for the Fluxbox window manager.
82
83Further updates for fluxbox-1.1.2 and conversion to asciidoc format by Jim
84Ramsay <i.am at jimramsay.com>
85
86SEE ALSO
87--------
88fluxbox(1) fbsetbg(1) xsetroot(1) xmessage(1) gxmessage(1)