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

In this file you can find information about installation and customization of
FVWM-Crystal desktop. It's divided into two parts. In first section I will
explain how to install FVWM window manager and FVWM-Crystal configuration
files. In the second part you can find a copule of ways to customize your own
desktop using additional programs.

Info about priorities used in this file:

- Essential - it must be installed, cannot be changed to something else
- Required - it must be installed, can be changed to something else
- Optional - it's not requed, cannot be changed to something else
- Extra - it's not requed, can be changed to something else

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Part I: Installation
--------------------

Name:		FVWM Virtual Window Manager
Priority:	Essential
Version:	2.5.12+
Homepage:	http://www.fvwm.org/

It's the main "core" of the FVWM-Crystal desktop, a very configurable window
manager with excellent configuration system.

Check in your distribution resources for 'fvwm' or 'fvwm2' package, at least
version 2.5.10. If it's not there, get the newest version from the project
homepage (unstable branch or CVS) and get ready for installation. Below you
can find some info about needed features.

You can apply a patch for FVWM, available in 'addons' directory of
fvwm-crystal package, called 'FvwmIconMan.patch'; it will enchance the
functions of FvwmIconMan a bit, read the info in this file.

After initial configuration (using ./configure) there is printed an table with
current compilation settings. It should look like this:

  With Gettext Native Lang Support?   yes
  With PNG image support?             yes
  With ReadLine sup. in FvwmConsole?  yes
  With Shaped window support?         yes
  With Shared memory for XImage?      yes
  With Session Management support?    yes
  With Mouse strokes (gestures)?      yes
  With Xft anti-alias font support?   yes
  With XPM image support?             yes
  With Xrender image support?         yes

Here are included only those entries, which are needed, others can be
available or not.


Name:		Aterm
Priority:	Extra (others: xterm, urxvt, mrxvt)
Homepage:	http://aterm.sourceforge.net/

It's a terminal emulator, small, fast and configurable. You can find it in
your distribution or on the homepage.


Name:		ImageMagick
Priority:	Optional
Homepage:	http://www.imagemagick.org/

It's a collection of the image manipulation programs; in FVWM-Crystal it's
used to create "thumbnails" of iconified windows, visible on the desktop.


Name:		habak
Priority:	Required (others: Esetroot, hsetroot, ROX-Filer)
Version:	0.2.4.1
Homepage:	http://fvwm-crystal.berlios.de/

It is a very functional utility, which gives you the ability to set
a wallpaper in various ways, write the text on the root window with selected
TTF font, make some changes on the image when it's set, etc.


Name:		trayer
Priority:	Optional
Version:	1.0
Homepage:	http://fvwm-crystal.berlios.de/

A "docklet" replacement, used for dockable icons in some applications, such as
Psi or Gaim.


Name:		FVWM-Crystal
Priority:	Essential
Homepage:	http://fvwm-crystal.berlios.de/

It's a collection of FVWM configuration files, scripts, icons and images which
turns into versatile, extensible and easy to use desktop environment.

You can install Crystal in two ways, system-wide or local ("user-wide").

System-wide:

- copy all files from 'fvwm/' directory to '/usr/share/fvwm-crystal/fvwm/' or
  '/usr/local/share/fvwm-crystal/fvwm/'
- copy all scripts from 'bin/' to '/usr/bin/' or '/usr/local/bin/'
FVWM-Crystal will automatically copy all needed files to the '~/.fvwm'
directory upon startup.

User-wide:

- copy all files from 'fvwm/' to '~/.fvwm/' directory
- copy all scripts from 'bin/' to '~/bin' or somewhere in your $PATH.


Both installations:

- copy file 'addons/Xresources' to '~/.Xresources'
- if you start your X session using 'startx' command from the command line,
  copy file 'fvwm-crystal/addons/Xsession' to '~/.Xsession' or '~/.xinitrc',
  depending upon your Linux distribution
- if you use GDM to start your X session, copy file
  'fvwm-crystal/addons/gdm/fvwm-crystal' to '/etc/gdm/Sessions/fvwm-crystal'
  (by default in Debian distribution). Copy also file
  'fvwm-crystal/addons/gdm/fvwm-crystal.desktop' to
  '/usr/share/xsessions/fvwm-crystal.desktop' (by default in Debian). Now you
  can select "FVWM-Crystal" session to start your new desktop


-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Part II: Customization

FVWM-Crystal can use some programs to provide additional functionality. Here
is a brief list of them. If you want to know how to configure and use them in
Crystal, look to the 'README' file instead.


Name:		X MultiMedia System (XMMS)
Priority:	Optional
Homepage:	http://www.xmms.org/

Good sound player. Some don't like it, because it uses old GTK+ libraries for
the GUI, and the interface is not very clever... So Crystal brings it's own
GUI for XMMS :). Player windows are hidden by default, you can control
playback using keyboard shortcuts or panel buttons. Package for your
distribution will be fine.


Name:		XMMS-Shell
Priority:	Optional
Homepage:	http://freshmeat.net/projects/xmms-shell/

Needed by Crystal to provide even more control on XMMS. Package from your
distro should be fine.


Name:		XMMSFind
Priority:	Optional
Homepage:	http://xmmsfind.sourceforge.net/

Good plugin for XMMS, gives you the ability to open 'Jump to' window. You can
grab it from http://xmmsfind.sourceforge.net/; extract, compile and install
(usual way). Now start XMMS, enable XMMSFind plugin and have fun :)


Name:		Aumix
Priority:	Optional
Homepage:	http://www.jpj.net/~trevor/aumix.html

Audio mixer, used to change volume levels. Version from your distribution
should be fine.


Name:		XScreenSaver
Priority:	Extra (others: xLockMore)
Homepage:	http://www.jwz.org/xscreensaver/

It's a screen saver. In FVWM-Crystal you can find a separate menu to control
it and open preferences. Also if it's found, it's loaded by default.'


Name:		sudo
Priority:	Optional
Homepage:	http://www.sudo.ws/sudo/

I'ts a program used to let users launch commands with root provileges. In
Crystal it's used to launch shutdown and reboot commands from the menu. You
need to have properly configured /etc/sudoers file to use sudo.


Name:		GKrellM
Priority:	Extra (others: gDesklets, Chruppy, torsmo)
Homepage:	http://www.gkrellm.net/

It's a system monitor, which can be used to monitor CPU activity, network
traffic, etc. It has reserved space in Crystal, at the right edge of the
screen (when it's started).


Name:		ROX-Filer
Priority:	Optional
Homepage:	http://rox.sourceforge.net/

It's an easy to use graphical file manager with desktop icons suport. It can
be used to provide icons on the desktop, or just as graphical file manager for
everyday file operations.


Name:		Psi
Priority:	Extra (others: Gabber, TleenX2, Kadu, Skype)
Homepage:	http://psi.affinix.com/

Instant messaging Jabber communicator. This and other programs "dockable
window" can be swallowed into the Docklet panel.

