
0. What is that FVWM-Crystal anyway?

    If you are reading this file, you probabley know ;), but for the
 remaining. FVWM-Crystal is a powerful theme for FVWM widows manager. Its
 main power lies in transparency and key-bindings (sic!), it`s just
 a solid windows manager for people, who care for fast and eye-candy.

1. What, where, how?

 a) Files avaiable with this package:

     AUTHORS - persons responsible for creating FVWM-Crystal.
     COPYING - license on which FVWM-Crystal is being developed.
     INSTALL - instalation description in english.
     INSTALL-pl - instalation description in polish.
     INSTALL.CVS - description of CVS version instalation in english.
     INSTALL-pl.CVS - instalation description in polish.
     NEWS - news from the last package version.
     README - you`re reading it right now.
     README-pl - FVWM-Crystal description in polish.
     doc/FAQ - Frequently Asked Questions in english.
     doc/LICENSE - GNU GPL license.
     TODO - things to do.
     doc/habak/* - habak`s documentation - application to set background.

 b) Web site:

     http://fvwm-crystal.linuxpl.org

 c) IRC:

     server: irc.freenode.net
     channel: #fvwm-crystal

 c) contact with authors:

     - by jabber:

        harnir@chrome.pl
        axquan@chrome.pl
        lucass@chrome.pl

     - by e-mail:

        axquan@arx.pl
        lucass@gentoo.pl

     - or by gadu-gadu:

        axquan: 4121282

2. Let the party begin.

   ( Informations contained here are also availabe from web site,
     under this location:
     http://fvwm-crystal.linuxpl.org/documentation-first_steps.pl.html )

    After instalation and starting FVWM yours eyes should see
 rotane_qubiq_room wallpaper, default DarkDesktop-Grey colorset and
 gkrellm panel.

 WARNING!! Remember about this, that after every signal FVWM-Crystal load
           you must turn off [NumLock], because if its on, you`re not able
           to move windows.

    I recommmend you setting gkrellm apperance and mark option "Remember
 window position while exit and move there after start" (or something like
 that, I don`t have engilsh version). Clicking RMB on the screen will
 cause opening terminal emulator and [Alt] + RMB opening file manager.
 Those programs can be set in ~/.fvwm/01enviroment file. Remember that
 after every change you have to restart FVWM-Crystal by chosing from menu
 in upper-left corner 'System' -> 'Restart fvwm-crystal'.

    In the upper-left corner, there is the main panel, with its help you
 can run programs, change apperance of the screen and use XMMS. At the
 moment there is an "X" icon on it. After clicking on it with right mouse
 button scripts implemented in fvwm-crystal will seek the system for known
 programs and add them to menu. In this panel basic functions of buttons,
 always are situated on the end of menu, available in the button, they are
 avaiable under right mouse button; left mouse button opens the menu of
 singular button.

    From the uprised panel "apps" you can run programs now. They are
 shared into categories: internet, graphics, office, tools, games and
 system. This share can be change in the configuration. You can already
 run an application, which icons appers on the panel (eg. Mozilla, GIMP,
 VIM) with right mouse button, and with the help of left mouse button menu
 with other programs placed in singular categories appers. Standard there
 is no terminal emulator in the panel, because, as the most frequently
 used application, it`s placed in the fastest available place - it opens
 after clicking right mouse button on the random place on screen. You can
 edit apps list in the ~/.fvwm/apps/ , in file begining with numbers from
 10 to 98, which contain propet apps groups. Configuring this files is so
 simple that it doesn`t need any more comments.

    Windows in FVWM-Crystal have thin, 1-point borders, which don`t do
 nothing (except estetic). In other WMs you can with its help change
 window size, but here it can be done by clicking middle mouse button
 on the transparent title bar and draging it. There are "killing" buttons
 on both sides of the bar. It can be deleted in three ways: close,
 minimalize or kill. We close windows with left mouse button, the right
 mouse button minimalize it. Killing window (and therefore connected with
 it program) is available in the menu opened by holding [Alt] key and
 clicking random mouse buttom on the "terminator" buttons.

    A menu will open. Killing window is avaiable from the position
 'Destroy'. Marks (L), (R) and (M) means mouse buttons (respectively:
 left, right and middle) which need to be clicked on the singular button
 in title bar (without holding [Alt]) to achive marked action. Every
 button has its own menu, containig commands relating to activity
 interesting us at the moment.

    Maximalize button "+" allows several actions: begining with
 maximalizing to full screen, in heigh or in width, ending with
 maximalizing to avalaible free space. Near its there are buttons with
 different options, like sticking window to screen, blocking above or
 under others windows, identify window (useful when configuring apperance
 and stuff), and refreshing.

    In the upper-right corner of the screen there is second bar, consisted
 from 3 parts: clock, big panel in which minimalized icons appers, and
 little panel containing docklet icons, eg. Psi or Gabber. This bar can be
 extend in configuration, so it can contain more than one docklet icon.
 Icons bar can contain up to 6 icons, if there will be more of them, the
 bar will automaticly extend.

    Minimalizing windows is one way to move it between screens. Clicking
 with left mouse buttons on the icon will retrive it on active screen. If
 we click right mouse button the window will be retrived on the screen
 from which it was miniamlized and we will be moved there.

    There are two panels placed all over the bottom of the screen. They
 are showing opened windows: left panel shows graphical windows(eg. GIMP`s
 window, Mozilla, MPlayer); right shows text windows, that is terminals
 (aterm, eterm, xterm and others).

    On open windows panels mouse buttons work reversed than in icons
 panel: after clicking left mouse buttons we are being moved to screen on
 which the window stands; right mouse button moves chosen window on the
 active screen.

    In the upper-middle part of the screen there is a pager panel. It
 allows to switch between screens: we can choose active screen with left
 mouse button, right mouse button allows to fluid move between screens.

    On the pager there are tiny windows with icons assigned to programs.
 They can be moved between screens with holding middle mouse button and
 moving it in the pager. If we try to pull the window outside the pager,
 it will arrise on the active screen.

3. Key-bindings.

   ( Informations contained here are also availabe from web site,
     under this location:
     http://fvwm-crystal.linuxpl.org/documentation-functions.pl.html )

 a) Dictionary:

    LMB
     Left Mouse Button - it`s the most used button.
    RMB
     Right Mouse Button - second in the order of using.
    MMB
     Middle Mouse Button - it`s the most uncommonly used.
    Num_
     prefix meaning key on the numeric keybord, eg. Num_+ means key
     "Plus" on the numeric keybord.
    Menu
     it`s in the upper-left corner, there are commands allowing to steer
     the screen
    Menu_
     prefix meaning menu of button on the title bar, it`s used with the
     name of button. Menu is being produced by holding [Alt] key and
     clicking, with random mouse button, on the button (Close, Maximize or
     Layer)
    Close
     button of closing is on the both side of title bar, it has a 'X' sign
     on it.
    Maximize
     button allowing to maximize window, it`s on the left side of title
     bar, it has a '+' sign.
    Layer
     button with random functions concerning window, it`s on the right
     side of title bar, it has a form of two squares.
    Graphic windows
     they are windows painted in graphical mode, their size can be positon
     to a pixel, eg. Mozilla, GIMP.
    Text windows
     they are terminal`s windows, chnaging its size is avaiable only of
     fixed size of sign (not to pixel)

 b) Opening terminals:
 
    RMB on desktop
     opens new terminal
    Alt+~
     opens or hides CrystalConsole window, it`s an ordinary termianl set
     on all width of the screen, in its upper side. You can execute in it
     some command and hide it with the help of the same key combination
    Alt+Shift+~
     opens new terminal

 c) Opening special windows:
 
    Alt+RMB on desktop
     opens file manager window chose in configuration file
    Menu -> System -> FvwmConsole
     opens FvwmConsole, allowing to give commands directly to FVWM

 d) Switching windows activity
 
    Moving mouse cursor on new window
     automaticly activates window, without moving it in the front
    Alt+Tab
     opens windows list, pressing one after another Tab you can choose
     window, after letting it go desktop is being changed into this one,
     in which there is chosen window which is being activated; you can
     also choose window from the menu with mouse, or cancel it by
     pressing Esc (without letting Alt go), or by clicking mouse outside
     the menu
    Num_5
     switching between two last active windows
    Num_1 2 3 4 6 7 8 9
     moving activity in chosen direction on the "rose of winds"
    LMB on the window miniature in pager
     moving on the desktop in which there is chosen window and activating
     it
    LMB on the name of the window in open windows panel
     moving on the desktop in which there is chosen window and activating
     it

 e) Moving windows on the screen:
 
    LMB+move on the title bar
     moving window, its being first moved in the front of other windows,
     after letting mouse button go it returns to the back
    RMB+move on the title bar
     moving window, it stays on the same layer - it doesn`t move in the
     front or in the back
    Alt+LMB+move on the window
     moving window, its being moved in the back of other windows, after
     letting mouse button go it returns to the front, it can be activated
     in random place (except buttons in the title bar)
    Alt+RMB+move on the window
     moving window, it stays on the same layer (it doesn`t move in the
     front), it can be activated in random place (except buttons in the
     title bar)
    Alt+Num_5
     centers window in the middle of the screen
    Alt+Num_1 2 3 4 6 7 8 9
     moving window in chosen direction on the "rose of winds", quick
     double click will cause window jump, omiting move animation
    Alt+Shift+Num_1 2 3 4 6 7 8 9
     moving window by 50 pixels in chosen direction on the "rose of
     winds", quick double click will cause window jump, omiting move
     animation

 f) Changing windows size:
 
    MMB+move on the title bar
     changing window size, you have to move mouse cursor to chosen edge,
     moving to the second edge will change size in both ways, moving to
     the edge opposite to the currnet changing ones will cause growing
     window in the second direction
    Alt+MMB+move on the window
     changing window size, could be done in any place of window (without
     buttons in title bar), works the same as if using MMB on the title bar
    LMB on Maximize button
     maximizing window in both diretions only on the free space, if behind
     that window there is another one, it will be counted as a free space
    RMB on Maximize button
     maximizing widow in horizontal only on the free space
    MMB on Maximize button
     maximizing widow in vertical only on the free space
    Menu_Maximize -> Maximize
     maximizing window on the whole screen
    Menu_Maximize -> Maximize horizontally
     maximizing window in horizontal on the whole screen width
    Menu_Maximize -> Maximize vertically
     maximizing window in vartical on the whole screen heigh
    Num_*
     maximizing window in both diretions only on the free space
    Alt+Num_*
     maximizing window in both diretions only on the whole screen
    Alt+Shift+3
     changing widow size, graphical windows will have size of 320x200,
     text windows will have 5 lines by 120 columns
    Alt+Shift+4
     changing widow size, graphical windows will have size of 400x300,
     text windows will have 20 lines by 55 columns
    Alt+Shift+5
     changing widow size, graphical windows will have size of 512x384,
     text windows will have 50 lines by 80 columns
    Alt+Shift+6
     changing widow size, graphical windows will have size of 640x480,
     text windows will have 25 lines by 80 columns
    Alt+Shift+8
     changing widow size, graphical windows will have size of 800x600,
     text windows will have 50 lines by 120 columns
    Alt+Shift+0
     changing widow size, graphical windows will have size of 1024x768,
     text windows will have 50 lines by 140 columns

4. Thanks.

    I know that nobody except interesed will read this, but I would like
 from this place thanks Maciek (harnir) for "pulling" me (axquan) to the
 project. I would also thank You for using FVWM-Crystal, which is a word
 saying "I admire your work".

 Saying after Master Yoda: "Let the Crystal be with you!" :D
 