aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/fluxbox.1.in322
1 files changed, 10 insertions, 312 deletions
diff --git a/doc/fluxbox.1.in b/doc/fluxbox.1.in
index 560fef1..94bd2e4 100644
--- a/doc/fluxbox.1.in
+++ b/doc/fluxbox.1.in
@@ -159,6 +159,10 @@ Clicking the workspace name brings up the toolbar menu.
159Using the wheel on workspace name or the clock switches the workspace, this 159Using the wheel on workspace name or the clock switches the workspace, this
160could also be enabled for the whole desktop in the fluxbox menu. 160could also be enabled for the whole desktop in the fluxbox menu.
161.PP 161.PP
162When
163.B desktop warping
164is enabled, dragging a window outside the desktop will change to the next desktop.
165.PP
162Using the toolbar menu you can enter a name for the current workspace (when finished, 166Using the toolbar menu you can enter a name for the current workspace (when finished,
163press Enter). 167press Enter).
164One can choose the toolbar's position, in which layer it should be see LAYERs below 168One can choose the toolbar's position, in which layer it should be see LAYERs below
@@ -464,314 +468,7 @@ resources to specify colors, textures, pixmaps and fonts, and thus
464the overall look of your window borders, menus and the toolbar. 468the overall look of your window borders, menus and the toolbar.
465.PP 469.PP
466The default installation of Fluxbox provides some of these style files. 470The default installation of Fluxbox provides some of these style files.
467Usually they are put in 471See fluxstyle(1) to accomodate the growing number of style components.
468.IR @pkgdatadir@/styles .
469You can study or edit these files to grasp how the Fluxbox style mechanism
470works.
471You can use the
472.BR [style] ", " [stylesdir] " and " [stylesmenu]
473menu commands in your menu file to be able to select and change between styles
474on the fly.
475.PP
476But you can also create a directory named
477.I ~/.fluxbox/styles
478in your homedirectory and put your own style files here.
479Of course you may choose any name for this directory, but many downloadable
480themes will rely on the name
481.I styles
482(following the bb.themes.org naming scheme).
483.PP
484To understand how the style mechanism works, you should have a little knowledge
485of how X resources work.
486.PP
487X resources consist of a key and a value.
488The key is constructed of several smaller keys (sometimes referred to as
489children), delimited by a period (`.').
490Keys may also contain a star (`*') to serve as a wildcard, which means that one
491line of typed text will match several keys.
492This is useful for styles that are based on one or two colors.
493.PP
494Fluxbox allows you to configure it's three main components: the toolbar, the
495menus and the window decorations.
496.PP
497The little window that shows the x-y position while dragging windows, borrows
498it's style from the window's titlebar.
499.PP
500Here are some quick examples:
501.EX
502toolbar.clock.color: green
503.EE
504This sets the color resource of the toolbar clock to `green.' Another example:
505.EX
506menu*color: rgb:3/4/5
507.EE
508This sets the color resource of the menu
509.I and all of its `children'
510to `rgb:3/4/5'.
511(For a description of color names, see
512.IR X (1).)
513So this one also applies to
514.IR menu.title.color " and " menu.frame.color .
515And with
516.EX
517*font: -b&h-lucida-medium-r-normal-*-*-140-*
518.EE
519you set the font resource for all keys to this font name all at once.
520(For information about the fonts installed on your system, you can use a program like
521.IR xfontsel "(1), " gtkfontsel ", or " xlsfonts "(1).)"
522.PP
523Now, what makes Fluxbox just so spectacular, is its ability to render textures
524on the fly.
525Texture descriptions are specified directly to the key that they
526should apply to, e.g.:
527.ta \w'toolbar.clock.colorTo:\ 'u
528.EX
529toolbar.clock: Raised Gradient Diagonal Bevel1
530toolbar.clock.color: rgb:8/6/4
531toolbar.clock.colorTo: rgb:4/3/2
532.EE
533Don't worry, we will explain right now!
534A texture description consists of up to five fields, which are as follows:
535.TP
536.B Flat / Raised / Sunken
537gives the component either a flat, raised or sunken appearance.
538.TP
539.B Gradient / Solid
540tells Fluxbox to draw either a solid color or a gradient texture.
541.TP
542.B Horizontal / Vertical / Diagonal / Crossdiagonal / Pipecross / Elliptic / Rectangle / Pyramid
543Select one of these texture types. They only work when also
544.B Gradient
545is specified!
546.TP
547.B Interlaced
548tells Fluxbox to interlace the texture (darken every other line).
549This option is most commonly used with gradiented textures, but from Fluxbox
550version 0.60.3 on, it also works in solid textures.
551.TP
552.B Bevel1 / Bevel2
553tells Fluxbox which type of bevel to use.
554Bevel1 is the default bevel.
555The shading is placed on the edge of the image.
556Bevel2 is an alternative.
557The shading is placed one pixel in from the edge of the image.
558.PP
559Instead of a texture description, also the option
560.B ParentRelative
561is available, which makes the component appear as a part of its parent, e.g.
562totally transparent.
563.PP
564Or for even more possibilities
565.B Pixmap .
566If pixmap texture is specified (it might not be necessary on every occasion)
567the pixmap file is specified in a separate pixmap resource.
568.EX
569toolbar.clock: pixmap
570toolbar.clock.pixmap: .fluxbox/styles/mine/clock_background.xpm
571.EE
572This feature might need some investigations, reports say that sometimes
573the resources color and colorTo must be set and then they may not be set.
574.PP
575All gradiented textures are composed of two color values: the
576.IR color " and " colorTo " resources."
577When
578.B Interlaced
579is used in
580.B Solid
581mode, the
582.I colorTo
583resource is used to find the interlacing color.
584.PP
585Well, here is the complete component list, also all components together with
586which kind of value they can contain.
587Comments are preceded with an exclamation sign (!), which is also used for
588comments in Fluxbox style c.q. X resource files.
589.PP
590.ta \w'window.button.unfocus.picColor:\ 'u
591.nf
592.\"
593.\" The comments also to be translated!
594.\"
595! The toolbar itself
596toolbar: Texture
597toolbar.color: Color
598toolbar.colorTo: Color
599
600! The buttons on the toolbar
601toolbar.button: Texture or \fIParentRelative\fR
602toolbar.button.color: Color
603toolbar.button.colorTo: Color
604
605! Color of the button arrows
606toolbar.button.picColor: Color
607
608! Buttons in pressed state
609toolbar.button.pressed: Texture \fI(e.g. Sunken)\fR or \fIParentRelative\fR
610toolbar.button.pressed.color: Color
611toolbar.button.pressed.colorTo: Color
612
613! Color of pressed button arrows
614toolbar.button.pressed.picColor: Color
615
616! The toolbar workspace label
617toolbar.label: Texture or \fIParentRelative\fR
618toolbar.label.color: Color
619toolbar.label.colorTo: Color
620toolbar.label.textColor: Color
621
622! The toolbar window label
623toolbar.windowLabel: Texture or \fIParentRelative\fR
624toolbar.windowLabel.color: Color
625toolbar.windowLabel.colorTo: Color
626toolbar.windowLabel.textColor: Color
627
628! The toolbar clock
629toolbar.clock: Texture or \fIParentRelative\fR
630toolbar.clock.color: Color
631toolbar.clock.colorTo: Color
632toolbar.clock.textColor: Color
633
634! How the toolbar's text should be justified.
635toolbar.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
636
637! Font to be used for all toolbar components
638toolbar.font: Font \fI(e.g. -*-helvetica-medium-r-normal-*-*-100-*)\fR
639
640! The menu titlebar
641menu.title: Texture
642menu.title.color: Color
643menu.title.colorTo: Color
644menu.title.textColor: Color
645menu.title.font: Font
646menu.title.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
647
648! The menu frame
649menu.frame: Texture
650menu.frame.color: Color
651menu.frame.colorTo: Color
652menu.frame.textColor: Color
653menu.frame.disableColor: Color
654menu.frame.font: Font
655! Font can have a shadow. e.g. menu.frame.font: Verdana-8:shadow
656menu.frame.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
657
658! Bullets for submenu items
659menu.bullet: \fIempty\fR, \fItriangle\fR, \fIsquare\fR, or \fIdiamond\fR
660menu.bullet.position: \fIright\fR or \fIleft\fR
661
662! The highlighted menu item
663menu.hilite: Texture (e.g. \fIRaised\fR)
664menu.hilite.color: Color
665menu.hilite.colorTo: Color
666menu.hilite.textColor: Color
667
668! A focused window
669window.title.focus: Texture
670window.title.focus.color: Color
671window.title.focus.colorTo: Color
672
673! An unfocused window
674window.title.unfocus: Texture
675window.title.unfocus.color: Color
676window.title.unfocus.colorTo: Color
677
678! Window label in window.title
679window.label.focus: Texture or \fIParentRelative\fR
680window.label.focus.color: Color
681window.label.focus.colorTo: Color
682window.label.focus.textColor: Color
683
684window.label.unfocus: Texture or \fIParentRelative\fR
685window.label.unfocus.color: Color
686window.label.unfocus.colorTo: Color
687window.label.unfocus.textColor: Color
688
689! window label for active tab if window is not focussed
690window.label.active: Texture
691window.label.active.textColor: Color
692
693! Handlebar
694window.handle.focus: Texture
695window.handle.focus.color: Color
696window.handle.focus.colorTo: Color
697
698window.handle.unfocus: Texture
699window.handle.unfocus.color: Color
700window.handle.unfocus.colorTo: Color
701
702! Resize grips
703window.grip.focus: Texture
704window.grip.focus.color: Color
705window.grip.focus.colorTo: Color
706
707window.grip.unfocus: Texture
708window.grip.unfocus.color: Color
709window.grip.unfocus.colorTo: Color
710
711! Window buttons
712window.button.focus: Texture or \fIParentRelative\fR
713window.button.focus.color: Color
714window.button.focus.colorTo: Color
715window.button.focus.picColor: Color
716
717window.button.unfocus: Texture or \fIParentRelative\fR
718window.button.unfocus.color: Color
719window.button.unfocus.colorTo: Color
720window.button.unfocus.picColor: Color
721
722window.button.pressed: Texture (e.g. \fISunken\fR)
723window.button.pressed.color: Color
724window.button.pressed.colorTo: Color
725
726! Frame around window
727window.frame.focusColor: Color
728window.frame.unfocusColor: Color
729
730! Font and justification for window labels
731window.font: Font
732window.justify: \fIcenter\fR, \fIleft\fR, or \fIright\fR
733
734! Slit resources
735slit:
736slit.color: Color
737slit.colorTo: Color
738
739! Miscellaneous resources
740
741! A border can be drawn round all components
742borderWidth: a number of pixels, e.g. \fI1\fR
743borderColor: Color
744
745bevelWidth: a number of pixels > 0
746handleWidth: a number of pixels > 0
747
748! Width of the window frame
749! When not specified, frameWidth defaults to the value of bevelWidth
750frameWidth: a number of pixels >= 0
751
752
753! This command is executed whenever this style is selected.
754! Typically it sets the root window to a nice picture.
755rootCommand: Shell command, e.g. \fIbsetroot -mod 4 4 -fg rgb: 5/6/6 -bg grey20\fR
756
757! Some of the bbtools read these old 0.51 resources
758menuFont: Font
759titleFont: Font
760.fi
761.PP
762Now, this seems a long list, but remember, when you create your own style, you
763can easily set lots of keys with a single command, e.g.
764.EX
765.ta \w'*unfocus.textColor:\ 'u
766*color: slategrey
767*colorTo: darkslategrey
768*unfocus.color: darkslategrey
769*unfocus.colorTo: black
770*textColor: white
771*unfocus.textColor: lightgrey
772*font: lucidasans-10
773.EE
774This sets already nice defaults for many components.
775.\" --- keys --- 472.\" --- keys ---
776.SH KEYS FILE 473.SH KEYS FILE
777You can customise Fluxbox' key handling through the 474You can customise Fluxbox' key handling through the
@@ -1266,11 +963,12 @@ from the original Blackbox man page by Wilbert Berendsen
1266and subsequently hacked upon by Tobias Klausmann 963and subsequently hacked upon by Tobias Klausmann
1267.nh 964.nh
1268<klausman@users.sourceforge.net> 965<klausman@users.sourceforge.net>
1269.nh 966,
1270and 967<grubert@users.sourceforge.net>
968,
969<asenchi@asenchi.com>
1271.hy 970.hy
1272<grubert@users.sourceforge.net>. 971.PP
1273.nh
1274Numerous other languages could be available if someone jumps in. 972Numerous other languages could be available if someone jumps in.
1275.SH SEE ALSO 973.SH SEE ALSO
1276.IR bsetroot (1) 974.IR bsetroot (1)