Add in dummy AC_CONFIG_HEADERS("") line.
[fvwm-themes.git] / README
blob70697815f0e089ffb3ea4ac2195a0b6646937d69
1 This is a release of fvwm-themes based on the stable fvwm 2.4.8 version.
3 FVWM Themes is an attempt to create easy, configurable and modular framework
4 for the FVWM configuration. You can visit the project's home page at:
6         http://fvwm-themes.sourceforge.net/
8 or project's development page (where you may download the package):
10         http://sourceforge.net/projects/fvwm-themes/
12 This release should work out of the box and is stable enough.
13 The development continues.
15 How To Install
16 --------------
18 Note, starting from 0.6.2, fvwm-themes is divided to 2 packages,
19 fvwm-themes and fvwm-themes-extra. In the past (0.5.0 - 0.6.1)
20 the package names were fvwm-themes-base and fvwm-themes-extra.
22 Please read INSTALL file for installation instructions.
23 In short, after untarring fvwm-themes package you should execute:
25         ./configure
26         make install
28 You must not untar fvwm-themes-extra pack. To install it, execute:
30         fvwm-themes-config --site --install fvwm-themes-extra.tar.bz2
32 How to Start
33 ------------
35 Make sure you use one of the latest versions of fvwm >= 2.4.8.
36 Replace the last line of your ~/.Xclients (or ~/.xinitrc or ~/.xsession):
37         fvwm  (or fvwm2)
38 with:
39         fvwm-themes-start
40 and rerun X. See the fvwm-themes-start manual page for more details.
41 You should get the default theme, which you can change using the root menu.
43 How to use
44 ----------
46 Once you start fvwm with the themes configuration, you get a very modular
47 fvwm setup, including menus, bindings, colors, background, modules and more.
49 There is a "Theme Management" menu. To change theme components, choose
50 a theme and click on "[ all ]" to load all components in the chosen theme
51 or on a specific component to load only it. Different components may have
52 different options, they can be changed in the "current" theme submenu.
53 For example, there are 42 color schemes in the cde theme, and 32 in the
54 luthien theme. You first choose cde->colors, then current->colors->scheme.
55 You can also fully manipulate theme components using the Themes Center GUI.
57 Some themes may be more attractive to you, some less. At any time you may
58 reset all loaded theme components by choosing "Reset all to default".
59 Once you find the component combination you like, it is automatically
60 becomes permanent, the next time you start fvwm-themes, it will be loaded.
62 You will find more interesting things (about a possibility to ask a window
63 button itself what it does, about changing icon sets, or redefining bound
64 applications, or defining sessions and more) while exploring fvwm-themes.
65 Don't expect to learn fvwm-themes in one day. Just trying all possible
66 combinations of different theme components and their options may take years.
67 There are more explanations in the FAQ.
69 Documentation
70 -------------
72 There is plenty of documentation in the doc/ directory.
73 Please read it before asking your questions. Thank you.
75 Notes
76 -----
78 * For sound effects to work you need one of the sounds player listed under
79   Theme Management->current->settings->Sound Player to be installed (but
80   having one which can play .wav sound is a good idea). You can use esdplay
81   with esd running or not. rplayd must be run for rplay. You should update
82   your rplay.conf file with the sounds in sounds/ and themes/awol/sounds
83   for rplayD.
84 * fvwm-themes is wm-icons compatible. If you want to use more icon sets
85   than included 16x16-kde and 48x48-infox, you should install wm-icons
86   package and choose "External wm-icons" in current/settings/Icon Styles.
88 Success to you and enjoy!