Update luthien theme to use features in FVWM 2.5.25+
[fvwm-themes.git] / INSTALL
blob409c3daefa1a46f4b02521f256f5f2b3794738e4
1 Welcome to FVWM Themes, a stable release.
4 HOW TO INSTALL
5 --------------
7 To install this package unpack the fvwm-themes tarball and execute:
9         ./configure
10         make
11         make install
13 You can run two first commmands as any user and the last one as the user
14 having write permissions to fvwm installation (supposedly root).
16 After that, the package can be uninstalled at any time using:
18         make uninstall
20 It is possible (but not recommended) to install fvwm-themes to any place,
21 regardless of fvwm installation, but you should really know what you do,
22 see the last section of this file for instructions.
24 To install additional themes from fvwm-themes-extra pack, you may execute
25 this command as the same user that did "make install" for fvwm-themes:
27         [/path/]fvwm-themes-config --site --install fvwm-themes-extra.tar.gz
29 Individual themes may be removed by removing the corresponding directories.
31 Please report any installation problems to fvwm-themes-devel mailing list.
34 FVWM THEMES CONFIGURE OPTIONS
35 -----------------------------
37 Try ./configure --help for the list of all the options to configure.
38 In addition to the standard options there is the following option:
40 --enable-gnome-icons - This causes fvwm-themes installation procedure
41 to find and convert GNOME PNG icons into xpm icons and mini-icons (under 
42 datadir/fvwm/tr-images directory). For that you need GNOME and ImageMagick
43 installed. Use this option if you want original GNOME icons into your fvwm
44 GNOME menus and for the Icon and MiniIcon Style of the GNOME applications.
45 See the FAQ and the fvwm-themes-images man page for more details.
47 --enable-kde2-icons - As above for KDE version 2.
49 THE DEFAULT DIRECTORIES
50 -----------------------
52 The fvwm-themes is designed as an add-on, integrated to fvwm 2.4 versions.
53 The default is to install fvwm-themes to the same directories as fvwm itself,
54 more specifically, to ones returned by:
56         fvwm-config --bindir --mandir --fvwm-datadir
58 If fvwm bin directory (fvwm-config utility is part of fvwm-2.3.17+) is not
59 in your $PATH, we suggest you to add this directory to your $PATH or specify
60 --with-fvwm-bindir parameter to ./configure. Adding fvwm bin to your $PATH
61 is needed anyway if you want to use all features (like fvwm-menu-* scripts).
63 IMPORTANT NOTE: If you have 2 fvwm installations, for example the
64 stable and unstable one, you should install fvwm-themes twice for each
65 installation with different --with-fvwm-bindir parameters. Then run correct
66 /path/[un]stable/fvwm-themes-start, everything else should work as expected.
67 Just be aware that if you have different fvwm-themes versions installed,
68 your ~/.fvwm/themes* files and directories may be out of sync. If you
69 always run fvwm-themes-start the problems should not happen. You may also
70 do "Reset all to default", or "/path/[un]stable/fvwm-themes-config --reset".
73 HOW TO CHANGE THE DEFAULT DIRECTORIES
74 -------------------------------------
76 You should normally skip this section. Currently installation to an
77 alternative (non fvwm) place will not work without many changes.
79 You can overwrite the default directories by giving one or more parameters
80 to ./configure: --bindir, --mandir, --datadir (or --with-ft-datadir).
82 Note, fvwm-themes (like fvwm itself) installs all goodies to $datadir/fvwm.
84 You can also specify --prefix parameter, in this case the mentioned
85 directories will default to this prefix ($prefix/bin, $prefix/man,
86 $prefix/share/fvwm). Normally, the prefix is not used.
88 Example:  env DEBUG=1 ./configure --prefix=/tmp/fvwm-themes --bindir=/tmp