aboutsummaryrefslogtreecommitdiff
path: root/doc/fbsetroot.1.in
blob: 223548e3b29a5eaf968379de08d0611e568e0199 (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
'\" t
.\"     Title: fbsetroot
.\"    Author: Jim Ramsay <i.am@jimramsay.com>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 22 January 2015
.\"    Manual: Fluxbox Manual
.\"    Source: fbsetroot.txt
.\"  Language: English
.\"
.TH "FBSETROOT" "1" "22 January 2015" "fbsetroot\&.txt" "Fluxbox Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * 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\(cqt 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\&.
.sp
If any errors are encountered, fbsetroot will use either \fBgxmessage(1)\fR or \fBxmessage(1)\fR to inform the user of errors\&.
.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 specified\&. 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
This manpage was modified by Curt "Asenchi" Micol <asenchi at asenchi\&.com> for the Fluxbox window manager\&.
.sp
Further updates for fluxbox\-1\&.1\&.2 and conversion to asciidoc format by Jim Ramsay <i\&.am at jimramsay\&.com>
.SH "SEE ALSO"
.sp
fluxbox(1) fbsetbg(1) xsetroot(1) xmessage(1) gxmessage(1)
.SH "AUTHOR"
.PP
\fBJim Ramsay\fR <\&i\&.am@jimramsay\&.com\&>
.RS 4
Author.
.RE