summaryrefslogtreecommitdiff
path: root/doc/fbsetroot.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fbsetroot.1.in')
-rw-r--r--doc/fbsetroot.1.in268
1 files changed, 268 insertions, 0 deletions
diff --git a/doc/fbsetroot.1.in b/doc/fbsetroot.1.in
new file mode 100644
index 0000000..a39a586
--- /dev/null
+++ b/doc/fbsetroot.1.in
@@ -0,0 +1,268 @@
1.\" Title: fbsetroot
2.\" Author: [see the "AUTHORS" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 02/19/2009
5.\" Manual: Fluxbox Manual
6.\" Source: fbsetroot.txt 1.1.2
7.\" Language: English
8.\"
9.TH "FBSETROOT" "1" "02/19/2009" "fbsetroot\&.txt 1\&.1\&.2" "Fluxbox Manual"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170fbsetroot \- a simple background utility used by the fluxbox(1) window manager, originally written for and by the original blackbox(1) window manager\&.
171.SH "Synopsis"
172.sp
173\fBfbsetroot\fR [\-display \fIdisplay\fR] \-solid \fIcolor\fR
174.sp
175\fBfbsetroot\fR [\-display \fIdisplay\fR] \-mod \fIx\fR \fIy\fR \-fg \fIcolor\fR \-bg \fIcolor\fR
176.sp
177\fBfbsetroot\fR [\-display \fIdisplay\fR] \-gradient \fItexture\fR \-from \fIcolor\fR \-to \fIcolor\fR
178.sp
179\fBfbsetroot\fR \-help
180.SH "DESCRIPTION"
181.sp
182\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\&.
183.sp
184fbsetroot 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\&.
185.sp
186If any errors are encountered, fbsetroot will use either \fBgxmessage(1)\fR or \fBxmessage(1)\fR to inform the user of errors\&.
187.SH "OPTIONS"
188.sp
189fbsetroot operates in three ways, you must choose one of the first 3 options:
190.PP
191\fB\-solid\fR \fIcolor\fR
192.RS 4
193Sets the root window to specified color\&.
194.RE
195.PP
196\fB\-mod\fR \fIx\fR \fIy\fR
197.RS 4
198Creates a modula pattern\&. You must specify
199\fB\-bg\fR
200and
201\fB\-fg\fR
202colors\&.
203.RE
204.PP
205\fB\-gradient\fR \fItexturestring\fR
206.RS 4
207Renders the specified texture string to the root window\&.
208.PP
209\fItexturestring\fR may be one of:
210.RS 4
211
212\fBHorizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid\fR
213.sp
214Select one of these texture types, they only apply when
215\fB\-gradient\fR
216is specifed\&. You must also specify both a
217\fB\-from\fR
218and a
219\fB\-to\fR
220color\&.
221.RE
222.RE
223.PP
224\fB\-display\fR \fIdisplay\fR
225.RS 4
226Tells fbsetroot to connect to the specified display\&.
227.RE
228.PP
229\fB\-bg, \-background\fR \fIcolor\fR
230.RS 4
231Background color\&. Needed for
232\fB\-mod\fR
233patterns\&.
234.RE
235.PP
236\fB\-fg, \-foreground\fR \fIcolor\fR
237.RS 4
238Foreground color\&. Needed for
239\fB\-mod\fR
240patterns\&.
241.RE
242.PP
243\fB\-from\fR \fIcolor\fR
244.RS 4
245Start color for rendering textures\&. Needed for
246\fB\-gradient\fR
247patterns\&.
248.RE
249.PP
250\fB\-to\fR \fIcolor\fR
251.RS 4
252Ending color for rendering textures\&. Needed for
253\fB\-gradient\fR
254patterns\&.
255.RE
256.PP
257\fB\-help\fR
258.RS 4
259Prints version info and short help text\&.
260.RE
261.SH "AUTHORS"
262.sp
263This manpage was modified by Curt "Asenchi" Micol <asenchi at asenchi\&.com> for the Fluxbox window manager\&.
264.sp
265Further updates for fluxbox\-1\&.1\&.2 and conversion to asciidoc format by Jim Ramsay <i\&.am at jimramsay\&.com>
266.SH "SEE ALSO"
267.sp
268fluxbox(1) fbsetbg(1) xsetroot(1) xmessage(1) gxmessage(1)
generated by cgit v0.11.2 at 2024-12-26 17:50:09 (GMT)