FVWM-Crystal installation instructions
======================================

Installing from a package
-------------------------
Uncompress the package to a temporary directory and issue command:

	make install

FVWM-Crystal will be installed in /usr/local directory, so you need to become
root for installation to work. If you want to install Crystal in other
directory, or you don't have access to a root account, you can change the
prefix:

	make prefix=/usr install


Installing from svn repository
------------------------------
cd to the repository and issue commands:

	make install

Optionally copy 'addons/fvwm-crystal.desktop' to /usr/share/xsessions/, then
you will be able to select "FVWM-Crystal" in your GDM/KDM login manager.

Needed adjustement by the user
------------------------------
Using the above default install directory, fbwm-crystal will be installed
into /usr/fvwm-crystal. If you want use mplayer as media player, you will need
to adjust the media paths. For that copy the Music file into crystal home
directory:

cp /usr/share/fvwm-crystal/fvwm/components/functions/Music ~/.fvwm-crystal/components/functions/Music

and edit this file. If you are new to linux and don't know any editor, the easiest way
is to install the midnight-commander (mc with your package manager) and to use
its editor via the F4 key.

At the beginning of the file into the Variables section, adjust
the fvwm_video_path(n). You must have at least one of them and they must
point to the directories where your video files are avaible.
It can be necessary to adjust fvwm_dvd_path to the path of your dvd drive.

In the function FuncFvwmMenuDirectory, adjust the fvwm_video_path(n).
They must be the same than fvwm_video_path(n) variables, one line by variable.
In the menu /Music/LoadMovie, adjust the fvwm_video_path(n).
They must be the same than fvwm_video_path(n) variables, one line by variable.

Preferences
-----------
All the preferences are done from the menu of Fvwm-Crystal
with 2 notable exceptions:
1) The media player and mixer preferences are done from the menu
of the Music button.
2) The preferences for Recreate the Playlists must be done by hand:
Copy MediaDirectories into ~/.fvwn-crystal/preferences/MediaDirectories
and edit it. Each line must contain the type of media (one of <audio>,
<video>, <cdrom>, <dvd>), followed by the main path to the media files or
device file.

cp /usr/share/fvwm-crystal/fvwm/preferences/MediaDirectories ~/.fvwm-crystal/preferences/MediaDirectories

Note on fvwm-crystal.generate-menu
----------------------------------
fvwm-crystal.generate-menu is a script that can be used to generate the missing
FVWM-Crystal applications menu entries. To be able to do that, it must know
where FVWM-Crystal is installed and where are the applications type *.desktop
files. This is handled by a few variables in the script and it can be needed
to edit some of them before to run the script.

The FVWM-Crystal related variables will be modified to the correct location
by "make install". But it is no way the Makefile can know for sure where the
application type desktop files are installed in your distribution.

Variables to check in fvwm-crystal.generate-menu:
-------------------------------------------------
DesktopDir="Path_to_the_desktop_files" usualy
"/usr/share/applications /usr/local/share /path/to/kde/share/application /path/to/gnome/apps"

SYSTEM_ICONDIRS="Path_to_the_icon_files" usualy
"/usr/share/pixmaps /usr/share/icons /path/to/kde/share/icons"

Note to distribution maintainers:
---------------------------------
If you package management system is using a sandbox when building the package,
you must also pay attention to the following variables:

FC_MENUBASEROOT="path_to_FVWM-Crystal_application_menu", usualy
"/usr/share/fvwm-crystal/fvwm/Applications".

FC_ICONBASEROOT="path_to_FVWM-Crystal_icons", usualy
"/usr/share/fvwm-crystal/fvwm/icons/Default".

Libpng warnings
...............
The current version of fvwm-crystal.generate-menu include a fix to get ride
of warnings like the following:
    libpng warning: Ignoring incorrect gAMA value .55 when sRGB is also present.

Howeher, it will not fix already present icon files. For that, you may want
to run the following commands:
    cd ${HOME}/.fvwm-crystal/icons/Default
    find -name "*.png* -exex convert "{}" "{}" \;

When inside individual directory, you may prefer:
    for i in $(ls); do convert "$i" "$i"; done

In order to get ride of all the warnings, it can be necessary to run convert
several times (up to 3 times) on some files. This is important becuuse
Fvwm-Crystal feel faster without this kind of warning.

General installation tips
-------------------------
If you don't have your own ~/.Xresources, copy one from 'addons/' directory.
You can also find there sample ~/.Xsession (or ~/.xinitrc) file.

You need recent version of Python installed for 'fvwm-crystal.apps' script.
And of course unstable version of FVWM (2.5.31+ or CVS) would be good... ;)


-----------------------------------------------------------------------------
Useful applications:

Needed:
-------
- fvwm>=2.6.5
- ImageMagick (convert is used for application menu icons generation)
- xwd for on the fly icon generation
- coreutils
- sed
- awk (tested with gawk)
- bc if mplayer or alsaplayer are installed (used by speed control)

Strongly recommended:
---------------------
- ImageMagick package for screenshots and thumbnailed icons
- 'feh' 'hsetroot' or 'Esetroot' for setting a wallpaper
- one of 'trayer' for tray icons (available on FVWM-Crystal webpage) or
  'stalonetray'
- One of 'aterm', 'urxvt', 'mrxvt', 'xterm', 'Eterm', 'gnome-terminal', 'konsole' ,
  'terminator' or 'xfce4-terminal' - for terminal emulator
- One of 'mrxvt', 'urxvt', aterm' or 'xterm' for Quake console
- Thunar for nice file manager and icons on the desktop

Optional, but supported:
------------------------
- 'xscreensaver' for screen saver
- At least one of 'mpd', 'mpc', 'gmpc' or 'xmms', 'xmms-shell', 'xmms-find' or 'xmms2' or
  'quodlibet' or 'cdcd' or 'cmus' or 'alsaplayer' or 'mplayer' for built-in music
  player support (even video support with mplayer) 
- 'transset' and 'xcompmgr'for full transparency support.
- A mixer application. I recommand alsamixer.
- 'sudo' and 'gksudo' for running text/graphical applications as superuser and
  for reboot/shutdown options in the Exit menu
- 'xrandr' for video mode switching
- 'gdmflexiserver' (distributed with gdm) for GDM login manager support
- ROX-Filer or Nautilus for alternatives to Thunar
- 'gnome-session' for session management support. Follow the instructions in 
  'addons/session-management.README'. It is for Gnome 2, if you can get it to
   work with a current Gnome version, please consider to contribute with
  some kind of up-to-date explaination.
