data/README.style

   1 -- data/README.style for Blackbox - an X11 Window manager
   2
   3 Texture
   4 ------------------------------------------------------------------------------
   5
   6 A texture is a description of a particular visual element.  It
   7 consists of a text description, colors and a border width.  Textures
   8 are specified as follows:
   9
  10 <name>.appearance:      description
  11 <name>.backgroundColor: background color for solids
  12 <name>.color1:          initial color for gradients and interlaced solids
  13 <name>.color2:          target color for gradients and interlaced solids
  14 <name>.borderWidth:     width of the texture border in pixels
  15 <name>.borderColor:     color of the texture border
  16
  17 The BNF for the appearance is:
  18
  19     <appearance>        := parentrelative |
  20                            [<bevel-type>] [<fill-type>] [interlaced] [border]
  21     <bevel-type>        := sunken | flat | raised
  22     <fill-type>         := gradient <gradient-type> | solid
  23     <gradient-type>     := crossdiagonal | rectangle | pyramid | pipecross |
  24                            elliptic | horizontal | vertical | diagonal
  25
  26
  27 Color
  28 ------------------------------------------------------------------------------
  29
  30 A color can be specified as one of the X11 color names (e.g.
  31 'cornsilk3'), as a device-dependent color specification, or as a
  32 device-independent color specification.
  33
  34 A device-dependent color specification has the following syntax
  35
  36     rgb:<red>/<green>/<blue> where <red>, <green>, <blue> := h | hh |
  37     hhh | hhhh, and h := single hexidecimal digits
  38
  39     rgbi:<red>/<green>/<blue> where <red>, <green>, and <blue> are
  40     floating-point values between 0.0 and 1.0, inclusive.
  41
  42 A device-independent color specification has the following syntax:
  43
  44     CIEXYZ:<X>/<Y>/<Z>
  45     CIEuvY:<u>/<v>/<Y>
  46     CIExyY:<x>/<y>/<Y>
  47     CIELab:<L>/<a>/<b>
  48     CIELuv:<L>/<u>/<v>
  49     TekHVC:<H>/<V>/<C> where all values are floating-point values in
  50     the range 0.0 to 1.0, inclusive.
  51
  52 See the XParseColor man page for more information on X11 color names.
  53
  54
  55 Font
  56 ------------------------------------------------------------------------------
  57
  58 A font is a description of the font.  Depending on how Blackbox was
  59 configure at build time, this can be a FontConfig font specification
  60 (see http://www.fontconfig.org for more information on FontConfig), or
  61 an XLFD font specification.
  62
  63 Note: If a FontConfig font specification is used, but Blackbox was not
  64 built with Xft support, a default XLFD font is used.  If an XLFD font
  65 specification is used, Blackbox will always use this XLFD, regardless
  66 of whether or not if Blackbox was build with Xft support.
  67
  68
  69 Alignment
  70 ------------------------------------------------------------------------------
  71
  72 Alignment is one of the following: Left, Center, Right
  73
  74
  75 Width/Height/Margin
  76 ------------------------------------------------------------------------------
  77
  78 All width, height and margin resources are specified in pixels.  In
  79 general, width and height specify the full extent, where as margin
  80 specifies the space around another element.
  81
  82
  83 Setting the Background
  84 ------------------------------------------------------------------------------
  85
  86 You can set the desktop background (i.e. root window) by specifying a
  87 command to run in the 'rootCommand' resource.  Blackbox includes the
  88 'bsetroot' and 'bsetbg' utilities; their use is recommended.  Also,
  89 you can override the styles 'rootCommand' by putting your own in your
  90 ~/.blackboxrc file.  This allows you to always use a custom
  91 background, regardless of which style you are using.
  92
  93 Note: Questions about security have been raised about 'rootCommand.'
  94 There is an inherent risk when using styles from 3rd parties; use them
  95 with caution.
  96
  97
  98 Menu Style
  99 ------------------------------------------------------------------------------
 100
 101 menu.title                      - title texture
 102 Menu.Title
 103         .backgroundColor
 104         .color1
 105         .color2
 106         .borderWidth
 107         .borderColor
 108
 109 menu.title.foregroundColor      - bitmap color for e.g. close button
 110 Menu.Title.ForegroundColor
 111
 112 menu.title.textColor            - title text color
 113 Menu.Title.TextColor
 114
 115 menu.title.font                 - title text font
 116 Menu.Title.Font
 117
 118 menu.title.alignment            - title text alignment
 119 Menu.Title.Alignment
 120
 121 menu.title.marginWidth          - space around text in title
 122 Menu.Title.MarginWidth
 123
 124 menu.frame                      - frame texture
 125 Menu.Frame
 126         .backgroundColor
 127         .color1
 128         .color2
 129         .borderWidth
 130         .borderColor
 131
 132 menu.frame.foregroundColor      - bitmap color for checks and submenu-arrows
 133 menu.frame.ForegroundColor
 134
 135 menu.frame.textColor
 136 Menu.Frame.TextColor
 137
 138 menu.frame.disabledColor        - disabled text color
 139 Menu.Frame.DisabledColor
 140
 141 menu.frame.font                 - item text font
 142 Menu.Frame.Font
 143
 144 menu.frame.alignment            - text alignment for all items
 145 Menu.Frame.Alignment
 146
 147 menu.frame.marginWidth          - space around all items in frame
 148 Menu.Frame.MarginWidth
 149
 150 menu.active                     - texture for the active menu item
 151 Menu.Active
 152         .backgroundColor
 153         .color1
 154         .color2
 155         .borderWidth
 156         .borderColor
 157
 158 menu.active.foregroundColor     - bitmap color for checks and submenu-arrows
 159 Menu.Active.ForegroundColor
 160
 161 menu.active.textColor           - menu item text color
 162 Menu.Active.TextColor
 163
 164
 165 Slit Style
 166 ------------------------------------------------------------------------------
 167 slit                            - the texture of the slit
 168 Slit
 169         .backgroundColor
 170         .color1
 171         .color2
 172         .borderWidth
 173         .borderColor
 174
 175 slit.marginWidth                - space around and between slit clients
 176 Slit.MarginWidth
 177
 178
 179 Toolbar Style
 180 ------------------------------------------------------------------------------
 181
 182 toolbar                         - the texture of the toolbar itself
 183 Toolbar
 184         .backgroundColor
 185         .color1
 186         .color2
 187         .borderWidth
 188         .borderColor
 189
 190 toolbar.label                   - workspace label texture
 191 Toolbar.Label
 192         .backgroundColor
 193         .color1
 194         .color2
 195         .borderWidth
 196         .borderColor
 197
 198 toolbar.windowLabel             - window label texture
 199 Toolbar.Label
 200         .backgroundColor
 201         .color1
 202         .color2
 203         .borderWidth
 204         .borderColor
 205
 206 toolbar.clock                   - clock label texture
 207 Toolbar.Label
 208         .backgroundColor
 209         .color1
 210         .color2
 211         .borderWidth
 212         .borderColor
 213
 214 toolbar.button                  - button texture
 215 Toolbar.Button
 216         .backgroundColor
 217         .color1
 218         .color2
 219         .borderWidth
 220         .borderColor
 221
 222 toolbar.button.pressed          - pressed button texture
 223 Toolbar.Button.Pressed
 224         .backgroundColor
 225         .color1
 226         .color2
 227         .borderWidth
 228         .borderColor
 229
 230 toolbar.label.textColor         - workspace label text color
 231 Toolbar.Label.TextColor
 232
 233 toolbar.windowLabel.textColor   - window label text color
 234 Toolbar.Label.TextColor
 235
 236 toolbar.clock.textClolor        - clock label text color
 237 Toolbar.Label.TextColor
 238
 239 toolbar.button.foregroundColor  - bitmap color for buttons
 240 Toolbar.Button.ForegroundColor
 241
 242 toolbar.alignment               - text alignment for all labels
 243 Toolbar.Alignment
 244
 245 toolbar.font                    - text font
 246 Toolbar.Font
 247
 248 toolbar.marginWidth             - space around and between buttons and labels
 249 Toolbar.MarginWidth
 250
 251 toolbar.label.marginWidth       - space around text in labels
 252 Toolbar.Label.MarginWidth
 253
 254 toolbar.button.marginWidth      - space around bitmaps in buttons
 255 Toolbar.Button.MarginWidth
 256
 257
 258 Window Style
 259 ------------------------------------------------------------------------------
 260
 261 window.title.focus              - focused title texture
 262 Window.Title.Focus
 263         .backgroundColor
 264         .color1
 265         .color2
 266         .borderWidth
 267         .borderColor
 268
 269 window.label.focus              - focused label texture
 270 Window.Label.focus
 271         .backgroundColor
 272         .color1
 273         .color2
 274         .borderWidth
 275         .borderColor
 276
 277 window.button.focus             - focused button texture
 278 Window.Button.Focus
 279         .backgroundColor
 280         .color1
 281         .color2
 282         .borderWidth
 283         .borderColor
 284
 285 window.handle.focus             - focus handle texture
 286 Window.Handle.Focus
 287         .backgroundColor
 288         .color1
 289         .color2
 290         .borderWidth
 291         .borderColor
 292
 293 window.grip.focus               - focus grip texture
 294 Window.Grip.Focus
 295         .backgroundColor
 296         .color1
 297         .color2
 298         .borderWidth
 299         .borderColor
 300
 301 window.title.unfocus            - unfocused title texture
 302 Window.Title.Unfocus
 303         .backgroundColor
 304         .color1
 305         .color2
 306         .borderWidth
 307         .borderColor
 308
 309 window.label.unfocus            - unfocused label texture
 310 Window.Label.Unfocus
 311         .backgroundColor
 312         .color1
 313         .color2
 314         .borderWidth
 315         .borderColor
 316
 317 window.button.unfocus           - unfocused button texture
 318 Window.Button.Unfocus
 319         .backgroundColor
 320         .color1
 321         .color2
 322         .borderWidth
 323         .borderColor
 324
 325 window.handle.unfocus           - unfocused handle texture
 326 Window.Handle.Unfocus
 327         .backgroundColor
 328         .color1
 329         .color2
 330         .borderWidth
 331         .borderColor
 332
 333 window.grip.unfocus             - unfocused grip texture
 334 Window.Grip.Unfocus
 335         .backgroundColor
 336         .color1
 337         .color2
 338         .borderWidth
 339         .borderColor
 340
 341 window.button.pressed           - pressed button texture
 342 Window.Button.Pressed
 343         .backgroundColor
 344         .color1
 345         .color2
 346         .borderWidth
 347         .borderColor
 348
 349 window.frame.borderColor        - color of border around client window
 350 Window.Frame.BorderColor
 351
 352 window.button.focus.foregroundColor - bitmap color for focused buttons
 353 Window.Button.Focus.ForegroundColor
 354
 355 window.button.unfocus.foregroundColor - bitmap color for unfocused buttons
 356 Window.Button.Unfocus.ForegroundColor
 357
 358 window.label.focus.textColor    - text color for focused labels
 359 Window.Label.Focus.TextColor
 360
 361 window.label.unfocus.textColor  - text color for unfocused labels
 362 Window.Label.Unfocus.TextColor
 363
 364 window.font                     - text font
 365 Window.Font
 366
 367 window.alignment                - alignment of text in labels
 368 Window.Alignment
 369
 370 window.title.marginWidth        - space around and between buttons and labels
 371 Window.Title.MarginWidth
 372
 373 window.label.marginWidth        - space around text in labels
 374 Window.Label.MarginWidth
 375
 376 window.button.marginWidth       - space around bitmaps in buttons
 377 Window.Button.MarginWidth
 378
 379 window.frame.borderWidth        - border width around client window
 380 Window.Frame.BorderWidth
 381
 382 window.handleHeight             - height of the window handle
 383 Window.HandleHeight