summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/Makefile.am10
-rw-r--r--doc/asciidoc/Makefile2
-rw-r--r--doc/asciidoc/fbsetroot.txt87
-rw-r--r--doc/fbsetroot.1113
-rw-r--r--doc/fbsetroot.1.in279
5 files changed, 372 insertions, 119 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index b4ffd9f..e7309d8 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -2,14 +2,14 @@
2# Makefile.am for fluxbox/doc 2# Makefile.am for fluxbox/doc
3 3
4SUBDIRS = ru 4SUBDIRS = ru
5CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \ 5CLEANFILES = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \
6 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 6 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5
7MAINTAINERCLEANFILES = Makefile.in 7MAINTAINERCLEANFILES = Makefile.in
8man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fluxbox-apps.5 \ 8man_MANS = fluxbox.1 fbrun.1 fbsetbg.1 fbsetroot.1 fluxbox-apps.5 \
9 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \ 9 fluxbox-keys.5 fluxbox-menu.5 fluxbox-remote.1 fluxbox-style.5 \
10 fbsetroot.1 startfluxbox.1 10 startfluxbox.1
11EXTRA_DIST=fbsetroot.1 startfluxbox.1 CODESTYLE \ 11EXTRA_DIST=startfluxbox.1 CODESTYLE \
12 fluxbox.1.in fbrun.1.in fbsetbg.1.in fluxbox-apps.5.in \ 12 fluxbox.1.in fbrun.1.in fbsetbg.1.in fbsetroot.1.in fluxbox-apps.5.in \
13 fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in 13 fluxbox-keys.5.in fluxbox-menu.5.in fluxbox-remote.1.in fluxbox-style.5.in
14distclean-local: 14distclean-local:
15 rm -f *\~ 15 rm -f *\~
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)
diff --git a/doc/fbsetroot.1 b/doc/fbsetroot.1
deleted file mode 100644
index ec8c088..0000000
--- a/doc/fbsetroot.1
+++ /dev/null
@@ -1,113 +0,0 @@
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)
diff --git a/doc/fbsetroot.1.in b/doc/fbsetroot.1.in
new file mode 100644
index 0000000..ddef0d7
--- /dev/null
+++ b/doc/fbsetroot.1.in
@@ -0,0 +1,279 @@
1.\" Title: fbsetroot
2.\" Author: [see the "AUTHORS" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 02/18/2009
5.\" Manual: Fluxbox Manual
6.\" Source: fbsetroot.txt 1.1.2
7.\" Language: English
8.\"
9.TH "FBSETROOT" "1" "02/18/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.SH "OPTIONS"
186.sp
187fbsetroot operates in three ways, you must choose one of the first 3 options:
188.PP
189\fB\-solid\fR \fIcolor\fR
190.RS 4
191Sets the root window to specified color\&.
192.RE
193.PP
194\fB\-mod\fR \fIx\fR \fIy\fR
195.RS 4
196Creates a modula pattern\&. You must specify
197\fB\-bg\fR
198and
199\fB\-fg\fR
200colors\&.
201.RE
202.PP
203\fB\-gradient\fR \fItexturestring\fR
204.RS 4
205Renders the specified texture string to the root window\&.
206.PP
207\fItexturestring\fR may be one of:
208.RS 4
209
210\fBHorizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid\fR
211.sp
212Select one of these texture types, they only apply when
213\fB\-gradient\fR
214is specifed\&. You must also specify both a
215\fB\-from\fR
216and a
217\fB\-to\fR
218color\&.
219.RE
220.RE
221.PP
222\fB\-display\fR \fIdisplay\fR
223.RS 4
224Tells fbsetroot to connect to the specified display\&.
225.RE
226.PP
227\fB\-bg, \-background\fR \fIcolor\fR
228.RS 4
229Background color\&. Needed for
230\fB\-mod\fR
231patterns\&.
232.RE
233.PP
234\fB\-fg, \-foreground\fR \fIcolor\fR
235.RS 4
236Foreground color\&. Needed for
237\fB\-mod\fR
238patterns\&.
239.RE
240.PP
241\fB\-from\fR \fIcolor\fR
242.RS 4
243Start color for rendering textures\&. Needed for
244\fB\-gradient\fR
245patterns\&.
246.RE
247.PP
248\fB\-to\fR \fIcolor\fR
249.RS 4
250Ending color for rendering textures\&. Needed for
251\fB\-gradient\fR
252patterns\&.
253.RE
254.PP
255\fB\-help\fR
256.RS 4
257Prints version info and short help text\&.
258.RE
259.SH "AUTHORS"
260.sp
261fbsetroot is written and maintained by the Fluxbox Development Team
262.sp
263This manpage was modified by Curt "Asenchi" Micol <\m[blue]\fBasenchi@asenchi\&.com\fR\m[]\&\s-2\u[1]\d\s+2> for the Fluxbox window manager\&.
264.sp
265Further updates for fluxbox\-1\&.1\&.2 and conversion to asciidoc format by Jim Ramsay <\m[blue]\fBi\&.am@jimramsay\&.com\fR\m[]\&\s-2\u[2]\d\s+2>
266.SH "SEE ALSO"
267.sp
268fluxbox(1) fbsetbg(1)
269.SH "Notes"
270.IP " 1." 4
271asenchi@asenchi.com
272.RS 4
273\%mailto:asenchi@asenchi.com
274.RE
275.IP " 2." 4
276i.am@jimramsay.com
277.RS 4
278\%mailto:i.am@jimramsay.com
279.RE
generated by cgit v0.11.2 at 2024-12-27 07:46:31 (GMT)