cvsimport
[fvwm-themes.git] / README
blobe09a6643480fe9289e1496bca869103d8bf1399b
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 (CVS)
16 --------------------
18 To use the CVS version of fvwm-themes, you will need autotools installed, as
19 well as X11 header files.  The script:
21 contrib/configure_dev.sh
23 in the CVS sources will run the autotool commands to generate the necessary
24 configure script.  See the section on "How to Install" in this document on
25 how to install fvwm-themes in the usual way.
27 How To Install
28 --------------
30 Note, starting from 0.6.2, fvwm-themes is divided to 2 packages,
31 fvwm-themes and fvwm-themes-extra. In the past (0.5.0 - 0.6.1)
32 the package names were fvwm-themes-base and fvwm-themes-extra.
34 Please read INSTALL file for installation instructions.
35 In short, after untarring fvwm-themes package you should execute:
37         ./configure
38         make install
40 You must not untar fvwm-themes-extra pack. To install it, execute:
42         fvwm-themes-config --site --install fvwm-themes-extra.tar.bz2
44 How to Start
45 ------------
47 Make sure you use one of the latest versions of fvwm >= 2.4.8.
48 Replace the last line of your ~/.Xclients (or ~/.xinitrc or ~/.xsession):
49         fvwm  (or fvwm2)
50 with:
51         fvwm-themes-start
52 and rerun X. See the fvwm-themes-start manual page for more details.
53 You should get the default theme, which you can change using the root menu.
55 How to use
56 ----------
58 Once you start fvwm with the themes configuration, you get a very modular
59 fvwm setup, including menus, bindings, colors, background, modules and more.
61 There is a "Theme Management" menu. To change theme components, choose
62 a theme and click on "[ all ]" to load all components in the chosen theme
63 or on a specific component to load only it. Different components may have
64 different options, they can be changed in the "current" theme submenu.
65 For example, there are 42 color schemes in the cde theme, and 32 in the
66 luthien theme. You first choose cde->colors, then current->colors->scheme.
67 You can also fully manipulate theme components using the Themes Center GUI.
69 Some themes may be more attractive to you, some less. At any time you may
70 reset all loaded theme components by choosing "Reset all to default".
71 Once you find the component combination you like, it is automatically
72 becomes permanent, the next time you start fvwm-themes, it will be loaded.
74 You will find more interesting things (about a possibility to ask a window
75 button itself what it does, about changing icon sets, or redefining bound
76 applications, or defining sessions and more) while exploring fvwm-themes.
77 Don't expect to learn fvwm-themes in one day. Just trying all possible
78 combinations of different theme components and their options may take years.
79 There are more explanations in the FAQ.
81 Documentation
82 -------------
84 There is plenty of documentation in the doc/ directory.
85 Please read it before asking your questions. Thank you.
87 Notes
88 -----
90 * For sound effects to work you need one of the sounds player listed under
91   Theme Management->current->settings->Sound Player to be installed (but
92   having one which can play .wav sound is a good idea). You can use esdplay
93   with esd running or not. rplayd must be run for rplay. You should update
94   your rplay.conf file with the sounds in sounds/ and themes/awol/sounds
95   for rplayD.
96 * fvwm-themes is wm-icons compatible. If you want to use more icon sets
97   than included 16x16-kde and 48x48-infox, you should install wm-icons
98   package and choose "External wm-icons" in current/settings/Icon Styles.
100 Success to you and enjoy!