aboutsummaryrefslogtreecommitdiff
path: root/doc/fluxstyle.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fluxstyle.1')
-rw-r--r--doc/fluxstyle.1489
1 files changed, 489 insertions, 0 deletions
diff --git a/doc/fluxstyle.1 b/doc/fluxstyle.1
new file mode 100644
index 0000000..c2ba84a
--- /dev/null
+++ b/doc/fluxstyle.1
@@ -0,0 +1,489 @@
1.\" AT THE BOTTOM IS ADD ONS TO THE PAGE search /ADDITIONS
2.\" Manual page for Fluxbox Styles
3.\"
4.\" Fluxbox is Copyright (c) 2001-2004 Henrik Kinnunen
5.\" Fluxstyle(1) is Copyright (c) 2004 Curt 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 Curt 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.8"
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'. While there isn't an official structure of how to package your style, one way that is recommended is creating a directory named after your style and placing your pixmaps directory in there along with a theme.cfg. The theme.cfg file being your created style. So for example if I created a style called 'MyStyle' I would create the following:
95.EX
96mkdir -p ~/.fluxbox/styles/MyStyle
97cd ~/.fluxbox/styles/MyStyle
98mkdir pixmaps
99vi theme.cfg (this being where you design your style with
100 the necessary components)
101.EE
102If you follow this, the path to your pixmaps will be:
103.IR ~/fluxbox/styles/MyStyle/pixmaps
104which makes it a bit easier to setup up and distribute your style.
105
106.SH CREATING STYLES
107As discussed in the
108.IR STRUCTURE
109section of this man page, Fluxbox allows you to configure its four main components: the toolbar, the menus, the
110slit and the window decorations. Remember that you can customize the slit with its own
111directives, but if you don't, it will take the appearance of the toolbar.
112.PP
113Here are some quick examples to illustrate basic syntax:
114.EX
115toolbar.clock.color: green
116.EE
117This sets the color resource of the toolbar clock to 'green'. Another example:
118.EX
119menu*color: rgb:3/4/5
120.EE
121This sets the color resource of the menu
122.I and all of its 'children'
123to `rgb:3/4/5'.
124(For a description of color names, see
125.IR X (1).)
126So this one also applies to
127.IR menu.title.color " and " menu.frame.color .
128And with
129.EX
130*font: -b&h-lucida-medium-r-normal-*-*-140-*
131.EE
132you set the font resource for all keys to this font name all at once.
133(For information about the fonts installed on your system, you can use a program like
134.IR xfontsel "(1), " gtkfontsel ", or " xlsfonts "(1).)"
135.PP
136This last example brings up wildcards and overrides. In a Fluxbox style you can set a value
137with a wild card. The previous example means that every font in the style will be what is
138specified. You can do this with any value. For example if you wanted all of the text to be one
139color you could do:
140.EX
141*textColor: rgb:3/4/5
142.EE
143This means you can setup a very simple style with very few properties. See
144.IR EXAMPLES
145below for an example of this in practice. You can also override wildcards in the style
146file. Lets take our example above and add an override for the toolbar.clock.textColor:
147.EX
148*textColor: rgb:3/4/5
149toolbar.clock.textColor: rgb:255/0/0
150.EE
151With that all of the text will be 'rgb:3/4/5' except the toolbar clock text which will be 'rgb:255/0/0'
152.PP
153Now, what makes Fluxbox just so spectacular, is its ability to render textures
154on the fly.
155Texture descriptions are specified directly to the key that they
156should apply to, e.g.:
157.ta \w'toolbar.clock.colorTo:\ 'u
158.EX
159toolbar.clock: Raised Gradient Diagonal Bevel1
160toolbar.clock.color: rgb:8/6/4
161toolbar.clock.colorTo: rgb:4/3/2
162.EE
163Don't worry, we will explain right now!
164A texture description consists of up to five fields, which are as follows:
165.TP
166.B Flat / Raised / Sunken
167gives the component either a flat, raised or sunken appearance.
168.TP
169.B Gradient / Solid
170tells Fluxbox to draw either a solid color or a gradient texture.
171.TP
172.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
173Select one of these texture types. They only work when also
174.B Gradient
175is specified!
176.TP
177.B Interlaced
178tells Fluxbox to interlace the texture (darken every other line).
179This option is most commonly used with gradiented textures, but from Fluxbox
180version 0.60.3 on, it also works in solid textures.
181.TP
182.B Bevel1 / Bevel2
183tells Fluxbox which type of bevel to use.
184Bevel1 is the default bevel.
185The shading is placed on the edge of the image.
186Bevel2 is an alternative.
187The shading is placed one pixel in from the edge of the image.
188.PP
189Instead of a texture description, also the option
190.B ParentRelative
191is available, which makes the component appear as a part of its parent, e.g.
192totally transparent.
193.PP
194Or for even more possibilities
195.B Pixmap .
196If pixmap texture is specified (it might not be necessary on every occasion)
197the pixmap file is specified in a separate pixmap resource.
198.EX
199toolbar.clock: pixmap
200toolbar.clock.pixmap: .fluxbox/styles/mine/clock_background.xpm
201.EE
202This feature might need some investigation, reports say that sometimes
203the resources color and colorTo must be set and then they may not be set.
204.PP
205All gradiented textures are composed of two color values: the
206.IR color " and " colorTo " resources."
207When
208.B Interlaced
209is used in
210.B Solid
211mode, the
212.I colorTo
213resource is used to find the interlacing color.
214.PP
215.SH A WORD ABOUT FONTS
216We should comment about fonts before we move on to the complete component
217list.
218.PP
219Fluxbox supports different options for text. These options currently include bold and shadow. To set these do this, fontname-size:options, for any of the font components in the style file. For example:
220.EX
221menu.title.font: sans-8:bold,shadow
222.EE
223If you have problems installing fonts or getting them to work, you should read the docs page at xfree.org. Here is a link to one of these: http://xfree.org/4.3.0/fonts2.html#3.
224.SH FULL COMPONENT LIST
225Here is the complete component list, together with which kind of value they take.
226Comments are preceded with an exclamation sign (!), which is also used for
227comments in Fluxbox style c.q. X resource files.
228.PP
229.\" The comments also to be translated!
230.SS WINDOW OPTIONS
231Many, many things you can do with window design in Fluxbox, below are your options. Have fun.
232.EX
233window.label.focus: <texture type>
234window.label.focus.pixmap: <filename>
235window.label.focus.color: <color>
236window.label.focus.colorTo: <color>
237window.label.unfocus: <texture type>
238window.label.unfocus.pixmap: <filename>
239window.label.unfocus.color: <color>
240window.label.unfocus.colorTo: <color>
241window.title.focus: <texture type>
242window.title.focus.pixmap: <filename>
243window.title.focus.color: <color>
244window.title.focus.colorTo: <color>
245window.title.unfocus: <texture type>
246window.title.unfocus.pixmap: <filename>
247window.title.unfocus.color: <color>
248window.title.unfocus.colorTo: <color>
249window.handle.focus: <texture type>
250window.handle.focus.pixmap: <filename>
251window.handle.focus.color: <color>
252window.handle.focus.colorTo: <color>
253window.handle.unfocus: <texture type>
254window.handle.unfocus.pixmap: <filename>
255window.handle.unfocus.color: <color>
256window.handle.unfocus.colorTo: <color>
257window.button.focus: <texture type>
258window.button.focus.pixmap: <filename>
259window.button.focus.color: <color>
260window.button.focus.colorTo: <color>
261window.button.unfocus: <texture type>
262window.button.unfocus.pixmap: <filename>
263window.button.unfocus.color: <color>
264window.button.unfocus.colorTo: <color>
265window.button.pressed: <texture type>
266window.button.pressed.pixmap: <filename>
267window.button.pressed.color: <color>
268window.button.pressed.colorTo: <color>
269window.grip.focus: <texture type>
270window.grip.focus.pixmap: <filename>
271window.grip.focus.color: <color>
272window.grip.focus.colorTo: <color>
273window.grip.unfocus: <texture type>
274window.grip.unfocus.pixmap: <filename>
275window.grip.unfocus.color: <color>
276window.grip.unfocus.colorTo: <color>
277window.label.focus.textColor: <color>
278window.label.unfocus.textColor: <color>
279window.frame.focusColor: <color>
280window.frame.unfocusColor: <color>
281window.button.focus.picColor: <color>
282window.button.unfocus.picColor: <color>
283window.font: <font>
284window.justify:
285window.roundCorners:
286window.alpha: <integer>
287window.title.height: <integer>
288window.bevelWidth: <integer>
289window.handleWidth: <integer>
290window.borderWidth: <integer>
291window.borderColor: <color>
292window.close.pixmap: <filename>
293window.close.unfocus.pixmap: <filename>
294window.close.pressed.pixmap: <filename>
295window.maximize.pixmap: <filename>
296window.maximize.unfocus.pixmap: <filename>
297window.maximize.pressed.pixmap: <filename>
298window.iconify.pixmap: <filename>
299window.iconify.unfocus.pixmap: <filename>
300window.iconify.pressed.pixmap: <filename>
301window.shade.pixmap: <filename>
302window.shade.unfocus.pixmap: <filename>
303window.shade.pressed.pixmap: <filename>
304window.stick.pixmap: <filename>
305window.stick.unfocus.pixmap: <filename>
306window.stick.pressed.pixmap: <filename>
307window.stuck.pixmap: <filename>
308window.stuck.unfocus.pixmap: <filename>
309.EE
310.SS MENU OPTIONS
311Everything you need to make your menu look pretty.
312.EX
313menu.title.textColor: <color>
314menu.frame.textColor: <color>
315menu.hilite.textColor: <color>
316menu.frame.disableColor: <color>
317menu.title: <texture type>
318menu.title.pixmap: <filename>
319menu.title.color: <color>
320menu.title.colorTo: <color>
321menu.frame: <texture type>
322menu.frame.pixmap: <filename>
323menu.frame.color: <color>
324menu.frame.colorTo: <color>
325menu.hilite: <texture type>
326menu.hilite.pixmap: <filename>
327menu.hilite.color: <color>
328menu.hilite.colorTo: <color>
329menu.title.font: <font>
330menu.frame.font: <font>
331menu.frame.justify:
332menu.title.justify:
333menu.bullet.position:
334menu.bullet:
335menu.borderWidth:
336menu.bevelWidth:
337menu.borderColor: <color>
338menu.submenu.pixmap: <filename>
339menu.selected.pixmap: <filename>
340menu.unselected.pixmap: <filename>
341menu.roundCorners:
342.EE
343.SS ROOT COMMAND OPTION
344This is how you set your background within your style. Use the official fluxbox background program, fbsetbg. It is distributed with Fluxbox, and can also be downloaded from here: http://www.xs4all.nl/~hanb/software/fluxbox/fbsetbg.html
345.EX
346rootCommand: <string>
347.EE
348.SS SLIT
349Here are all of the options for the slit.
350.EX
351slit: <texture type>
352slit.pixmap: <filename>
353slit.color: <color>
354slit.colorTo: <color>
355slit.borderWidth: <integer>
356slit.bevelWidth: <integer>
357slit.borderColor: <color>
358.EE
359.SS TOOLBAR OPTIONS
360Below you will find all of the configuration possibilities for the toolbar. The list is pretty extensive and offers you many options to make your toolbar look just the way you want it.
361.EX
362toolbar: <texture type>
363toolbar.pixmap: <filename>
364toolbar.color: <color>
365toolbar.colorTo: <color>
366toolbar.borderWidth: <integer>
367toolbar.borderColor: <color>
368toolbar.bevelWidth: <0-255>
369toolbar.shaped: <boolean>
370toolbar.alpha: <integer>
371toolbar.height: <integer>
372toolbar.clock.font: <font>
373toolbar.clock.textColor: <color>
374toolbar.clock.justify:
375toolbar.clock: <texture type>
376toolbar.clock.pixmap: <filename>
377toolbar.clock.color: <color>
378toolbar.clock.colorTo: <color>
379toolbar.clock.borderWidth: <integer>
380toolbar.clock.borderColor: <color>
381toolbar.workspace.font: <font>
382toolbar.workspace.textColor: <color>
383toolbar.workspace.justify:
384toolbar.workspace: <texture type>
385toolbar.workspace.pixmap: <filename>
386toolbar.workspace.color: <color>
387toolbar.workspace.colorTo: <color>
388toolbar.workspace.borderWidth: <integer>
389toolbar.workspace.borderColor: <color>
390toolbar.iconbar.focused: <texture type>
391toolbar.iconbar.focused.pixmap: <filename>
392toolbar.iconbar.focused.color: <color>
393toolbar.iconbar.focused.colorTo: <color>
394toolbar.iconbar.unfocused: <texture type>
395toolbar.iconbar.unfocused.pixmap: <filename>
396toolbar.iconbar.unfocused.color: <color>
397toolbar.iconbar.unfocused.colorTo: <color>
398toolbar.iconbar.empty: <texture type>
399toolbar.iconbar.empty.pixmap: <filename>
400toolbar.iconbar.empty.color: <color>
401toolbar.iconbar.empty.colorTo: <color>
402toolbar.iconbar.focused.borderWidth: <integer>
403toolbar.iconbar.focused.borderColor: <color>
404toolbar.iconbar.unfocused.borderWidth: <integer>
405toolbar.iconbar.unfocused.borderColor: <color>
406toolbar.iconbar.borderWidth: <integer>
407toolbar.iconbar.borderColor: <color>
408toolbar.iconbar.focused.font: <font>
409toolbar.iconbar.focused.textColor: <color>
410toolbar.iconbar.focused.justify:
411toolbar.iconbar.unfocused.font: <font>
412toolbar.iconbar.unfocused.textColor: <color>
413toolbar.iconbar.unfocused.justify:
414.EE
415.SH EXAMPLES
416This may seem like a long list, but remember, when you create your own style, you
417can easily set lots of keys with a single command, e.g.
418.EX
419.ta \w'*unfocus.textColor:\ 'u
420*color: slategrey
421*colorTo: darkslategrey
422*unfocus.color: darkslategrey
423*unfocus.colorTo: black
424*textColor: white
425*unfocus.textColor: lightgrey
426*font: lucidasans-10
427.EE
428This sets already nice defaults for many components.
429
430.SH COLOR FORMATS
431These are the color formats for styles:
432.EX
433#000000 (Hexadecimal)
434/usr/X11R6/lib/X11/rgb.txt
435.EE
436
437.SH AUTHOR and CREDITS
438Blackbox was written and maintained by Brad Hughes
439.nh \" hyphenation off
440<blackbox@alug.org>
441.hy \" on again
442and Jeff Raven
443.nh
444<jraven@psu.edu>,
445.hy
446.PP
447Fluxbox is written and maintained by Henrik Kinnunen
448.nh
449<fluxgen@linuxmail.org>
450.hy
451with contributions and patches merged from
452many individuals around the world.
453.PP
454The Official Fluxbox website:
455.nh
456.B http://www.fluxbox.org/
457.hy
458.PP
459Flumod is a Fluxbox community site where you can find many new styles that
460work with this version of Fluxbox and take advantage of all the new features.
461You can find Fluxmod here:
462.nh
463.B http://www.fluxmod.dk/
464.hy
465.PP
466You can also find more styles here:
467.nh
468.B http://themes.freshmeat.net/
469.PP
470This manpage was composed from various resources including the documentation, fluxbox
471man page and numerous other resources by Curt Micol
472.nh
473<asenchi@asenchi.com>
474.hy
475and using the great contributions of
476.hy
477<grubert@users.sourceforge.net>.
478.nh
479Numerous other languages could be available if someone jumps in.
480.SH SEE ALSO
481.IR fluxbox (1)
482.IR bsetroot (1)
483
484.\" ADDITIONS TO MAKE
485.\" Create a font section
486.\" Change layout of theme items
487.\" Obtain new theme items, grubert just placed in new man page
488.\" Become a little more verbose on color usage.
489.\"