aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/fluxstyle.1 (renamed from doc/fluxboxstyle.1)396
1 files changed, 219 insertions, 177 deletions
diff --git a/doc/fluxboxstyle.1 b/doc/fluxstyle.1
index 11a4548..c2ba84a 100644
--- a/doc/fluxboxstyle.1
+++ b/doc/fluxstyle.1
@@ -1,14 +1,14 @@
1.\" 1.\" AT THE BOTTOM IS ADD ONS TO THE PAGE search /ADDITIONS
2.\" Manual page for Fluxbox Styles 2.\" Manual page for Fluxbox Styles
3.\" 3.\"
4.\" Fluxbox is Copyright (c) 2001-2004 Henrik Kinnunen 4.\" Fluxbox is Copyright (c) 2001-2004 Henrik Kinnunen
5.\" Fluxstyle(1) is Copyright (c) 2004 Curtis Micol 5.\" Fluxstyle(1) is Copyright (c) 2004 Curt Micol
6.\" 6.\"
7.\" This manual page is freely distrubted and modified. 7.\" This manual page is freely distrubted and modified.
8.\" Parts of the text are taken from websites and style 8.\" Parts of the text are taken from websites and style
9.\" files on http://www.fluxbox.org and http://www.fluxmod.dk 9.\" files on http://www.fluxbox.org and http://www.fluxmod.dk
10.\" 10.\"
11.\" Created and Updated for version 0.9.7 by Curtis Micol <asenchi@asenchi.com> 11.\" Created and Updated for version 0.9.7 by Curt Micol <asenchi@asenchi.com>
12.\" 12.\"
13.\" Define this: <blockquote><pre> 13.\" Define this: <blockquote><pre>
14.de EX 14.de EX
@@ -26,7 +26,7 @@
26.. 26..
27.\" Begin actual page 27.\" Begin actual page
28.\" 28.\"
29.TH fluxstyle 1 "January 7th, 2004" "0.9.7" 29.TH fluxstyle 1 "January 7th, 2004" "0.9.8"
30.SH NAME 30.SH NAME
31fluxstyle \- all you need to know about Fluxbox styles 31fluxstyle \- all you need to know about Fluxbox styles
32.SH DESCRIPTION 32.SH DESCRIPTION
@@ -91,12 +91,17 @@ providing a default configureation at installation.
91.PP 91.PP
92Once you create your own, you can create a directory in 92Once you create your own, you can create a directory in
93.IR ~/.fluxbox/ 93.IR ~/.fluxbox/
94called 'styles'. Place your styles here and you will be able to access them from the configure 94called '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:
95portion of the Root Menu called 'User Styles'. This goes true for any directories associated 95.EX
96with your style. An example being, if you create a style with pixmaps, create 96mkdir -p ~/.fluxbox/styles/MyStyle
97.IR ~/.fluxbox/pixmaps 97cd ~/.fluxbox/styles/MyStyle
98and place your pixmaps here. Of course, this means that the path to your pixmaps in your style 98mkdir pixmaps
99file will be the same. 99vi theme.cfg (this being where you design your style with
100 the necessary components)
101.EE
102If you follow this, the path to your pixmaps will be:
103.IR ~/fluxbox/styles/MyStyle/pixmaps
104which makes it a bit easier to setup up and distribute your style.
100 105
101.SH CREATING STYLES 106.SH CREATING STYLES
102As discussed in the 107As discussed in the
@@ -207,176 +212,206 @@ mode, the
207.I colorTo 212.I colorTo
208resource is used to find the interlacing color. 213resource is used to find the interlacing color.
209.PP 214.PP
210Here is the complete component list, also all components together with 215.SH A WORD ABOUT FONTS
211which kind of value they can contain. 216We should comment about fonts before we move on to the complete component
217list.
218.PP
219Fluxbox 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:
220.EX
221menu.title.font: sans-8:bold,shadow
222.EE
223If 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.
224.SH FULL COMPONENT LIST
225Here is the complete component list, together with which kind of value they take.
212Comments are preceded with an exclamation sign (!), which is also used for 226Comments are preceded with an exclamation sign (!), which is also used for
213comments in Fluxbox style c.q. X resource files. 227comments in Fluxbox style c.q. X resource files.
214.PP 228.PP
215.ta \w'window.button.unfocus.picColor:\ 'u
216.nf
217.\"
218.\" The comments also to be translated! 229.\" The comments also to be translated!
219.\" 230.SS WINDOW OPTIONS
220! The toolbar itself 231Many, many things you can do with window design in Fluxbox, below are your options. Have fun.
221toolbar: Texture 232.EX
222toolbar.color: Color 233window.label.focus: <texture type>
223toolbar.colorTo: Color 234window.label.focus.pixmap: <filename>
224 235window.label.focus.color: <color>
225! The buttons on the toolbar 236window.label.focus.colorTo: <color>
226toolbar.button: Texture or \fIParentRelative\fR 237window.label.unfocus: <texture type>
227toolbar.button.color: Color 238window.label.unfocus.pixmap: <filename>
228toolbar.button.colorTo: Color 239window.label.unfocus.color: <color>
229 240window.label.unfocus.colorTo: <color>
230! Color of the button arrows 241window.title.focus: <texture type>
231toolbar.button.picColor: Color 242window.title.focus.pixmap: <filename>
232 243window.title.focus.color: <color>
233! Buttons in pressed state 244window.title.focus.colorTo: <color>
234toolbar.button.pressed: Texture \fI(e.g. Sunken)\fR or \fIParentRelative\fR 245window.title.unfocus: <texture type>
235toolbar.button.pressed.color: Color 246window.title.unfocus.pixmap: <filename>
236toolbar.button.pressed.colorTo: Color 247window.title.unfocus.color: <color>
237 248window.title.unfocus.colorTo: <color>
238! Color of pressed button arrows 249window.handle.focus: <texture type>
239toolbar.button.pressed.picColor: Color 250window.handle.focus.pixmap: <filename>
240 251window.handle.focus.color: <color>
241! The toolbar workspace label 252window.handle.focus.colorTo: <color>
242toolbar.label: Texture or \fIParentRelative\fR 253window.handle.unfocus: <texture type>
243toolbar.label.color: Color 254window.handle.unfocus.pixmap: <filename>
244toolbar.label.colorTo: Color 255window.handle.unfocus.color: <color>
245toolbar.label.textColor: Color 256window.handle.unfocus.colorTo: <color>
246 257window.button.focus: <texture type>
247! The toolbar window label 258window.button.focus.pixmap: <filename>
248toolbar.windowLabel: Texture or \fIParentRelative\fR 259window.button.focus.color: <color>
249toolbar.windowLabel.color: Color 260window.button.focus.colorTo: <color>
250toolbar.windowLabel.colorTo: Color 261window.button.unfocus: <texture type>
251toolbar.windowLabel.textColor: Color 262window.button.unfocus.pixmap: <filename>
252 263window.button.unfocus.color: <color>
253! The toolbar clock 264window.button.unfocus.colorTo: <color>
254toolbar.clock: Texture or \fIParentRelative\fR 265window.button.pressed: <texture type>
255toolbar.clock.color: Color 266window.button.pressed.pixmap: <filename>
256toolbar.clock.colorTo: Color 267window.button.pressed.color: <color>
257toolbar.clock.textColor: Color 268window.button.pressed.colorTo: <color>
258 269window.grip.focus: <texture type>
259! How the toolbar's text should be justified. 270window.grip.focus.pixmap: <filename>
260toolbar.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR 271window.grip.focus.color: <color>
261 272window.grip.focus.colorTo: <color>
262! Font to be used for all toolbar components 273window.grip.unfocus: <texture type>
263toolbar.font: Font \fI(e.g. -*-helvetica-medium-r-normal-*-*-100-*)\fR 274window.grip.unfocus.pixmap: <filename>
264 275window.grip.unfocus.color: <color>
265! The menu titlebar 276window.grip.unfocus.colorTo: <color>
266menu.title: Texture 277window.label.focus.textColor: <color>
267menu.title.color: Color 278window.label.unfocus.textColor: <color>
268menu.title.colorTo: Color 279window.frame.focusColor: <color>
269menu.title.textColor: Color 280window.frame.unfocusColor: <color>
270menu.title.font: Font 281window.button.focus.picColor: <color>
271menu.title.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR 282window.button.unfocus.picColor: <color>
272 283window.font: <font>
273! The menu frame 284window.justify:
274menu.frame: Texture 285window.roundCorners:
275menu.frame.color: Color 286window.alpha: <integer>
276menu.frame.colorTo: Color 287window.title.height: <integer>
277menu.frame.textColor: Color 288window.bevelWidth: <integer>
278menu.frame.disableColor: Color 289window.handleWidth: <integer>
279menu.frame.font: Font 290window.borderWidth: <integer>
280menu.frame.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR 291window.borderColor: <color>
281 292window.close.pixmap: <filename>
282! Bullets for submenu items 293window.close.unfocus.pixmap: <filename>
283menu.bullet: \fIempty\fR, \fItriangle\fR, \fIsquare\fR, or \fIdiamond\fR 294window.close.pressed.pixmap: <filename>
284menu.bullet.position: \fIright\fR or \fIleft\fR 295window.maximize.pixmap: <filename>
285 296window.maximize.unfocus.pixmap: <filename>
286! The highlighted menu item 297window.maximize.pressed.pixmap: <filename>
287menu.hilite: Texture (e.g. \fIRaised\fR) 298window.iconify.pixmap: <filename>
288menu.hilite.color: Color 299window.iconify.unfocus.pixmap: <filename>
289menu.hilite.colorTo: Color 300window.iconify.pressed.pixmap: <filename>
290menu.hilite.textColor: Color 301window.shade.pixmap: <filename>
291 302window.shade.unfocus.pixmap: <filename>
292! A focused window 303window.shade.pressed.pixmap: <filename>
293window.title.focus: Texture 304window.stick.pixmap: <filename>
294window.title.focus.color: Color 305window.stick.unfocus.pixmap: <filename>
295window.title.focus.colorTo: Color 306window.stick.pressed.pixmap: <filename>
296 307window.stuck.pixmap: <filename>
297! An unfocused window 308window.stuck.unfocus.pixmap: <filename>
298window.title.unfocus: Texture 309.EE
299window.title.unfocus.color: Color 310.SS MENU OPTIONS
300window.title.unfocus.colorTo: Color 311Everything you need to make your menu look pretty.
301 312.EX
302! Window label in window.title 313menu.title.textColor: <color>
303window.label.focus: Texture or \fIParentRelative\fR 314menu.frame.textColor: <color>
304window.label.focus.color: Color 315menu.hilite.textColor: <color>
305window.label.focus.colorTo: Color 316menu.frame.disableColor: <color>
306window.label.focus.textColor: Color 317menu.title: <texture type>
307 318menu.title.pixmap: <filename>
308window.label.unfocus: Texture or \fIParentRelative\fR 319menu.title.color: <color>
309window.label.unfocus.color: Color 320menu.title.colorTo: <color>
310window.label.unfocus.colorTo: Color 321menu.frame: <texture type>
311window.label.unfocus.textColor: Color 322menu.frame.pixmap: <filename>
312 323menu.frame.color: <color>
313! Handlebar 324menu.frame.colorTo: <color>
314window.handle.focus: Texture 325menu.hilite: <texture type>
315window.handle.focus.color: Color 326menu.hilite.pixmap: <filename>
316window.handle.focus.colorTo: Color 327menu.hilite.color: <color>
317 328menu.hilite.colorTo: <color>
318window.handle.unfocus: Texture 329menu.title.font: <font>
319window.handle.unfocus.color: Color 330menu.frame.font: <font>
320window.handle.unfocus.colorTo: Color 331menu.frame.justify:
321 332menu.title.justify:
322! Resize grips 333menu.bullet.position:
323window.grip.focus: Texture 334menu.bullet:
324window.grip.focus.color: Color 335menu.borderWidth:
325window.grip.focus.colorTo: Color 336menu.bevelWidth:
326 337menu.borderColor: <color>
327window.grip.unfocus: Texture 338menu.submenu.pixmap: <filename>
328window.grip.unfocus.color: Color 339menu.selected.pixmap: <filename>
329window.grip.unfocus.colorTo: Color 340menu.unselected.pixmap: <filename>
330 341menu.roundCorners:
331! Window buttons 342.EE
332window.button.focus: Texture or \fIParentRelative\fR 343.SS ROOT COMMAND OPTION
333window.button.focus.color: Color 344This 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
334window.button.focus.colorTo: Color 345.EX
335window.button.focus.picColor: Color 346rootCommand: <string>
336 347.EE
337window.button.unfocus: Texture or \fIParentRelative\fR 348.SS SLIT
338window.button.unfocus.color: Color 349Here are all of the options for the slit.
339window.button.unfocus.colorTo: Color 350.EX
340window.button.unfocus.picColor: Color 351slit: <texture type>
341 352slit.pixmap: <filename>
342window.button.pressed: Texture (e.g. \fISunken\fR) 353slit.color: <color>
343window.button.pressed.color: Color 354slit.colorTo: <color>
344window.button.pressed.colorTo: Color 355slit.borderWidth: <integer>
345 356slit.bevelWidth: <integer>
346! Frame around window 357slit.borderColor: <color>
347window.frame.focusColor: Color 358.EE
348window.frame.unfocusColor: Color 359.SS TOOLBAR OPTIONS
349 360Below 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.
350! Font and justification for window labels 361.EX
351window.font: Font 362toolbar: <texture type>
352window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR 363toolbar.pixmap: <filename>
353 364toolbar.color: <color>
354! Slit resources 365toolbar.colorTo: <color>
355slit: 366toolbar.borderWidth: <integer>
356slit.color: Color 367toolbar.borderColor: <color>
357slit.colorTo: Color 368toolbar.bevelWidth: <0-255>
358 369toolbar.shaped: <boolean>
359! Miscellaneous resources 370toolbar.alpha: <integer>
360 371toolbar.height: <integer>
361! A border can be drawn round all components 372toolbar.clock.font: <font>
362borderWidth: a number of pixels, e.g. \fI1\fR 373toolbar.clock.textColor: <color>
363borderColor: Color 374toolbar.clock.justify:
364 375toolbar.clock: <texture type>
365bevelWidth: a number of pixels > 0 376toolbar.clock.pixmap: <filename>
366handleWidth: a number of pixels > 0 377toolbar.clock.color: <color>
367 378toolbar.clock.colorTo: <color>
368! Width of the window frame 379toolbar.clock.borderWidth: <integer>
369! When not specified, frameWidth defaults to the value of bevelWidth 380toolbar.clock.borderColor: <color>
370frameWidth: a number of pixels >= 0 381toolbar.workspace.font: <font>
371 382toolbar.workspace.textColor: <color>
372! This command is executed whenever this style is selected. 383toolbar.workspace.justify:
373! Typically it sets the root window to a nice picture. 384toolbar.workspace: <texture type>
374rootCommand: Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb: 5/6/6 -bg grey20\fR 385toolbar.workspace.pixmap: <filename>
375 386toolbar.workspace.color: <color>
376! Some of the bbtools read these old 0.51 resources 387toolbar.workspace.colorTo: <color>
377menuFont: Font 388toolbar.workspace.borderWidth: <integer>
378titleFont: Font 389toolbar.workspace.borderColor: <color>
379.fi 390toolbar.iconbar.focused: <texture type>
391toolbar.iconbar.focused.pixmap: <filename>
392toolbar.iconbar.focused.color: <color>
393toolbar.iconbar.focused.colorTo: <color>
394toolbar.iconbar.unfocused: <texture type>
395toolbar.iconbar.unfocused.pixmap: <filename>
396toolbar.iconbar.unfocused.color: <color>
397toolbar.iconbar.unfocused.colorTo: <color>
398toolbar.iconbar.empty: <texture type>
399toolbar.iconbar.empty.pixmap: <filename>
400toolbar.iconbar.empty.color: <color>
401toolbar.iconbar.empty.colorTo: <color>
402toolbar.iconbar.focused.borderWidth: <integer>
403toolbar.iconbar.focused.borderColor: <color>
404toolbar.iconbar.unfocused.borderWidth: <integer>
405toolbar.iconbar.unfocused.borderColor: <color>
406toolbar.iconbar.borderWidth: <integer>
407toolbar.iconbar.borderColor: <color>
408toolbar.iconbar.focused.font: <font>
409toolbar.iconbar.focused.textColor: <color>
410toolbar.iconbar.focused.justify:
411toolbar.iconbar.unfocused.font: <font>
412toolbar.iconbar.unfocused.textColor: <color>
413toolbar.iconbar.unfocused.justify:
414.EE
380.SH EXAMPLES 415.SH EXAMPLES
381This may seem like a long list, but remember, when you create your own style, you 416This may seem like a long list, but remember, when you create your own style, you
382can easily set lots of keys with a single command, e.g. 417can easily set lots of keys with a single command, e.g.
@@ -433,7 +468,7 @@ You can also find more styles here:
433.B http://themes.freshmeat.net/ 468.B http://themes.freshmeat.net/
434.PP 469.PP
435This manpage was composed from various resources including the documentation, fluxbox 470This manpage was composed from various resources including the documentation, fluxbox
436man page and numerous other resources by Curtis Micol 471man page and numerous other resources by Curt Micol
437.nh 472.nh
438<asenchi@asenchi.com> 473<asenchi@asenchi.com>
439.hy 474.hy
@@ -445,3 +480,10 @@ Numerous other languages could be available if someone jumps in.
445.SH SEE ALSO 480.SH SEE ALSO
446.IR fluxbox (1) 481.IR fluxbox (1)
447.IR bsetroot (1) 482.IR bsetroot (1)
483
484.\" ADDITIONS TO MAKE
485.\" Create a font section
486.\" Change layout of theme items
487.\" Obtain new theme items, grubert just placed in new man page
488.\" Become a little more verbose on color usage.
489.\"