aboutsummaryrefslogtreecommitdiff
path: root/doc/asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/asciidoc')
-rw-r--r--doc/asciidoc/fluxstyle.txt297
1 files changed, 297 insertions, 0 deletions
diff --git a/doc/asciidoc/fluxstyle.txt b/doc/asciidoc/fluxstyle.txt
index 596c148..632edd5 100644
--- a/doc/asciidoc/fluxstyle.txt
+++ b/doc/asciidoc/fluxstyle.txt
@@ -189,3 +189,300 @@ We should comment about fonts before we move on to the complete component
189list. fluxbox supports different options for text. These options currently 189list. fluxbox supports different options for text. These options currently
190include bold, halo and shadow. To set these do this: fontname-size:options for 190include bold, halo and shadow. To set these do this: fontname-size:options for
191any of the font components in the style file. For example: 191any of the font components in the style file. For example:
192
193 menu.title.font: sans-8:bold,shadow
194
195The latest versions of Fluxbox (> 0.9.8) also support different values for
196these text options. The possibilities are as follows:
197
198 --------
199 Shadow color=<colorname> offsetx=<integer> offsety=<integer> Halo color=<colorā\u20acname>
200 --------
201
202For the case of completeness, here are some real world examples:
203
204 *.font: Verdana-10:bold,shadow:offsetx=2;offsety=4;color=green
205 *.font: Verdana-10:halo:color=blue
206
207Of course this could all be placed on one line. Also note that for the offset
208options, negative integers are allowed.
209
210FONT PROBLEMS
211~~~~~~~~~~~~~
212If you have problems installing fonts or getting them to work, you should read
213the docs page at xfree.org. Here is a link to one of these:
214http://xfree.org/4.3.0/fonts2.html#3.
215
216FULL COMPONENT LIST
217-------------------
218Here is the exhaustive component list for Fluxbox styles. Each one is listed
219with their type of value required. Comments in a style file are preceded
220with an exclamation point (!) which we also use here so that these can be pasted
221into a new theme.cfg to be customized appropiately. Please note that in order
222to keep styles consistent it is often the practice of stylists to provide
223all of the theme-items in their style file even if they are not used. This allows
224the user the ease of changing different components.
225
226WINDOW OPTIONS
227--------------
228Many, many things you can do with window design in Fluxbox, below are your options.
229Have fun.
230
231 -----------------------------------------
232 window.bevelWidth: <integer>
233 window.borderColor: <color>
234 window.borderWidth: <integer>
235 window.button.focus: <texture type>
236 window.button.focus.color: <color>
237 window.button.focus.colorTo: <color>
238 window.button.focus.picColor: <color>
239 window.button.focus.pixmap: <filename>
240 window.button.pressed: <texture type>
241 window.button.pressed.color: <color>
242 window.button.pressed.colorTo: <color>
243 window.button.pressed.pixmap: <filename>
244 window.button.unfocus: <texture type>
245 window.button.unfocus.color: <color>
246 window.button.unfocus.colorTo: <color>
247 window.button.unfocus.picColor: <color>
248 window.button.unfocus.pixmap: <filename>
249 window.close.pixmap: <filename>
250 window.close.pressed.pixmap: <filename>
251 window.close.unfocus.pixmap: <filename>
252 window.font: <font>
253 window.frame.focusColor: <color>
254 window.frame.unfocusColor: <color>
255 window.grip.focus: <texture type>
256 window.grip.focus.color: <color>
257 window.grip.focus.colorTo: <color>
258 window.grip.focus.pixmap: <filename>
259 window.grip.unfocus: <texture type>
260 window.grip.unfocus.color: <color>
261 window.grip.unfocus.colorTo: <color>
262 window.grip.unfocus.pixmap: <filename>
263 window.handle.focus: <texture type>
264 window.handle.focus.color: <color>
265 window.handle.focus.colorTo: <color>
266 window.handle.focus.pixmap: <filename>
267 window.handle.unfocus: <texture type>
268 window.handle.unfocus.color: <color>
269 window.handle.unfocus.colorTo: <color>
270 window.handle.unfocus.pixmap: <filename>
271 window.handleWidth: <integer>
272 window.iconify.pixmap: <filename>
273 window.iconify.pressed.pixmap: <filename>
274 window.iconify.unfocus.pixmap: <filename>
275 window.justify: <{Left|Right|Center}>
276 window.label.active: <texture type>
277 window.label.active.textColor: <color>
278 window.label.focus: <texture type>
279 window.label.focus.color: <color>
280 window.label.focus.colorTo: <color>
281 window.label.focus.pixmap: <filename>
282 window.label.unfocus: <texture type>
283 window.label.unfocus.color: <color>
284 window.label.unfocus.colorTo: <color>
285 window.label.unfocus.pixmap: <filename>
286 window.label.focus.textColor: <color>
287 window.label.unfocus.textColor: <color>
288 window.maximize.pixmap: <filename>
289 window.maximize.pressed.pixmap: <filename>
290 window.maximize.unfocus.pixmap: <filename>
291 window.roundCorners: <{Top|Bottom}{Left|Right}>
292 window.shade.pixmap: <filename>
293 window.shade.pressed.pixmap: <filename>
294 window.shade.unfocus.pixmap: <filename>
295 window.stick.pixmap: <filename>
296 window.stick.pressed.pixmap: <filename>
297 window.stick.unfocus.pixmap: <filename>
298 window.stuck.pixmap: <filename>
299 window.stuck.unfocus.pixmap: <filename>
300 window.title.focus: <texture type>
301 window.title.focus.color: <color>
302 window.title.focus.colorTo: <color>
303 window.title.focus.pixmap: <filename>
304 window.title.height: <integer>
305 window.title.unfocus: <texture type>
306 window.title.unfocus.color: <color>
307 window.title.unfocus.colorTo: <color>
308 window.title.unfocus.pixmap: <filename>
309 -----------------------------------------
310
311MENU OPTIONS
312------------
313Everything you need to make your menu look pretty.
314
315 -----------------------------------------
316 menu.bevelWidth: <integer>
317 menu.borderColor: <color>
318 menu.borderWidth: <integer>
319 menu.bullet: <{empty|square|triangle|diamond}>
320 menu.bullet.position: <{left|right}>
321 menu.frame: <texture type>
322 menu.frame.color: <color>
323 menu.frame.colorTo: <color>
324 menu.frame.disableColor: <color>
325 menu.frame.font: <font>
326 menu.frame.justify: <{Left|Right|Center}>
327 menu.frame.pixmap: <filename>
328 menu.frame.textColor: <color>
329 menu.hilite: <texture type>
330 menu.hilite.color: <color>
331 menu.hilite.colorTo: <color>
332 menu.hilite.pixmap: <filename>
333 menu.hilite.textColor: <color>
334 menu.itemHeight: <integer>
335 menu.title: <texture type>
336 menu.title.color: <color>
337 menu.title.colorTo: <color>
338 menu.title.font: <font>
339 menu.title.pixmap: <filename>
340 menu.title.textColor: <color>
341 menu.title.justify: <{Left|Right|Center}>
342 menu.titleHeight: <integer>
343 menu.roundCorners: <{Top|Bottom}{Left|Right}>
344 menu.selected.pixmap: <filename>
345 menu.submenu.pixmap: <filename>
346 menu.unselected.pixmap: <filename>
347 -----------------------------------------
348
349ROOT COMMAND
350------------
351Rarely are you going to want to use this option. There is a command that is similar
352that is used in the init file. It is bad style to use this in your style as it
353forces the user to use your background. So note that it is good practice to leave
354this blank or out of the style altogether.
355
356 rootCommand: <string>
357
358SLIT
359----
360Here are all of the options for the slit.
361
362 -----------------------------------------
363 slit: <texture type>
364 slit.bevelWidth: <integer>
365 slit.borderColor: <color>
366 slit.borderWidth: <integer>
367 slit.color: <color>
368 slit.colorTo: <color>
369 slit.pixmap: <filename>
370 -----------------------------------------
371
372TOOLBAR OPTIONS
373---------------
374Below you will find all of the configuration possibilities for the toolbar.
375The list is pretty extensive and offers you many options to make your toolbar
376look just the way you want it.
377
378 -----------------------------------------
379 toolbar: <texture type>
380 toolbar.bevelWidth: <integer (0-255)>
381 toolbar.borderColor: <color>
382 toolbar.borderWidth: <integer>
383 toolbar.button.scale: <integer>
384 toolbar.color: <color>
385 toolbar.colorTo: <color>
386 toolbar.clock: <texture type>
387 toolbar.clock.borderColor: <color>
388 toolbar.clock.borderWidth: <integer>
389 toolbar.clock.font: <font>
390 toolbar.clock.justify: <{Left|Right|Center}>
391 toolbar.clock.pixmap: <filename>
392 toolbar.clock.color: <color>
393 toolbar.clock.colorTo: <color>
394 toolbar.clock.textColor: <color>
395 toolbar.height: <integer>
396 toolbar.iconbar.focused: <texture type>
397 toolbar.iconbar.focused.color: <color>
398 toolbar.iconbar.focused.colorTo:<color>
399 toolbar.iconbar.focused.pixmap: <filename>
400 toolbar.iconbar.unfocused: <texture type>
401 toolbar.iconbar.unfocused.color: <color>
402 toolbar.iconbar.unfocused.colorTo: <color>
403 toolbar.iconbar.unfocused.pixmap: <filename>
404 toolbar.iconbar.empty: <texture type>
405 toolbar.iconbar.empty.color: <color>
406 toolbar.iconbar.empty.colorTo: <color>
407 toolbar.iconbar.empty.pixmap: <filename>
408 toolbar.iconbar.focused.borderColor: <color>
409 toolbar.iconbar.focused.borderWidth: <integer>
410 toolbar.iconbar.unfocused.borderColor: <color>
411 toolbar.iconbar.unfocused.borderWidth: <integer>
412 toolbar.iconbar.borderColor: <color>
413 toolbar.iconbar.borderWidth: <integer>
414 toolbar.iconbar.focused.font: <font>
415 toolbar.iconbar.focused.justify: <{Left|Right|Center}>
416 toolbar.iconbar.focused.textColor: <color>
417 toolbar.iconbar.unfocused.font: <font>
418 toolbar.iconbar.unfocused.justify: <{Left|Right|Center}>
419 toolbar.iconbar.unfocused.textColor: <color>
420 toolbar.pixmap: <filename>
421 toolbar.shaped: <boolean>
422 toolbar.workspace.font: <font>
423 toolbar.workspace.justify: <{Left|Right|Center}>
424 toolbar.workspace.textColor: <color>
425 toolbar.workspace: <texture type>
426 toolbar.workspace.borderColor: <color>
427 toolbar.workspace.borderWidth: <integer>
428 toolbar.workspace.color: <color>
429 toolbar.workspace.colorTo: <color>
430 toolbar.workspace.pixmap: <filename>
431 -----------------------------------------
432
433EXAMPLES
434--------
435This list may seem intimidating, but remember, when you create your own style you
436can easily set a majority of these keys with a single component. For an example
437of this:
438
439 -----------------------------------------
440 *color: slategrey
441 *colorTo: darkslategrey
442 *unfocus.color: darkslategrey
443 *unfocus.colorTo: black
444 *textColor: white
445 *unfocus.textColor: lightgrey
446 *font: lucidasans-10
447 -----------------------------------------
448
449This sets nice defaults for many components.
450
451COLOR FORMATS
452-------------
453These are the color formats for styles:
454
455 #000000 (Hexadecimal)
456 rgb:<0-255>/<0-255>/<0-255>
457
458 See /usr/X11R6/lib/X11/rgb.txt for an explaination.
459
460AUTHOR and CREDITS
461------------------
462Blackbox was written and maintained by Brad Hughes <blackbox@alug.org>
463and Jeff Raven <jraven@psu.edu>,
464
465Fluxbox is written and maintained by Henrik Kinnunen <fluxgen@linuxmail.org>
466with contributions and patches merged from many individuals around the world.
467
468The Official Fluxbox website: http://www.fluxbox.org/
469
470Fluxmod was a Fluxbox community site where you could find many new styles
471that work with this version of Fluxbox and take advantage of all the new features.
472However, fluxmod is no more, but itā\u20ac\u2122s maintainer still dabbles in style creation.
473You can find his site here: http://www.ikaro.dk
474
475You can also find more styles here: http://themes.freshmeat.net/
476
477This manpage was composed from various resources including the official documentation,
478fluxbox(1) man page and numerous other resources by Curt "Asenchi" Micol. If you
479notice any errors or problems with this page, please contact him here:
480<asenchi@asenchi.com> and using the great contributions of
481<grubert@users.sourceā\u20acforge.net>. Numerous other languages could be available if
482someone jumps in.
483
484SEE ALSO
485--------
486fluxbox(1) fbsetbg(1) fbsetroot(1)
487
488fluxstyle(1)