aboutsummaryrefslogtreecommitdiff
path: root/doc/fluxstyle.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fluxstyle.1.in')
-rw-r--r--doc/fluxstyle.1.in502
1 files changed, 502 insertions, 0 deletions
diff --git a/doc/fluxstyle.1.in b/doc/fluxstyle.1.in
new file mode 100644
index 0000000..d0c7f33
--- /dev/null
+++ b/doc/fluxstyle.1.in
@@ -0,0 +1,502 @@
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
6.\" Copyright (c) 2003, 2004, Curt "Asenchi" Micol
7
8.\" Permission to use, copy, modify, and distribute this documentation for
9.\" any purpose with or without fee is hereby granted, provided that the
10.\" above copyright notice and this permission notice appear in all copies.
11
12.\" THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
13.\" WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
14.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
15.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
16.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
17.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
18.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
19.\" PERFORMANCE OF THIS DOCUMENTATION
20
21.\" Parts of the text are taken from websites and style
22.\" files on http://www.fluxbox.org and http://www.fluxmod.dk
23.\"
24.\" Created and Updated for version 0.9.7 by Curt Micol <asenchi@asenchi.com>
25.\"
26.\" Define this: <blockquote><pre>
27.de EX
28.ne 5
29.if n .sp 1
30.if t .sp .5
31.nf
32.in +.5i
33..
34.de EE
35.fi
36.in -.5i
37.if n .sp 1
38.if t .sp .5
39..
40.\" Begin actual page
41.\"
42.TH fluxstyle 1 "January 7th, 2004" "0.9.8"
43.SH NAME
44fluxstyle \- all you need to know about Fluxbox styles
45.SH DESCRIPTION
46.\"
47.\" Taken from the documentation
48.\"
49.SS What is a Style?
50A style is basically a theme for the
51.IR Fluxbox(1)
52window manager. It is a simple ASCII text file that tells Fluxbox how
53to generate the appearance of the different components of the window manager.
54The default installation of Fluxbox is shipped with many classic styles that
55show the customization of current Fluxbox versions. They are usually located in
56.IR ~/.fluxbox/styles
57and in the global Fluxbox share directory
58.IR @pkgdatadir@/styles
59which may vary depending on the method of installation used. To use one of
60the styles shipped with Fluxbox, look in your root menu under the configure
61part of the menu for 'System Styles'.
62.PP
63Fluxbox uses its own graphics class to render its images on the fly. By using
64style files, you can determine at a great level of configurability what your
65desktop will look like. Fluxbox styles are compatible with those of the
66Blackbox window manager (where Fluxbox originated). Users migrating from
67Blackbox can use their current favourite themes.
68
69.SH STRUCTURE OF STYLES
70The style is made up of a few major components which then have their own
71sub-directives. The toolbar, menu, slit and window are the major components. The
72.IR window.*
73directives control the appearance of your window frames,
74.IR window.tab.*
75controls the appearance of the window tabs.
76.IR menu.*
77controls the appearance of the popup menu that you see when you right click
78on the desktop.
79.IR toolbar.*
80is the bar you will see at the top or bottom of your screen. Finally the
81.IR slit.*
82has options you can use to customize the appearance of the slit. However
83if you don't set the slit directives specifically, the slit's appearance is controlled
84by the
85.IR toolbar.*
86directives instead.
87.PP
88To understand how the style mechanism works, it is nice to know a litte about how
89X11 resources work.
90.PP
91X11 resources consist of a key and a value. The key si constructed of several smaller
92keys (sometimes referred to as children), delimited by a period (.). Keys may also
93contain a asterisk (*) to serve as a wildcard, which means that one line of typed text
94will match several keys. This is useful for styles that are based on one or two colors.
95
96.SH LOCATION OF STYLES
97We'll cover quickly where styles can be found and placed after you create your own.
98.PP
99There are a number of default styles that come with the installation, while we have already
100covered this, we will again just provide a central location for all style locations. These
101default styles are located in
102.IR @pkgdatadir@/styles
103providing a default configureation at installation.
104.PP
105Once you create your own, you can create a directory in
106.IR ~/.fluxbox/
107called '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:
108.EX
109mkdir -p ~/.fluxbox/styles/MyStyle
110cd ~/.fluxbox/styles/MyStyle
111mkdir pixmaps
112vi theme.cfg (this being where you design your style with
113 the necessary components)
114.EE
115If you follow this, the path to your pixmaps will be:
116.IR ~/fluxbox/styles/MyStyle/pixmaps
117which makes it a bit easier to setup up and distribute your style.
118
119.SH CREATING STYLES
120As discussed in the
121.IR STRUCTURE
122section of this man page, Fluxbox allows you to configure its four main components: the toolbar, the menus, the
123slit and the window decorations. Remember that you can customize the slit with its own
124directives, but if you don't, it will take the appearance of the toolbar.
125.PP
126Here are some quick examples to illustrate basic syntax:
127.EX
128toolbar.clock.color: green
129.EE
130This sets the color resource of the toolbar clock to 'green'. Another example:
131.EX
132menu*color: rgb:3/4/5
133.EE
134This sets the color resource of the menu
135.I and all of its 'children'
136to `rgb:3/4/5'.
137(For a description of color names, see
138.IR X (1).)
139So this one also applies to
140.IR menu.title.color " and " menu.frame.color .
141And with
142.EX
143*font: -b&h-lucida-medium-r-normal-*-*-140-*
144.EE
145you set the font resource for all keys to this font name all at once.
146(For information about the fonts installed on your system, you can use a program like
147.IR xfontsel "(1), " gtkfontsel ", or " xlsfonts "(1).)"
148.PP
149This last example brings up wildcards and overrides. In a Fluxbox style you can set a value
150with a wild card. The previous example means that every font in the style will be what is
151specified. You can do this with any value. For example if you wanted all of the text to be one
152color you could do:
153.EX
154*textColor: rgb:3/4/5
155.EE
156This means you can setup a very simple style with very few properties. See
157.IR EXAMPLES
158below for an example of this in practice. You can also override wildcards in the style
159file. Lets take our example above and add an override for the toolbar.clock.textColor:
160.EX
161*textColor: rgb:3/4/5
162toolbar.clock.textColor: rgb:255/0/0
163.EE
164With that all of the text will be 'rgb:3/4/5' except the toolbar clock text which will be 'rgb:255/0/0'
165.PP
166Now, what makes Fluxbox just so spectacular, is its ability to render textures
167on the fly.
168Texture descriptions are specified directly to the key that they
169should apply to, e.g.:
170.ta \w'toolbar.clock.colorTo:\ 'u
171.EX
172toolbar.clock: Raised Gradient Diagonal Bevel1
173toolbar.clock.color: rgb:8/6/4
174toolbar.clock.colorTo: rgb:4/3/2
175.EE
176Don't worry, we will explain right now!
177A texture description consists of up to five fields, which are as follows:
178.TP
179.B Flat / Raised / Sunken
180gives the component either a flat, raised or sunken appearance.
181.TP
182.B Gradient / Solid
183tells Fluxbox to draw either a solid color or a gradient texture.
184.TP
185.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
186Select one of these texture types. They only work when also
187.B Gradient
188is specified!
189.TP
190.B Interlaced
191tells Fluxbox to interlace the texture (darken every other line).
192This option is most commonly used with gradiented textures, but from Fluxbox
193version 0.60.3 on, it also works in solid textures.
194.TP
195.B Bevel1 / Bevel2
196tells Fluxbox which type of bevel to use.
197Bevel1 is the default bevel.
198The shading is placed on the edge of the image.
199Bevel2 is an alternative.
200The shading is placed one pixel in from the edge of the image.
201.PP
202Instead of a texture description, also the option
203.B ParentRelative
204is available, which makes the component appear as a part of its parent, e.g.
205totally transparent.
206.PP
207Or for even more possibilities
208.B Pixmap .
209If pixmap texture is specified (it might not be necessary on every occasion)
210the pixmap file is specified in a separate pixmap resource.
211.EX
212toolbar.clock: pixmap
213toolbar.clock.pixmap: .fluxbox/styles/mine/clock_background.xpm
214.EE
215This feature might need some investigation, reports say that sometimes
216the resources color and colorTo must be set and then they may not be set.
217.PP
218All gradiented textures are composed of two color values: the
219.IR color " and " colorTo " resources."
220When
221.B Interlaced
222is used in
223.B Solid
224mode, the
225.I colorTo
226resource is used to find the interlacing color.
227.PP
228.SH A WORD ABOUT FONTS
229We should comment about fonts before we move on to the complete component
230list.
231.PP
232Fluxbox 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:
233.EX
234menu.title.font: sans-8:bold,shadow
235.EE
236If 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.
237.SH FULL COMPONENT LIST
238Here is the complete component list, together with which kind of value they take.
239Comments are preceded with an exclamation sign (!), which is also used for
240comments in Fluxbox style c.q. X resource files.
241.PP
242.\" The comments also to be translated!
243.SS WINDOW OPTIONS
244Many, many things you can do with window design in Fluxbox, below are your options. Have fun.
245.EX
246window.label.focus: <texture type>
247window.label.focus.pixmap: <filename>
248window.label.focus.color: <color>
249window.label.focus.colorTo: <color>
250window.label.unfocus: <texture type>
251window.label.unfocus.pixmap: <filename>
252window.label.unfocus.color: <color>
253window.label.unfocus.colorTo: <color>
254window.title.focus: <texture type>
255window.title.focus.pixmap: <filename>
256window.title.focus.color: <color>
257window.title.focus.colorTo: <color>
258window.title.unfocus: <texture type>
259window.title.unfocus.pixmap: <filename>
260window.title.unfocus.color: <color>
261window.title.unfocus.colorTo: <color>
262window.handle.focus: <texture type>
263window.handle.focus.pixmap: <filename>
264window.handle.focus.color: <color>
265window.handle.focus.colorTo: <color>
266window.handle.unfocus: <texture type>
267window.handle.unfocus.pixmap: <filename>
268window.handle.unfocus.color: <color>
269window.handle.unfocus.colorTo: <color>
270window.button.focus: <texture type>
271window.button.focus.pixmap: <filename>
272window.button.focus.color: <color>
273window.button.focus.colorTo: <color>
274window.button.unfocus: <texture type>
275window.button.unfocus.pixmap: <filename>
276window.button.unfocus.color: <color>
277window.button.unfocus.colorTo: <color>
278window.button.pressed: <texture type>
279window.button.pressed.pixmap: <filename>
280window.button.pressed.color: <color>
281window.button.pressed.colorTo: <color>
282window.grip.focus: <texture type>
283window.grip.focus.pixmap: <filename>
284window.grip.focus.color: <color>
285window.grip.focus.colorTo: <color>
286window.grip.unfocus: <texture type>
287window.grip.unfocus.pixmap: <filename>
288window.grip.unfocus.color: <color>
289window.grip.unfocus.colorTo: <color>
290window.label.focus.textColor: <color>
291window.label.unfocus.textColor: <color>
292window.frame.focusColor: <color>
293window.frame.unfocusColor: <color>
294window.button.focus.picColor: <color>
295window.button.unfocus.picColor: <color>
296window.font: <font>
297window.justify:
298window.roundCorners:
299window.alpha: <integer>
300window.title.height: <integer>
301window.bevelWidth: <integer>
302window.handleWidth: <integer>
303window.borderWidth: <integer>
304window.borderColor: <color>
305window.close.pixmap: <filename>
306window.close.unfocus.pixmap: <filename>
307window.close.pressed.pixmap: <filename>
308window.maximize.pixmap: <filename>
309window.maximize.unfocus.pixmap: <filename>
310window.maximize.pressed.pixmap: <filename>
311window.iconify.pixmap: <filename>
312window.iconify.unfocus.pixmap: <filename>
313window.iconify.pressed.pixmap: <filename>
314window.shade.pixmap: <filename>
315window.shade.unfocus.pixmap: <filename>
316window.shade.pressed.pixmap: <filename>
317window.stick.pixmap: <filename>
318window.stick.unfocus.pixmap: <filename>
319window.stick.pressed.pixmap: <filename>
320window.stuck.pixmap: <filename>
321window.stuck.unfocus.pixmap: <filename>
322.EE
323.SS MENU OPTIONS
324Everything you need to make your menu look pretty.
325.EX
326menu.title.textColor: <color>
327menu.frame.textColor: <color>
328menu.hilite.textColor: <color>
329menu.frame.disableColor: <color>
330menu.title: <texture type>
331menu.title.pixmap: <filename>
332menu.title.color: <color>
333menu.title.colorTo: <color>
334menu.frame: <texture type>
335menu.frame.pixmap: <filename>
336menu.frame.color: <color>
337menu.frame.colorTo: <color>
338menu.hilite: <texture type>
339menu.hilite.pixmap: <filename>
340menu.hilite.color: <color>
341menu.hilite.colorTo: <color>
342menu.title.font: <font>
343menu.frame.font: <font>
344menu.frame.justify:
345menu.title.justify:
346menu.bullet.position:
347menu.bullet:
348menu.borderWidth:
349menu.bevelWidth:
350menu.borderColor: <color>
351menu.submenu.pixmap: <filename>
352menu.selected.pixmap: <filename>
353menu.unselected.pixmap: <filename>
354menu.roundCorners:
355menu.titleHeight: <integer>
356menu.itemHeight: <integer>
357.EE
358.SS ROOT COMMAND OPTION
359This 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
360.EX
361rootCommand: <string>
362.EE
363.SS SLIT
364Here are all of the options for the slit.
365.EX
366slit: <texture type>
367slit.pixmap: <filename>
368slit.color: <color>
369slit.colorTo: <color>
370slit.borderWidth: <integer>
371slit.bevelWidth: <integer>
372slit.borderColor: <color>
373.EE
374.SS TOOLBAR OPTIONS
375Below 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.
376.EX
377toolbar: <texture type>
378toolbar.pixmap: <filename>
379toolbar.color: <color>
380toolbar.colorTo: <color>
381toolbar.borderWidth: <integer>
382toolbar.borderColor: <color>
383toolbar.bevelWidth: <0-255>
384toolbar.shaped: <boolean>
385toolbar.alpha: <integer>
386toolbar.height: <integer>
387toolbar.clock.font: <font>
388toolbar.clock.textColor: <color>
389toolbar.clock.justify:
390toolbar.clock: <texture type>
391toolbar.clock.pixmap: <filename>
392toolbar.clock.color: <color>
393toolbar.clock.colorTo: <color>
394toolbar.clock.borderWidth: <integer>
395toolbar.clock.borderColor: <color>
396toolbar.workspace.font: <font>
397toolbar.workspace.textColor: <color>
398toolbar.workspace.justify:
399toolbar.workspace: <texture type>
400toolbar.workspace.pixmap: <filename>
401toolbar.workspace.color: <color>
402toolbar.workspace.colorTo: <color>
403toolbar.workspace.borderWidth: <integer>
404toolbar.workspace.borderColor: <color>
405toolbar.iconbar.focused: <texture type>
406toolbar.iconbar.focused.pixmap: <filename>
407toolbar.iconbar.focused.color: <color>
408toolbar.iconbar.focused.colorTo: <color>
409toolbar.iconbar.unfocused: <texture type>
410toolbar.iconbar.unfocused.pixmap: <filename>
411toolbar.iconbar.unfocused.color: <color>
412toolbar.iconbar.unfocused.colorTo: <color>
413toolbar.iconbar.empty: <texture type>
414toolbar.iconbar.empty.pixmap: <filename>
415toolbar.iconbar.empty.color: <color>
416toolbar.iconbar.empty.colorTo: <color>
417toolbar.iconbar.focused.borderWidth: <integer>
418toolbar.iconbar.focused.borderColor: <color>
419toolbar.iconbar.unfocused.borderWidth: <integer>
420toolbar.iconbar.unfocused.borderColor: <color>
421toolbar.iconbar.borderWidth: <integer>
422toolbar.iconbar.borderColor: <color>
423toolbar.iconbar.focused.font: <font>
424toolbar.iconbar.focused.textColor: <color>
425toolbar.iconbar.focused.justify:
426toolbar.iconbar.unfocused.font: <font>
427toolbar.iconbar.unfocused.textColor: <color>
428toolbar.iconbar.unfocused.justify:
429.EE
430.SH EXAMPLES
431This may seem like a long list, but remember, when you create your own style, you
432can easily set lots of keys with a single command, e.g.
433.EX
434.ta \w'*unfocus.textColor:\ 'u
435*color: slategrey
436*colorTo: darkslategrey
437*unfocus.color: darkslategrey
438*unfocus.colorTo: black
439*textColor: white
440*unfocus.textColor: lightgrey
441*font: lucidasans-10
442.EE
443This sets already nice defaults for many components.
444
445.SH COLOR FORMATS
446These are the color formats for styles:
447.EX
448#000000 (Hexadecimal)
449/usr/X11R6/lib/X11/rgb.txt
450.EE
451
452.SH AUTHOR and CREDITS
453Blackbox was written and maintained by Brad Hughes
454.nh \" hyphenation off
455<blackbox@alug.org>
456.hy \" on again
457and Jeff Raven
458.nh
459<jraven@psu.edu>,
460.hy
461.PP
462Fluxbox is written and maintained by Henrik Kinnunen
463.nh
464<fluxgen@linuxmail.org>
465.hy
466with contributions and patches merged from
467many individuals around the world.
468.PP
469The Official Fluxbox website:
470.nh
471.B http://www.fluxbox.org/
472.hy
473.PP
474Fluxmod was a Fluxbox community site where you could find many new styles that
475work with this version of Fluxbox and take advantage of all the new features.
476However, fluxmod is no more, but a new site gaining popularity is:
477.nh
478.B http://www.fluxcandy.org
479.hy
480.PP
481You can also find more styles here:
482.nh
483.B http://themes.freshmeat.net/
484.PP
485This manpage was composed from various resources including the documentation, fluxbox
486man page and numerous other resources by Curt Micol
487.nh
488<asenchi@asenchi.com>
489.hy
490and using the great contributions of
491.hy
492<grubert@users.sourceforge.net>.
493.nh
494Numerous other languages could be available if someone jumps in.
495.SH SEE ALSO
496.IR fluxbox (1)
497.IR bsetroot (1)
498
499.\" ADDITIONS TO MAKE
500.\" Change layout of theme items
501.\" Become a little more verbose on color usage.
502.\"