diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/asciidoc/fluxbox-style.txt | 118 |
1 files changed, 61 insertions, 57 deletions
diff --git a/doc/asciidoc/fluxbox-style.txt b/doc/asciidoc/fluxbox-style.txt index c41937e..7c35e15 100644 --- a/doc/asciidoc/fluxbox-style.txt +++ b/doc/asciidoc/fluxbox-style.txt | |||
@@ -30,10 +30,10 @@ the 'System Styles' menu under your main fluxbox(1) menu. | |||
30 | 30 | ||
31 | fluxbox(1) uses its own graphics class to render its images on the fly. By | 31 | fluxbox(1) uses its own graphics class to render its images on the fly. By |
32 | using styles you can determine, at a great level of configurability, what your | 32 | using styles you can determine, at a great level of configurability, what your |
33 | desktop will look like. Since fluxbox(1) was derived from blackbox many often | 33 | desktop will look like. Since fluxbox(1) was derived from blackbox(1) many often |
34 | wonder if old themes will work on the latest releases of fluxbox(1). Well they | 34 | wonder if old themes will work on the latest releases of fluxbox(1). Well they |
35 | basically do, but you will have to tune them since the fluxbox(1) code has | 35 | basically do, but you will have to tune them since the fluxbox(1) code has |
36 | changed quite a bit since the initial grab. | 36 | changed quite a bit since the initial fork. |
37 | 37 | ||
38 | STRUCTURE | 38 | STRUCTURE |
39 | --------- | 39 | --------- |
@@ -89,10 +89,10 @@ Output of a packaged style should look like the following: | |||
89 | .fluxbox/styles/YourStyle/pixmaps/stick.xpm | 89 | .fluxbox/styles/YourStyle/pixmaps/stick.xpm |
90 | ... | 90 | ... |
91 | 91 | ||
92 | Of course, all of these are just preferences, fluxbox(1) allows for the | 92 | All of this is just best practice, fluxbox(1) allows youto "bend" the rules |
93 | customization of many things, including how you handle your styles. Just | 93 | fairly far. Keep in mind that following the advice suggested here is strongly |
94 | remember, however, that if you plan to distribute your style you may find | 94 | suggested if you wish to distribute your style to others. Themes that break |
95 | some community bickering if you don't follow practices. :) | 95 | policy are usually subject to critique from members of the community. |
96 | 96 | ||
97 | CREATING YOUR STYLE | 97 | CREATING YOUR STYLE |
98 | ------------------- | 98 | ------------------- |
@@ -101,36 +101,37 @@ the toolbar, menus, slit and window decorations. Remember that you can | |||
101 | customize the slit with its own directives, otherwise the slit will take the | 101 | customize the slit with its own directives, otherwise the slit will take the |
102 | appearance of the toolbar. | 102 | appearance of the toolbar. |
103 | 103 | ||
104 | Here are some quick examples to illustrate basic syntax: | 104 | Here are some quick examples to illustrate the style's basic syntax: |
105 | 105 | ||
106 | toolbar.clock.color: green | 106 | toolbar.clock.color: green |
107 | 107 | ||
108 | This sets the color resource of the toolbar clock to 'green'. Another example: | 108 | This next example sets the color resource of the toolbar clock to 'green': |
109 | 109 | ||
110 | menu*color: rgb:3/4/5 | 110 | menu*color: rgb:3/4/5 |
111 | 111 | ||
112 | This sets the color resource of the menu and all of its 'children' to | 112 | The following sets the color resource of the menu and all of its 'children' to |
113 | `rgb:3/4/5'. (For a description of color names, see X(1).) So this one also | 113 | `rgb:3/4/5' -- that is to say this directive applies to both 'menu.title.color' |
114 | applies to 'menu.title.color' and 'menu.frame.color'. And with | 114 | and 'menu.frame.color'. For a complete description of color names, see the X(1) |
115 | manpage's section on this topic. | ||
115 | 116 | ||
116 | *font: -b&h-lucida-medium-r-normal-*-*-140-* | 117 | *font: -b&h-lucida-medium-r-normal-*-*-140-* |
117 | 118 | ||
118 | you set the font resource for all keys to this font name all at once (For | 119 | Now, if we examine this line further, you will notice that it sets the font |
119 | information about the fonts installed on your system, you can use a | 120 | resource for all keys to this font name all at once (For information about the |
120 | program like xfontsel(1), gtkfontsel, or xlsfonts(1).) | 121 | fonts installed on your system, you can use a program like xfontsel(1), |
122 | gtkfontsel, or xlsfonts(1).) you will also notice the wildcard (*) before font. | ||
123 | In a Fluxbox style you can set a value with a wildcard. This means that every | ||
124 | font in the style will be what is specified. You can do this with any | ||
125 | component/value. | ||
121 | 126 | ||
122 | In the last example you will notice the wildcard (*) before font. In a Fluxbox | 127 | For example, if you wanted all of the text to be one color you would do: |
123 | style you can set a value with a wildcard. The example means that every font | ||
124 | in the style will be what is specified. You can do this with any | ||
125 | component/value. For example if you wanted all of the text to be one color you | ||
126 | would do: | ||
127 | 128 | ||
128 | *textColor: rgb:3/4/5 | 129 | *textColor: rgb:3/4/5 |
129 | 130 | ||
130 | This means that you can setup a very simple style with very few properties. | 131 | This means that you can setup a very simple style with very few properties. |
131 | See the EXAMPLES below for an example of this in practice. fluxbox(1) also allows | 132 | See the EXAMPLES below for an example of this in practice. fluxbox(1) also |
132 | you to override wildcards in your style. Lets take our example above and add | 133 | allows you to override wildcards in your style. Lets take our example above and |
133 | an override for the toolbar.clock.textColor component: | 134 | add an override for the toolbar.clock.textColor component: |
134 | 135 | ||
135 | *textColor: rgb:3/4/5 | 136 | *textColor: rgb:3/4/5 |
136 | toolbar.clock.textColor: rgb:255/0/0 | 137 | toolbar.clock.textColor: rgb:255/0/0 |
@@ -138,10 +139,11 @@ an override for the toolbar.clock.textColor component: | |||
138 | With that all of the text will be 'rgb:3/4/5' except the toolbar clock text | 139 | With that all of the text will be 'rgb:3/4/5' except the toolbar clock text |
139 | which will be 'rgb:255/0/0'. | 140 | which will be 'rgb:255/0/0'. |
140 | 141 | ||
141 | Now what makes fluxbox(1) so spectacular is its ability to render textures on the | 142 | Now what makes fluxbox(1) so spectacular is its ability to render textures on |
142 | fly. A texture is a fillpattern that you see on some styles. Texture | 143 | the fly. A texture is a fillpattern that you see on some styles. Texture |
143 | descriptions are specified directly to the key that they should apply to, | 144 | descriptions are specified directly to the key that they should apply to. |
144 | e.g.: | 145 | |
146 | For example: | ||
145 | 147 | ||
146 | toolbar.clock: Raised Gradient Diagonal Bevel1 | 148 | toolbar.clock: Raised Gradient Diagonal Bevel1 |
147 | toolbar.clock.color: rgb:8/6/4 | 149 | toolbar.clock.color: rgb:8/6/4 |
@@ -187,34 +189,35 @@ All gradiented textures are composed of two color values: the 'color' and | |||
187 | 'colorTo' resources. When *Interlaced* is used in *Solid* mode, the 'colorTo' | 189 | 'colorTo' resources. When *Interlaced* is used in *Solid* mode, the 'colorTo' |
188 | resource is used to find the interlacing color. | 190 | resource is used to find the interlacing color. |
189 | 191 | ||
190 | A WORD ABOUT FONTS | 192 | FONT EFFECTS |
191 | ------------------ | 193 | ------------ |
192 | We should comment about fonts before we move on to the complete component | 194 | In addition to specifying the typeface and weight (such as bold) via the |
193 | list. fluxbox(1) supports different options for text. These options currently | 195 | font rendering engine (such as Xft) by passing extra options to the font |
194 | include bold, halo and shadow. To set these do this: fontname-size:options for | 196 | attribute, fluxbox(1) supports some additional font styles (such as 'halo' and |
195 | any of the font components in the style file. For example: | 197 | 'shadow') which may be passed into the 'effect' attribute. |
196 | |||
197 | menu.title.font: sans-8:bold,shadow | ||
198 | 198 | ||
199 | The latest versions of fluxbox(1) (> 0.9.8) also support different values for | 199 | For example, the following will set a menu's title string to 8 point sans font, |
200 | these text options. The possibilities are as follows: | 200 | bolded, with a green drop shadow: |
201 | 201 | ||
202 | -------- | 202 | menu.title.font: sans-8:bold |
203 | Shadow color=<colorname> offsetx=<integer> offsety=<integer> Halo color=<colorname> | 203 | menu.title.effect: shadow |
204 | -------- | 204 | menu.title.shadow.color: green |
205 | menu.title.shadow.x: 3 | ||
206 | menu.title.shadow.y: 3 | ||
205 | 207 | ||
206 | For the case of completeness, here are some real world examples: | 208 | Or, to claify this point further, the following example demonstrates how to set |
209 | this same text to an 8 point sans font, bolded with a green halo rather then a | ||
210 | shaddow: | ||
207 | 211 | ||
208 | *.font: Verdana-10:bold,shadow:offsetx=2;offsety=4;color=green | 212 | menu.title.font: sans-8:bold |
209 | *.font: Verdana-10:halo:color=blue | 213 | menu.title.effect: halo |
214 | menu.title.halo.color: green | ||
210 | 215 | ||
211 | Of course this could all be placed on one line. Also note that for the offset | ||
212 | options, negative integers are allowed. | ||
213 | 216 | ||
214 | FONT PROBLEMS | 217 | FONT PROBLEMS |
215 | ~~~~~~~~~~~~~ | 218 | ~~~~~~~~~~~~~ |
216 | If you have problems installing fonts or getting them to work, you should read | 219 | If you have problems installing fonts or getting them to work, you should read |
217 | the docs page at xfree.org. Here is a link to one of these: | 220 | the docs page at xfree.org, found at: |
218 | http://xfree.org/4.3.0/fonts2.html#3[] | 221 | http://xfree.org/4.3.0/fonts2.html#3[] |
219 | 222 | ||
220 | FULL COMPONENT LIST | 223 | FULL COMPONENT LIST |
@@ -229,8 +232,8 @@ used. This allows the user the ease of changing different components. | |||
229 | 232 | ||
230 | WINDOW OPTIONS | 233 | WINDOW OPTIONS |
231 | -------------- | 234 | -------------- |
232 | Many, many things you can do with window design in fluxbox(1), below are your | 235 | Much like cats, there are many ways to skin fluxbox(1). To help you figure out |
233 | options. Have fun. | 236 | how to scratch your itch, a comprehensive list of options follows. Have fun! |
234 | 237 | ||
235 | ----------------------------------------- | 238 | ----------------------------------------- |
236 | window.bevelWidth: <integer> | 239 | window.bevelWidth: <integer> |
@@ -357,13 +360,13 @@ change the user's background, then use `background: none'. The options | |||
357 | `centered', `aspect', `tiled', and `fullscreen' require the `background.pixmap' | 360 | `centered', `aspect', `tiled', and `fullscreen' require the `background.pixmap' |
358 | resource to contain a valid file name. The `random' option requires | 361 | resource to contain a valid file name. The `random' option requires |
359 | `background.pixmap' to contain a valid directory name. For these options, | 362 | `background.pixmap' to contain a valid directory name. For these options, |
360 | *fluxbox(1)* will call *fbsetbg(1)* to set the background. The options `gradient', | 363 | *fluxbox(1)* will call *fbsetbg(1)* to set the background. The options |
361 | `solid', and `mod' all require `background.color' to be set. `gradient' and | 364 | `gradient', `solid', and `mod' all require `background.color' to be set. |
362 | `mod' both require `background.colorTo'. `mod' requires `background.modX' and | 365 | `gradient' and `mod' both require `background.colorTo'. `mod' requires |
363 | `background.modY' to be set as well. These options will be passed to | 366 | `background.modX' and `background.modY' to be set as well. These options will be |
364 | *fbsetroot(1)* to set the background. The special option `unset' is for use in | 367 | passed to *fbsetroot(1)* to set the background. The special option `unset' is |
365 | user overlay files only. It specifies that fbsetbg should never be run (by | 368 | for use in user overlay files only. It specifies that fbsetbg should never be |
366 | default, even when `none' is set in the overlay, fluxbox will try to run | 369 | run (by default, even when `none' is set in the overlay, fluxbox will try to run |
367 | ``fbsetbg -z'' to restore the last wallpaper). | 370 | ``fbsetbg -z'' to restore the last wallpaper). |
368 | 371 | ||
369 | background: centered|aspect|tiled|fullscreen|random|solid|gradient <texture>|mod|none|unset | 372 | background: centered|aspect|tiled|fullscreen|random|solid|gradient <texture>|mod|none|unset |
@@ -489,9 +492,10 @@ You can find a lot of styles here: http://tenr.de/ | |||
489 | This manpage was composed from various resources including the official | 492 | This manpage was composed from various resources including the official |
490 | documentation, fluxbox(1) man page and numerous other resources by Curt | 493 | documentation, fluxbox(1) man page and numerous other resources by Curt |
491 | "Asenchi" Micol. If you notice any errors or problems with this page, please | 494 | "Asenchi" Micol. If you notice any errors or problems with this page, please |
492 | contact him here: <asenchi at asenchi.com> and using the great contributions of | 495 | contact him at: <asenchi at asenchi.com> and using the great contributions of |
493 | <grubert at users.sourceforge.net>. Numerous other languages could be available | 496 | <grubert at users.sourceforge.net>. Minor edits to fix grammar were made by |
494 | if someone jumps in. | 497 | Paul Tagliamonte <paultag at fluxbox.org>. Numerous other languages could be |
498 | available if someone jumps in. | ||
495 | 499 | ||
496 | SEE ALSO | 500 | SEE ALSO |
497 | -------- | 501 | -------- |