summaryrefslogtreecommitdiff
path: root/doc/asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc')
-rw-r--r--doc/asciidoc/Makefile2
-rw-r--r--doc/asciidoc/fbsetroot.txt87
2 files changed, 88 insertions, 1 deletions
diff --git a/doc/asciidoc/Makefile b/doc/asciidoc/Makefile
index e169230..bb48c1e 100644
--- a/doc/asciidoc/Makefile
+++ b/doc/asciidoc/Makefile
@@ -2,7 +2,7 @@
2# create manpages from the asciidoc files 2# create manpages from the asciidoc files
3# 3#
4 4
5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt 5SRC1 = fluxbox.txt fluxbox-remote.txt fbrun.txt fbsetbg.txt fbsetroot.txt
6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt 6SRC5 = fluxbox-keys.txt fluxbox-apps.txt fluxbox-style.txt fluxbox-menu.txt
7 7
8MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in) 8MAN = $(SRC1:.txt=.1.in) $(SRC5:.txt=.5.in)
diff --git a/doc/asciidoc/fbsetroot.txt b/doc/asciidoc/fbsetroot.txt
new file mode 100644
index 0000000..a41733d
--- /dev/null
+++ b/doc/asciidoc/fbsetroot.txt
@@ -0,0 +1,87 @@
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
36OPTIONS
37-------
38fbsetroot operates in three ways, you must choose one of the first 3
39options:
40
41*-solid* 'color'::
42Sets the root window to specified color.
43
44*-mod* 'x' 'y'::
45Creates a modula pattern. You must specify *-bg* and *-fg* colors.
46
47*-gradient* 'texturestring'::
48Renders the specified texture string to the root window.
49+
50'texturestring' may be one of:;;
51 *Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic /
52Rectangle / Pyramid*
53+
54Select one of these texture types, they only apply when *-gradient* is
55specifed. You must also specify both a *-from* and a *-to* color.
56
57*-display* 'display'::
58Tells fbsetroot to connect to the specified display.
59
60*-bg, -background* 'color'::
61Background color. Needed for *-mod* patterns.
62
63*-fg, -foreground* 'color'::
64Foreground color. Needed for *-mod* patterns.
65
66*-from* 'color'::
67Start color for rendering textures. Needed for *-gradient* patterns.
68
69*-to* 'color'::
70Ending color for rendering textures. Needed for *-gradient* patterns.
71
72*-help*::
73Prints version info and short help text.
74
75AUTHORS
76-------
77fbsetroot is written and maintained by the Fluxbox Development Team
78
79This manpage was modified by Curt "Asenchi" Micol <asenchi@asenchi.com>
80for the Fluxbox window manager.
81
82Further updates for fluxbox-1.1.2 and conversion to asciidoc format by Jim
83Ramsay <i.am@jimramsay.com>
84
85SEE ALSO
86--------
87fluxbox(1) fbsetbg(1)