aboutsummaryrefslogtreecommitdiff
path: root/doc/asciidoc/fluxstyle.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc/fluxstyle.1')
-rw-r--r--doc/asciidoc/fluxstyle.1451
1 files changed, 451 insertions, 0 deletions
diff --git a/doc/asciidoc/fluxstyle.1 b/doc/asciidoc/fluxstyle.1
new file mode 100644
index 0000000..900e32d
--- /dev/null
+++ b/doc/asciidoc/fluxstyle.1
@@ -0,0 +1,451 @@
1.\" Title: fluxstyle
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
4.\" Date: 04/21/2007
5.\" Manual:
6.\" Source:
7.\"
8.TH "FLUXSTYLE" "1" "04/21/2007" "" ""
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14fluxstyle \- A comprehensive look at styles/themes for fluxbox(1).
15.SH "SYNOPSIS"
16This document describes various options available for fluxbox styles.
17.sp
18.SH "DESCRIPTION"
19What is a Style?
20.sp
21Styles, sometimes referred to as Themes, are a graphical overlay for the fluxbox(1) window manager. If you wanted to get to know fluxbox, the styles would be the \fIlook\fR of the \fIlook and feel\fR.
22.sp
23Styles are simple ASCII text files that tell fluxbox(1) how to generate the appearance of different components of the window manager. The default installation of fluxbox(1) is shipped with many classic examples that show a great deal of what one could do. To use one of the standard styles navigate to the \fISystem Styles\fR menu under your main fluxbox(1) menu.
24.sp
25fluxbox(1) uses its own graphics class to render its images on the fly. By using styles you can determine, at a great level of configurability, what your desktop will look like. Since fluxbox(1) was derived from blackbox many often wonder if old themes will work on the latest releases of fluxbox(1). Well they basically do, but you will have to tune them since the fluxbox(1) code has changed quite a bit since the initial grab.
26.sp
27.SH "STRUCTURE"
28A style is made up of a few major components which then have their own sub\-directives. The major components are as follows:
29.sp
30The \fIwindow.*\fR directives control the appearance of the window frames, window.tab.* controls the appearance of the window tabs, \fImenu.*\fR controls the appearance of the popup menu that you see when you right click on the desktop. \fItoolbar.*\fR is the bar you will see at the top or bottom of your screen. Finally the \fIslit.*\fR has options you can use to customize the appearance of the slit. However if you don't set the slit directives specifically, the slit's appearance is controlled by the toolbar directives instead.
31.sp
32To understand how the style mechanism works, it is nice to know a little about how X11 resources work. X11 resources consist of a key and a value. The key is constructed of several smaller keys (sometimes referred to as children), delimited by a period (.). Keys may also contain an asterisk (*) to serve as a wildcard, which means that one line of text will match several keys. This is useful for styles that are based on one or two colors.
33.sp
34A more complete reference to this can be found in X(7), section \fIRESOURCES\fR.
35.sp
36.SH "LOCATION"
37There are many places to store your styles, the most common is in your \fI~/.fluxbox/styles\fR directory. The initial installation will place the default styles in \fI@pkg_datadir@/styles\fR providing a basic usable configuration.
38.sp
39When creating your own style, create a directory (normally the name of your style) in \fI~/.fluxbox/styles/\fR (If the \fIstyles\fR directory doesn't exist, create that also). While there isn't an official structure, it is common to create a directory named after your style and place your pixmaps directory (if required) in there along with a file called theme.cfg (may also be named style.cfg). This file is where you will construct your style using the components covered later in this manual page. An example of steps taken when beginning a style project of your own may look like:
40.sp
41.sp
42.RS 4
43.nf
44$ cd
45$ mkdir \-p ~/.fluxbox/styles/YourStyle/pixmaps
46$ cd ~/.fluxbox/styles/YourStyle
47$ nano theme.cfg
48.fi
49.RE
50Output of a packaged style should look like the following:
51.sp
52.sp
53.RS 4
54.nf
55$ cd
56$ tar \-tjvf YourStyle.tar.bz2
57 .fluxbox/styles/YourStyle/theme.cfg
58 .fluxbox/styles/YourStyle/pixmaps
59 .fluxbox/styles/YourStyle/pixmaps/stick.xpm
60 ...
61.fi
62.RE
63Of course, all of these are just preferences, fluxbox(1) allows for the customization of many things, including how you handle your styles. Just remember, however, that if you plan to distribute your style you may find some community bickering if you don't follow practices. :)
64.sp
65.SH "CREATING YOUR STYLE"
66As discussed above, fluxbox(1) allows you to configure its four main components: the toolbar, menus, slit and window decorations. Remember that you can customize the slit with its own directives, otherwise the slit will take the appearance of the toolbar.
67.sp
68Here are some quick examples to illustrate basic syntax:
69.sp
70.sp
71.RS 4
72.nf
73toolbar.clock.color: green
74.fi
75.RE
76This sets the color resource of the toolbar clock to \fIgreen\fR. Another example:
77.sp
78.sp
79.RS 4
80.nf
81menu*color: rgb:3/4/5
82.fi
83.RE
84This sets the color resource of the menu and all of its \fIchildren\fR to `rgb:3/4/5'. (For a description of color names, see X(1).) So this one also applies to \fImenu.title.color\fR and \fImenu.frame.color\fR. And with
85.sp
86.sp
87.RS 4
88.nf
89*font: \-b&h\-lucida\-medium\-r\-normal\-*\-*\-140\-*
90.fi
91.RE
92you set the font resource for all keys to this font name all at once (For information about the fonts installed on your system, you can use a program like xfontsel(1), gtkfontsel, or xlsfonts(1).)
93.sp
94In the last example you will notice the wildcard (*) before font. In a Fluxbox style you can set a value with a wildcard. The example means that every font in the style will be what is specified. You can do this with any component/value. For example if you wanted all of the text to be one color you would do:
95.sp
96.sp
97.RS 4
98.nf
99*textColor: rgb:3/4/5
100.fi
101.RE
102This means that you can setup a very simple style with very few properties. See the EXAMPLES below for an example of this in practice. fluxbox(1) also allows you to override wildcards in your style. Lets take our example above and add an override for the toolbar.clock.textColor component:
103.sp
104.sp
105.RS 4
106.nf
107*textColor: rgb:3/4/5
108toolbar.clock.textColor: rgb:255/0/0
109.fi
110.RE
111With that all of the text will be \fIrgb:3/4/5\fR except the toolbar clock text which will be \fIrgb:255/0/0\fR.
112.sp
113Now what makes fluxbox(1) so spectacular is its ability to render textures on the fly. A texture is a fillpattern that you see on some styles. Texture descriptions are specified directly to the key that they should apply to, e.g.:
114.sp
115.sp
116.RS 4
117.nf
118toolbar.clock: Raised Gradient Diagonal Bevel1
119toolbar.clock.color: rgb:8/6/4
120toolbar.clock.colorTo: rgb:4/3/2
121.fi
122.RE
123Don't worry, we will explain what these mean. A texture description consists of up to five fields, which are as follows:
124.sp
125.PP
126\fBFlat | Raised | Sunken\fR. gives the component either a flat, raised or sunken appearance.
127.PP
128\fBGradient | Solid\fR. tells fluxbox(1) to draw either a solid color or a gradient texture.
129.PP
130\fBHorizontal | Vertical | Diagonal | Crossdiagonal | Pipecross | Elliptic | Rectangle | Pyramid\fR. Select one of these texture types. They only work when
131\fBGradient\fR
132is specified.
133.PP
134\fBInterlaced\fR. tells fluxbox(1) to interlace the texture (darken every other line). This option is most commonly used with gradiented textures, but it also works in solid textures.
135.PP
136\fBBevel1 | Bevel2\fR. tells fluxbox(1) which type of bevel to use. Bevel1 is the default bevel. The shading is placed on the edge of the image. Bevel2 is an alternative. The shading is placed one pixel in from the edge of the image.
137Instead of a texture description, also the option \fBParentRelative\fR is available, which makes the component appear as a part of its parent, e.g. totally transparent.
138.sp
139Or for even more possibilities Pixmap. If pixmap texture is specified (it might not be necessary on every occasion) the pixmap file is specified in a separate pixmap resource.
140.sp
141.sp
142.RS 4
143.nf
144toolbar.clock: pixmap
145toolbar.clock.pixmap: clock_background.xpm
146.fi
147.RE
148This feature might need some investigation, reports say that sometimes the resources color and colorTo must be set and then they may not be set.
149.sp
150All gradiented textures are composed of two color values: the \fIcolor\fR and \fIcolorTo\fR resources. When \fBInterlaced\fR is used in \fBSolid\fR mode, the \fIcolorTo\fR resource is used to find the interlacing color.
151.sp
152.SH "A WORD ABOUT FONTS"
153We should comment about fonts before we move on to the complete component list. fluxbox(1) supports different options for text. These options currently include bold, halo and shadow. To set these do this: fontname\-size:options for any of the font components in the style file. For example:
154.sp
155.sp
156.RS 4
157.nf
158menu.title.font: sans\-8:bold,shadow
159.fi
160.RE
161The latest versions of fluxbox(1) (> 0.9.8) also support different values for these text options. The possibilities are as follows:
162.sp
163.sp
164.RS 4
165.nf
166\-\-\-\-\-\-\-\-
167Shadow color=<colorname> offsetx=<integer> offsety=<integer> Halo color=<colorname>
168\-\-\-\-\-\-\-\-
169.fi
170.RE
171For the case of completeness, here are some real world examples:
172.sp
173.sp
174.RS 4
175.nf
176*.font: Verdana\-10:bold,shadow:offsetx=2;offsety=4;color=green
177*.font: Verdana\-10:halo:color=blue
178.fi
179.RE
180Of course this could all be placed on one line. Also note that for the offset options, negative integers are allowed.
181.sp
182.SS "FONT PROBLEMS"
183If 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: \fIhttp://xfree.org/4.3.0/fonts2.html#3\fR
184.sp
185.SH "FULL COMPONENT LIST"
186Here is the exhaustive component list for fluxbox(1) styles. Each one is listed with their type of value required. Comments in a style file are preceded with an exclamation point (!) which we also use here so that these can be pasted into a new theme.cfg to be customized appropiately. Please note that in order to keep styles consistent it is often the practice of stylists to provide all of the theme\-items in their style file even if they are not used. This allows the user the ease of changing different components.
187.sp
188.SH "WINDOW OPTIONS"
189Many, many things you can do with window design in fluxbox(1), below are your options. Have fun.
190.sp
191.sp
192.RS 4
193.nf
194\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
195window.bevelWidth: <integer>
196window.borderColor: <color>
197window.borderWidth: <integer>
198window.button.focus: <texture type>
199window.button.focus.color: <color>
200window.button.focus.colorTo: <color>
201window.button.focus.picColor: <color>
202window.button.focus.pixmap: <filename>
203window.button.pressed: <texture type>
204window.button.pressed.color: <color>
205window.button.pressed.colorTo: <color>
206window.button.pressed.pixmap: <filename>
207window.button.unfocus: <texture type>
208window.button.unfocus.color: <color>
209window.button.unfocus.colorTo: <color>
210window.button.unfocus.picColor: <color>
211window.button.unfocus.pixmap: <filename>
212window.close.pixmap: <filename>
213window.close.pressed.pixmap: <filename>
214window.close.unfocus.pixmap: <filename>
215window.font: <font>
216window.frame.focusColor: <color>
217window.frame.unfocusColor: <color>
218window.grip.focus: <texture type>
219window.grip.focus.color: <color>
220window.grip.focus.colorTo: <color>
221window.grip.focus.pixmap: <filename>
222window.grip.unfocus: <texture type>
223window.grip.unfocus.color: <color>
224window.grip.unfocus.colorTo: <color>
225window.grip.unfocus.pixmap: <filename>
226window.handle.focus: <texture type>
227window.handle.focus.color: <color>
228window.handle.focus.colorTo: <color>
229window.handle.focus.pixmap: <filename>
230window.handle.unfocus: <texture type>
231window.handle.unfocus.color: <color>
232window.handle.unfocus.colorTo: <color>
233window.handle.unfocus.pixmap: <filename>
234window.handleWidth: <integer>
235window.iconify.pixmap: <filename>
236window.iconify.pressed.pixmap: <filename>
237window.iconify.unfocus.pixmap: <filename>
238window.justify: <{Left|Right|Center}>
239window.label.active: <texture type>
240window.label.active.textColor: <color>
241window.label.focus: <texture type>
242window.label.focus.color: <color>
243window.label.focus.colorTo: <color>
244window.label.focus.pixmap: <filename>
245window.label.unfocus: <texture type>
246window.label.unfocus.color: <color>
247window.label.unfocus.colorTo: <color>
248window.label.unfocus.pixmap: <filename>
249window.label.focus.textColor: <color>
250window.label.unfocus.textColor: <color>
251window.maximize.pixmap: <filename>
252window.maximize.pressed.pixmap: <filename>
253window.maximize.unfocus.pixmap: <filename>
254window.roundCorners: <{Top|Bottom}{Left|Right}>
255window.shade.pixmap: <filename>
256window.shade.pressed.pixmap: <filename>
257window.shade.unfocus.pixmap: <filename>
258window.stick.pixmap: <filename>
259window.stick.pressed.pixmap: <filename>
260window.stick.unfocus.pixmap: <filename>
261window.stuck.pixmap: <filename>
262window.stuck.unfocus.pixmap: <filename>
263window.title.focus: <texture type>
264window.title.focus.color: <color>
265window.title.focus.colorTo: <color>
266window.title.focus.pixmap: <filename>
267window.title.height: <integer>
268window.title.unfocus: <texture type>
269window.title.unfocus.color: <color>
270window.title.unfocus.colorTo: <color>
271window.title.unfocus.pixmap: <filename>
272\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
273.fi
274.RE
275.SH "MENU OPTIONS"
276Everything you need to make your menu look pretty.
277.sp
278.sp
279.RS 4
280.nf
281\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
282menu.bevelWidth: <integer>
283menu.borderColor: <color>
284menu.borderWidth: <integer>
285menu.bullet: <{empty|square|triangle|diamond}>
286menu.bullet.position: <{left|right}>
287menu.frame: <texture type>
288menu.frame.color: <color>
289menu.frame.colorTo: <color>
290menu.frame.disableColor: <color>
291menu.frame.font: <font>
292menu.frame.justify: <{Left|Right|Center}>
293menu.frame.pixmap: <filename>
294menu.frame.textColor: <color>
295menu.hilite: <texture type>
296menu.hilite.color: <color>
297menu.hilite.colorTo: <color>
298menu.hilite.pixmap: <filename>
299menu.hilite.textColor: <color>
300menu.itemHeight: <integer>
301menu.title: <texture type>
302menu.title.color: <color>
303menu.title.colorTo: <color>
304menu.title.font: <font>
305menu.title.pixmap: <filename>
306menu.title.textColor: <color>
307menu.title.justify: <{Left|Right|Center}>
308menu.titleHeight: <integer>
309menu.roundCorners: <{Top|Bottom}{Left|Right}>
310menu.selected.pixmap: <filename>
311menu.submenu.pixmap: <filename>
312menu.unselected.pixmap: <filename>
313\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
314.fi
315.RE
316.SH "BACKGROUND"
317Every style must specify the background option. If you don't want your style to change the user's background, then use `background: none'. The options `centered', `aspect', `tiled', and `fullscreen' require the `background.pixmap' resource to contain a valid file name. The `random' option requires `background.pixmap' to contain a valid directory name. For these options, fluxbox(1) will call fbsetbg(1) to set the background. The options `gradient', `solid', and `mod' all require `background.color' to be set. `gradient' and `mod' both require `background.colorTo'. `mod' requires `background.modX' and `background.modY' to be set as well. These options will be passed to fbsetroot(1) to set the background.
318.sp
319.sp
320.RS 4
321.nf
322background: centered|aspect|tiled|fullscreen|random|solid|gradient <texture>|mod|none
323background.pixmap: <file or directory>
324background.color: <color>
325background.colorTo: <color>
326background.modX: <integer>
327background.modY: <integer>
328.fi
329.RE
330.SH "SLIT"
331Here are all of the options for the slit.
332.sp
333.sp
334.RS 4
335.nf
336\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
337slit: <texture type>
338slit.bevelWidth: <integer>
339slit.borderColor: <color>
340slit.borderWidth: <integer>
341slit.color: <color>
342slit.colorTo: <color>
343slit.pixmap: <filename>
344\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
345.fi
346.RE
347.SH "TOOLBAR OPTIONS"
348Below 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.
349.sp
350.sp
351.RS 4
352.nf
353\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
354toolbar: <texture type>
355toolbar.bevelWidth: <integer (0\-255)>
356toolbar.borderColor: <color>
357toolbar.borderWidth: <integer>
358toolbar.button.scale: <integer>
359toolbar.color: <color>
360toolbar.colorTo: <color>
361toolbar.clock: <texture type>
362toolbar.clock.borderColor: <color>
363toolbar.clock.borderWidth: <integer>
364toolbar.clock.font: <font>
365toolbar.clock.justify: <{Left|Right|Center}>
366toolbar.clock.pixmap: <filename>
367toolbar.clock.color: <color>
368toolbar.clock.colorTo: <color>
369toolbar.clock.textColor: <color>
370toolbar.height: <integer>
371toolbar.iconbar.focused: <texture type>
372toolbar.iconbar.focused.color: <color>
373toolbar.iconbar.focused.colorTo:<color>
374toolbar.iconbar.focused.pixmap: <filename>
375toolbar.iconbar.unfocused: <texture type>
376toolbar.iconbar.unfocused.color: <color>
377toolbar.iconbar.unfocused.colorTo: <color>
378toolbar.iconbar.unfocused.pixmap: <filename>
379toolbar.iconbar.empty: <texture type>
380toolbar.iconbar.empty.color: <color>
381toolbar.iconbar.empty.colorTo: <color>
382toolbar.iconbar.empty.pixmap: <filename>
383toolbar.iconbar.focused.borderColor: <color>
384toolbar.iconbar.focused.borderWidth: <integer>
385toolbar.iconbar.unfocused.borderColor: <color>
386toolbar.iconbar.unfocused.borderWidth: <integer>
387toolbar.iconbar.borderColor: <color>
388toolbar.iconbar.borderWidth: <integer>
389toolbar.iconbar.focused.font: <font>
390toolbar.iconbar.focused.justify: <{Left|Right|Center}>
391toolbar.iconbar.focused.textColor: <color>
392toolbar.iconbar.unfocused.font: <font>
393toolbar.iconbar.unfocused.justify: <{Left|Right|Center}>
394toolbar.iconbar.unfocused.textColor: <color>
395toolbar.pixmap: <filename>
396toolbar.shaped: <boolean>
397toolbar.workspace.font: <font>
398toolbar.workspace.justify: <{Left|Right|Center}>
399toolbar.workspace.textColor: <color>
400toolbar.workspace: <texture type>
401toolbar.workspace.borderColor: <color>
402toolbar.workspace.borderWidth: <integer>
403toolbar.workspace.color: <color>
404toolbar.workspace.colorTo: <color>
405toolbar.workspace.pixmap: <filename>
406\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
407.fi
408.RE
409.SH "EXAMPLES"
410This list may seem intimidating, but remember, when you create your own style you can easily set a majority of these keys with a single component. For an example of this:
411.sp
412.sp
413.RS 4
414.nf
415\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
416*color: slategrey
417*colorTo: darkslategrey
418*unfocus.color: darkslategrey
419*unfocus.colorTo: black
420*textColor: white
421*unfocus.textColor: lightgrey
422*font: lucidasans\-10
423\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
424.fi
425.RE
426This sets nice defaults for many components.
427.sp
428.SH "COLOR FORMATS"
429These are the color formats for styles:
430.sp
431.sp
432.RS 4
433.nf
434#000000 (Hexadecimal)
435rgb:<0\-255>/<0\-255>/<0\-255>
436.fi
437.RE
438See /usr/X11R6/lib/X11/rgb.txt for an explaination.
439.sp
440.SH "AUTHOR AND CREDITS"
441Blackbox was written and maintained by Brad Hughes <blackbox@alug.org> and Jeff Raven <jraven@psu.edu>.
442.sp
443fluxbox(1) is written and maintained by Henrik Kinnunen <fluxgen@fluxbox.org> with contributions and patches merged from many individuals around the world.
444.sp
445The Official fluxbox(1) website: \fIhttp://www.fluxbox.org\fR You can find a lot of styles here: \fIhttp://tenr.de/\fR
446.sp
447This manpage was composed from various resources including the official documentation, fluxbox(1) man page and numerous other resources by Curt "Asenchi" Micol. If you notice any errors or problems with this page, please contact him here: <asenchi@asenchi.com> and using the great contributions of <grubert@users.sourceforge.net>. Numerous other languages could be available if someone jumps in.
448.sp
449.SH "SEE ALSO"
450fluxbox(1) fbsetbg(1) fbsetroot(1)
451.sp
generated by cgit v0.11.2 at 2024-10-30 02:47:14 (GMT)