aboutsummaryrefslogtreecommitdiff
path: root/doc/fluxboxstyle.1
diff options
context:
space:
mode:
authorgrubert <grubert>2004-01-20 11:17:50 (GMT)
committergrubert <grubert>2004-01-20 11:17:50 (GMT)
commit602b24bcce092729a51e01e3ad4d2dbecd2b072d (patch)
tree9c5a450a4c5e20c79b60105990d5bfa015e17333 /doc/fluxboxstyle.1
parentd7e356d907c1b1cc2572d60685215a1453197090 (diff)
downloadfluxbox-602b24bcce092729a51e01e3ad4d2dbecd2b072d.zip
fluxbox-602b24bcce092729a51e01e3ad4d2dbecd2b072d.tar.bz2
Add: manpages.
Diffstat (limited to 'doc/fluxboxstyle.1')
-rw-r--r--doc/fluxboxstyle.1447
1 files changed, 447 insertions, 0 deletions
diff --git a/doc/fluxboxstyle.1 b/doc/fluxboxstyle.1
new file mode 100644
index 0000000..11a4548
--- /dev/null
+++ b/doc/fluxboxstyle.1
@@ -0,0 +1,447 @@
1.\"
2.\" Manual page for Fluxbox Styles
3.\"
4.\" Fluxbox is Copyright (c) 2001-2004 Henrik Kinnunen
5.\" Fluxstyle(1) is Copyright (c) 2004 Curtis Micol
6.\"
7.\" This manual page is freely distrubted and modified.
8.\" Parts of the text are taken from websites and style
9.\" files on http://www.fluxbox.org and http://www.fluxmod.dk
10.\"
11.\" Created and Updated for version 0.9.7 by Curtis Micol <asenchi@asenchi.com>
12.\"
13.\" Define this: <blockquote><pre>
14.de EX
15.ne 5
16.if n .sp 1
17.if t .sp .5
18.nf
19.in +.5i
20..
21.de EE
22.fi
23.in -.5i
24.if n .sp 1
25.if t .sp .5
26..
27.\" Begin actual page
28.\"
29.TH fluxstyle 1 "January 7th, 2004" "0.9.7"
30.SH NAME
31fluxstyle \- all you need to know about Fluxbox styles
32.SH DESCRIPTION
33.\"
34.\" Taken from the documentation
35.\"
36.SS What is a Style?
37A style is basically a theme for the
38.IR Fluxbox(1)
39window manager. It is a simple ASCII text file that tells Fluxbox how
40to generate the appearance of the different components of the window manager.
41The default installation of Fluxbox is shipped with many classic styles that
42show the customization of current Fluxbox versions. They are usually located in
43.IR ~/.fluxbox/styles
44and in the global Fluxbox share directory
45.IR /usr/local/share/fluxbox/styles
46which may vary depending on the method of installation used. To use one of
47the styles shipped with Fluxbox, look in your root menu under the configure
48part of the menu for 'System Styles'.
49.PP
50Fluxbox uses its own graphics class to render its images on the fly. By using
51style files, you can determine at a great level of configurability what your
52desktop will look like. Fluxbox styles are compatible with those of the
53Blackbox window manager (where Fluxbox originated). Users migrating from
54Blackbox can use their current favourite themes.
55
56.SH STRUCTURE OF STYLES
57The style is made up of a few major components which then have their own
58sub-directives. The toolbar, menu, slit and window are the major components. The
59.IR window.*
60directives control the appearance of your window frames,
61.IR window.tab.*
62controls the appearance of the window tabs.
63.IR menu.*
64controls the appearance of the popup menu that you see when you right click
65on the desktop.
66.IR toolbar.*
67is the bar you will see at the top or bottom of your screen. Finally the
68.IR slit.*
69has options you can use to customize the appearance of the slit. However
70if you don't set the slit directives specifically, the slit's appearance is controlled
71by the
72.IR toolbar.*
73directives instead.
74.PP
75To understand how the style mechanism works, it is nice to know a litte about how
76X11 resources work.
77.PP
78X11 resources consist of a key and a value. The key si constructed of several smaller
79keys (sometimes referred to as children), delimited by a period (.). Keys may also
80contain a asterisk (*) to serve as a wildcard, which means that one line of typed text
81will match several keys. This is useful for styles that are based on one or two colors.
82
83.SH LOCATION OF STYLES
84We'll cover quickly where styles can be found and placed after you create your own.
85.PP
86There are a number of default styles that come with the installation, while we have already
87covered this, we will again just provide a central location for all style locations. These
88default styles are located in
89.IR /usr/local/share/fluxbox/styles
90providing a default configureation at installation.
91.PP
92Once you create your own, you can create a directory in
93.IR ~/.fluxbox/
94called 'styles'. Place your styles here and you will be able to access them from the configure
95portion of the Root Menu called 'User Styles'. This goes true for any directories associated
96with your style. An example being, if you create a style with pixmaps, create
97.IR ~/.fluxbox/pixmaps
98and place your pixmaps here. Of course, this means that the path to your pixmaps in your style
99file will be the same.
100
101.SH CREATING STYLES
102As discussed in the
103.IR STRUCTURE
104section of this man page, Fluxbox allows you to configure its four main components: the toolbar, the menus, the
105slit and the window decorations. Remember that you can customize the slit with its own
106directives, but if you don't, it will take the appearance of the toolbar.
107.PP
108Here are some quick examples to illustrate basic syntax:
109.EX
110toolbar.clock.color: green
111.EE
112This sets the color resource of the toolbar clock to 'green'. Another example:
113.EX
114menu*color: rgb:3/4/5
115.EE
116This sets the color resource of the menu
117.I and all of its 'children'
118to `rgb:3/4/5'.
119(For a description of color names, see
120.IR X (1).)
121So this one also applies to
122.IR menu.title.color " and " menu.frame.color .
123And with
124.EX
125*font: -b&h-lucida-medium-r-normal-*-*-140-*
126.EE
127you set the font resource for all keys to this font name all at once.
128(For information about the fonts installed on your system, you can use a program like
129.IR xfontsel "(1), " gtkfontsel ", or " xlsfonts "(1).)"
130.PP
131This last example brings up wildcards and overrides. In a Fluxbox style you can set a value
132with a wild card. The previous example means that every font in the style will be what is
133specified. You can do this with any value. For example if you wanted all of the text to be one
134color you could do:
135.EX
136*textColor: rgb:3/4/5
137.EE
138This means you can setup a very simple style with very few properties. See
139.IR EXAMPLES
140below for an example of this in practice. You can also override wildcards in the style
141file. Lets take our example above and add an override for the toolbar.clock.textColor:
142.EX
143*textColor: rgb:3/4/5
144toolbar.clock.textColor: rgb:255/0/0
145.EE
146With that all of the text will be 'rgb:3/4/5' except the toolbar clock text which will be 'rgb:255/0/0'
147.PP
148Now, what makes Fluxbox just so spectacular, is its ability to render textures
149on the fly.
150Texture descriptions are specified directly to the key that they
151should apply to, e.g.:
152.ta \w'toolbar.clock.colorTo:\ 'u
153.EX
154toolbar.clock: Raised Gradient Diagonal Bevel1
155toolbar.clock.color: rgb:8/6/4
156toolbar.clock.colorTo: rgb:4/3/2
157.EE
158Don't worry, we will explain right now!
159A texture description consists of up to five fields, which are as follows:
160.TP
161.B Flat / Raised / Sunken
162gives the component either a flat, raised or sunken appearance.
163.TP
164.B Gradient / Solid
165tells Fluxbox to draw either a solid color or a gradient texture.
166.TP
167.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
168Select one of these texture types. They only work when also
169.B Gradient
170is specified!
171.TP
172.B Interlaced
173tells Fluxbox to interlace the texture (darken every other line).
174This option is most commonly used with gradiented textures, but from Fluxbox
175version 0.60.3 on, it also works in solid textures.
176.TP
177.B Bevel1 / Bevel2
178tells Fluxbox which type of bevel to use.
179Bevel1 is the default bevel.
180The shading is placed on the edge of the image.
181Bevel2 is an alternative.
182The shading is placed one pixel in from the edge of the image.
183.PP
184Instead of a texture description, also the option
185.B ParentRelative
186is available, which makes the component appear as a part of its parent, e.g.
187totally transparent.
188.PP
189Or for even more possibilities
190.B Pixmap .
191If pixmap texture is specified (it might not be necessary on every occasion)
192the pixmap file is specified in a separate pixmap resource.
193.EX
194toolbar.clock: pixmap
195toolbar.clock.pixmap: .fluxbox/styles/mine/clock_background.xpm
196.EE
197This feature might need some investigation, reports say that sometimes
198the resources color and colorTo must be set and then they may not be set.
199.PP
200All gradiented textures are composed of two color values: the
201.IR color " and " colorTo " resources."
202When
203.B Interlaced
204is used in
205.B Solid
206mode, the
207.I colorTo
208resource is used to find the interlacing color.
209.PP
210Here is the complete component list, also all components together with
211which kind of value they can contain.
212Comments are preceded with an exclamation sign (!), which is also used for
213comments in Fluxbox style c.q. X resource files.
214.PP
215.ta \w'window.button.unfocus.picColor:\ 'u
216.nf
217.\"
218.\" The comments also to be translated!
219.\"
220! The toolbar itself
221toolbar: Texture
222toolbar.color: Color
223toolbar.colorTo: Color
224
225! The buttons on the toolbar
226toolbar.button: Texture or \fIParentRelative\fR
227toolbar.button.color: Color
228toolbar.button.colorTo: Color
229
230! Color of the button arrows
231toolbar.button.picColor: Color
232
233! Buttons in pressed state
234toolbar.button.pressed: Texture \fI(e.g. Sunken)\fR or \fIParentRelative\fR
235toolbar.button.pressed.color: Color
236toolbar.button.pressed.colorTo: Color
237
238! Color of pressed button arrows
239toolbar.button.pressed.picColor: Color
240
241! The toolbar workspace label
242toolbar.label: Texture or \fIParentRelative\fR
243toolbar.label.color: Color
244toolbar.label.colorTo: Color
245toolbar.label.textColor: Color
246
247! The toolbar window label
248toolbar.windowLabel: Texture or \fIParentRelative\fR
249toolbar.windowLabel.color: Color
250toolbar.windowLabel.colorTo: Color
251toolbar.windowLabel.textColor: Color
252
253! The toolbar clock
254toolbar.clock: Texture or \fIParentRelative\fR
255toolbar.clock.color: Color
256toolbar.clock.colorTo: Color
257toolbar.clock.textColor: Color
258
259! How the toolbar's text should be justified.
260toolbar.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
261
262! Font to be used for all toolbar components
263toolbar.font: Font \fI(e.g. -*-helvetica-medium-r-normal-*-*-100-*)\fR
264
265! The menu titlebar
266menu.title: Texture
267menu.title.color: Color
268menu.title.colorTo: Color
269menu.title.textColor: Color
270menu.title.font: Font
271menu.title.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
272
273! The menu frame
274menu.frame: Texture
275menu.frame.color: Color
276menu.frame.colorTo: Color
277menu.frame.textColor: Color
278menu.frame.disableColor: Color
279menu.frame.font: Font
280menu.frame.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
281
282! Bullets for submenu items
283menu.bullet: \fIempty\fR, \fItriangle\fR, \fIsquare\fR, or \fIdiamond\fR
284menu.bullet.position: \fIright\fR or \fIleft\fR
285
286! The highlighted menu item
287menu.hilite: Texture (e.g. \fIRaised\fR)
288menu.hilite.color: Color
289menu.hilite.colorTo: Color
290menu.hilite.textColor: Color
291
292! A focused window
293window.title.focus: Texture
294window.title.focus.color: Color
295window.title.focus.colorTo: Color
296
297! An unfocused window
298window.title.unfocus: Texture
299window.title.unfocus.color: Color
300window.title.unfocus.colorTo: Color
301
302! Window label in window.title
303window.label.focus: Texture or \fIParentRelative\fR
304window.label.focus.color: Color
305window.label.focus.colorTo: Color
306window.label.focus.textColor: Color
307
308window.label.unfocus: Texture or \fIParentRelative\fR
309window.label.unfocus.color: Color
310window.label.unfocus.colorTo: Color
311window.label.unfocus.textColor: Color
312
313! Handlebar
314window.handle.focus: Texture
315window.handle.focus.color: Color
316window.handle.focus.colorTo: Color
317
318window.handle.unfocus: Texture
319window.handle.unfocus.color: Color
320window.handle.unfocus.colorTo: Color
321
322! Resize grips
323window.grip.focus: Texture
324window.grip.focus.color: Color
325window.grip.focus.colorTo: Color
326
327window.grip.unfocus: Texture
328window.grip.unfocus.color: Color
329window.grip.unfocus.colorTo: Color
330
331! Window buttons
332window.button.focus: Texture or \fIParentRelative\fR
333window.button.focus.color: Color
334window.button.focus.colorTo: Color
335window.button.focus.picColor: Color
336
337window.button.unfocus: Texture or \fIParentRelative\fR
338window.button.unfocus.color: Color
339window.button.unfocus.colorTo: Color
340window.button.unfocus.picColor: Color
341
342window.button.pressed: Texture (e.g. \fISunken\fR)
343window.button.pressed.color: Color
344window.button.pressed.colorTo: Color
345
346! Frame around window
347window.frame.focusColor: Color
348window.frame.unfocusColor: Color
349
350! Font and justification for window labels
351window.font: Font
352window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
353
354! Slit resources
355slit:
356slit.color: Color
357slit.colorTo: Color
358
359! Miscellaneous resources
360
361! A border can be drawn round all components
362borderWidth: a number of pixels, e.g. \fI1\fR
363borderColor: Color
364
365bevelWidth: a number of pixels > 0
366handleWidth: a number of pixels > 0
367
368! Width of the window frame
369! When not specified, frameWidth defaults to the value of bevelWidth
370frameWidth: a number of pixels >= 0
371
372! This command is executed whenever this style is selected.
373! Typically it sets the root window to a nice picture.
374rootCommand: Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb: 5/6/6 -bg grey20\fR
375
376! Some of the bbtools read these old 0.51 resources
377menuFont: Font
378titleFont: Font
379.fi
380.SH EXAMPLES
381This may seem like a long list, but remember, when you create your own style, you
382can easily set lots of keys with a single command, e.g.
383.EX
384.ta \w'*unfocus.textColor:\ 'u
385*color: slategrey
386*colorTo: darkslategrey
387*unfocus.color: darkslategrey
388*unfocus.colorTo: black
389*textColor: white
390*unfocus.textColor: lightgrey
391*font: lucidasans-10
392.EE
393This sets already nice defaults for many components.
394
395.SH COLOR FORMATS
396These are the color formats for styles:
397.EX
398#000000 (Hexadecimal)
399/usr/X11R6/lib/X11/rgb.txt
400.EE
401
402.SH AUTHOR and CREDITS
403Blackbox was written and maintained by Brad Hughes
404.nh \" hyphenation off
405<blackbox@alug.org>
406.hy \" on again
407and Jeff Raven
408.nh
409<jraven@psu.edu>,
410.hy
411.PP
412Fluxbox is written and maintained by Henrik Kinnunen
413.nh
414<fluxgen@linuxmail.org>
415.hy
416with contributions and patches merged from
417many individuals around the world.
418.PP
419The Official Fluxbox website:
420.nh
421.B http://www.fluxbox.org/
422.hy
423.PP
424Flumod is a Fluxbox community site where you can find many new styles that
425work with this version of Fluxbox and take advantage of all the new features.
426You can find Fluxmod here:
427.nh
428.B http://www.fluxmod.dk/
429.hy
430.PP
431You can also find more styles here:
432.nh
433.B http://themes.freshmeat.net/
434.PP
435This manpage was composed from various resources including the documentation, fluxbox
436man page and numerous other resources by Curtis Micol
437.nh
438<asenchi@asenchi.com>
439.hy
440and using the great contributions of
441.hy
442<grubert@users.sourceforge.net>.
443.nh
444Numerous other languages could be available if someone jumps in.
445.SH SEE ALSO
446.IR fluxbox (1)
447.IR bsetroot (1)