aboutsummaryrefslogtreecommitdiff
path: root/doc/fbsetroot.1
diff options
context:
space:
mode:
authormathias <mathias>2005-07-12 04:56:05 (GMT)
committermathias <mathias>2005-07-12 04:56:05 (GMT)
commit1fe9ef3056e80dfed05bbb1b00443c11a64223c1 (patch)
tree3fbae0cada70fe79e939d6c32c7dcb2786b6a816 /doc/fbsetroot.1
parent9531144097b7fdae1051933fd2aa89c8928b72b2 (diff)
downloadfluxbox-1fe9ef3056e80dfed05bbb1b00443c11a64223c1.zip
fluxbox-1fe9ef3056e80dfed05bbb1b00443c11a64223c1.tar.bz2
Renaming of 'bsetroot' to 'fbsetroot' (Mathias)
blackbox's 'bsetroot' and fluxbox's 'bsetroot' have different syntax nowadays and collide when you install fluxbox and blackbox. hence the renaming.
Diffstat (limited to 'doc/fbsetroot.1')
-rw-r--r--doc/fbsetroot.1113
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/fbsetroot.1 b/doc/fbsetroot.1
new file mode 100644
index 0000000..ec8c088
--- /dev/null
+++ b/doc/fbsetroot.1
@@ -0,0 +1,113 @@
1.\"
2.\" Man page for fbsetroot
3.\"
4.\" Copyright (c) 2000 by Wilbert Berendsen <wbsoft@xs4all.nl>
5.\" Copyright (c) 2004 by Curt "Asenchi" Micol <asenchi@asenchi.com>
6.\"
7.\" This page was updated for Fluxbox by Curt "Asenchi" Micol on June 25, 2004
8.\"
9.\" Permission to use, copy, modify, and distribute this documentation for
10.\" any purpose with or without fee is hereby granted, provided that the
11.\" above copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
14.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
15.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
16.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
17.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
18.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20.\" PERFORMANCE OF THIS DOCUMENTATION
21.\"
22.TH fbsetroot 1 "July 8th, 2005" "0.9.13"
23.SH NAME
24fbsetroot \- a simple background utility used by the Fluxbox window manager, originally
25written for and by the original Blackbox window manager team.
26.SH SYNOPSIS
27.BR fbsetroot " \-help"
28.br
29.B fbsetroot
30.RI "[ \-display " display " ] \-solid " color
31.br
32.B fbsetroot
33.RI "[ \-display " display " ] \-mod " "x y" " \-fg " color " \-bg " color
34.br
35.B fbsetroot
36.RI "[ \-display " display " ] \-gradient " texture " \-from " color " \-to " color
37.SH DESCRIPTION
38fbsetroot is a utility that can control the appearance of the root window in
39three ways: Either give it a solid color, or write a two color modula pattern
40to it, or render a gradient texture, based on two different colors.
41.PP
42fbsetroot resembles
43.IR xsetroot (1)
44in this functionality but it supports multiple screen displays, and gradient
45textures the same way as Blackbox or Fluxbox does.
46It doesn't handle cursors etc.
47fbsetroot was originally part of the Blackbox package and was carried over with
48the code that became Fluxbox. It was called bsetroot back in those days.
49.SH OPTIONS
50fbsetroot operates in three ways, you must choose one of the first 3 options:
51.TP
52.BI \-solid " color"
53Sets the root window to specified color.
54.TP
55.BI \-mod " x y"
56Creates a modula pattern. You must specify
57.BR \-bg " and " \-fg
58colors.
59.TP
60.BI \-gradient " texturestring"
61Renders the specified texture string to the root window.
62.RS
63.PP
64.I texturestring
65may be one of:
66.PP
67.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
68.PP
69Select one of these texture types, they only apply when
70.B \-gradient
71is specifed. You must also specify both a
72.BR \-from " and a " \-to
73color.
74.RE
75.TP
76.BI \-display " display"
77Tells fbsetroot to connect to the specified display.
78.TP
79.BI "\-bg, \-background " color
80Background color.
81Needed for
82.B \-mod
83patterns.
84.TP
85.BI "\-fg, \-foreground " color
86Foreground color.
87Needed for
88.B \-mod
89patterns.
90.TP
91.BI \-from " color"
92Start color for rendering textures.
93Needed for
94.B \-gradient
95operation mode.
96.TP
97.BI \-to " color"
98Ending color for rendering textures.
99Needed for
100.B \-gradient
101operation mode.
102.TP
103.B \-help
104Prints version info and short help text.
105.SH AUTHOR
106fbsetroot is written and maintained by the Fluxbox Development Team
107.PP
108This manpage was modified by Curt "Asenchi" Micol <asenchi@asenchi.com> for
109the Fluxbox window manager.
110.hy
111.SH SEE ALSO
112.IR fluxbox (1)
113.IR fbsetbg (1)