README.bbpager
1This file gives a short description of the configuration possibilities of
2bbpager. For blackbox users, bbpager attempts to copy the look of blackbox to
3help integrate itself visually in the blackbox environment. For all users,
4bbpager provides a flexible mechanism for specifying configuration options.
5
6
7** Configuring bbpager **
8-------------------------
9
10bbpager searches in several locations for its configuration options. In order
11of precedence (that is, an option defined in a location listed higher on the
12list will take precedence over an option defined lower on the list), these
13locations are:
14
151) bbpager-specific options in the blackbox style file. The location of the
16 blackbox style file is taken from the session.styleFile option in the
17 blackbox configuration file. By default bbpager looks for the blackbox
18 configuration file in $HOME/.blackboxrc, though an alternate location may be
19 given with the bbpager command-line option called -bbconfig. Specifying
20 bbpager-specific configuration options in the blackbox style file is useful
21 if the user wants to change some aspect of bbpager from one blackbox style
22 to another.
23
242) The bbpager configuration file specified by the -config command-line option.
25 If the -config command-line option is given, then bbpager reads the options
26 provided in the specified file and does NOT look for the local or global
27 configuration files described in (3) and (4) below.
28
293) The user's local configuration file in $HOME/.bbtools/bbpager.rc . bbpager
30 will look in this location only if the -config command-line option was not
31 provided.
32
334) The global configuration file in $datadir/bbtools/bbpager.rc . bbpager will
34 look in this location only if the -config command-line option was not
35 provided.
36
375) blackbox options in the blackbox style file. From the style file, bbpager
38 will copy several of the blackbox look-and-feel options and use them as
39 defaults. These default values will be used unless the bbpager options are
40 explicitly specified elsewhere. See "Visual Integration with Blackbox" below.
41
426) The bbpager source code, which contains last-resort values.
43
44
45** Visual Integration with Blackbox **
46----------------------------------------------
47
48If the blackbox configuration file exists, bbpager will use the current blackbox
49style to set a few of its default style options. Specifically, it will use the
50following textures as defaults:
51
52bbpager blackbox
53------- --------
54bbpager.frame toolbar
55bbpager.desktop toolbar.label
56bbpager.window window.label.unfocus
57bbpager.window.focus window.label.focus
58
59
60** Configuration Options **
61---------------------------
62
63Please see the the global configuration file for a complete list of the bbpager
64configuration options and a description of each.
65