data/README.bbkeys

   1 This file gives a short description of the configuration possibilities of
   2 bbkeys.
   3
   4 ** Configuring bbkeys **
   5 ------------------------
   6
   7 --new in 0.3.2--
   8   By default, bbkeys will work regardless of which modifier keys you have
   9   pressed (caps/shift/num-locks).  If you want bbkeys to stop grabbing keys
  10   when you have these pressed, you must set this following line to true in
  11   your config file:
  12
  13   bbkeys.honorModifiers:        False
  14
  15 -----------------------------------------------------------------------------
  16
  17 Blackbox users:
  18
  19 By default bbkeys reads the Blackbox style-file as defined in .blackboxrc
  20 and copies as much of the style as possible. The result is a application
  21 which looks a lot like the toolbar.
  22
  23 Configuration options can be changed in bbkeys.bb.
  24 Most likely you want to change some of these options,
  25
  26 The global configuration file can be found in $datadir/bbtools/bbkeys.bb
  27 A local configuration can be made by copying the bbkeys.bb file to
  28 $HOME/.bbtools/bbkeys.bb and editing it.
  29
  30
  31 Users other Window managers:
  32
  33 Configuration options can be changed in bbkeys.bb.
  34 Most likely you want to change some of these options,
  35
  36 The global configuration file can be found in $datadir/bbtools/bbkeys.nobb
  37 A local configuration can be made by copying the bbkeys.nobb file to
  38 $HOME/.bbtools/bbkeys.nobb and editing it.
  39
  40
  41 ** Reconfigure bbkeys.**
  42 ------------------------
  43
  44 Automatic update style:
  45         If the resource : bbkeys.autoConfig: true
  46         The tool will periodically check if the main config files, .blackboxrc
  47         for Blackbox users and bbkeys.nobb for other WM's to see if
  48         they have changed. If so bbkeys will reconfigure.
  49
  50
  51 ** Copying the look of the Blackbox toolbar **
  52 ----------------------------------------------
  53 bbkeys automaticly copes the style of the blackbox window decor.
  54 It copies:
  55 window                          -> bbkeys.frame
  56 window.label                    -> bbkeys.label
  57 window.color                    -> bbkeys.frame.color
  58 window.colorTo                  -> bbkeys.frame.colorTo
  59 window.label.color              -> bbkeys.label.color
  60 window.label.colorTo            -> bbkeys.label.colorTo
  61 window.textColor                -> bbkeys..textColor
  62 bevelWidth                      -> bbkeys.bevelWidth
  63
  64 For the meaning of the different resources see the comments in the
  65 config-files.