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