WELCOME

...to wmii-2, the dynamic non-wimp environment of the WMI Project.

This file is displayed when you run wmii for the first time. It is highly
recommended to read and proceed with following tutorial. Have fun!


GETTING STARTED TUTORIAL

This is a small step by step tutorial, which might give you an idea, how
to get started with wmii(1), especially if you're new to it.

The following steps contain schortcuts, which use the common X naming
scheme 'mod1', which is normally equivalent to the 'Alt' key.
After each shortcut, its action name is provided in brackets.


1.  Launch a new terminal using mod1+t (term).

2.  Press ctrl+mod1+a (actions) to enter the actions menu and enter
    'term', press ENTER afterwards. You have now used wmimenu(1) to
    accomplish what wmikeys(1) (mod1+t) did. If this window is too small,
    you can bring it to the left tile using mod1+Return (zoom).

3.  Press mod1+Tab (fnext) to learn basic navigation.

4.  Create a new page with ctrl+mod1+y (pnew) and apply float layout to
    it with mod1+shift+f (lfloat).
    To return to this page again, you can press ctrl+mod1+l (pnext).

5.  Experiment with your mouse a bit. Resize this client through clicking
    left mouse button on a border and drag, move this client around
    through clicking left button onto the titlebar and dragging. See how
    the layout handles moving.
    You can also move and resize windows when the pointer is above a
    client. To move, press mod1+Button1 and drag. To resize,
    press mod1+Button3 and drag. The resize direction in this mode is
    dependent from the distance to the nearest corner.

6.  Press ctrl+mod1+p (programs) to enter programs menu. You can escape
    from that menu, which will contain all executables in your path using
    the ESC key or through launching an application through selecting it
    and pressing ENTER.
    You can speed up selection through input some patterns.

7.  Enter at the prompt of your terminal:

     ; wmir read /

    You will get a list of files and directories. Directories end with
    the '/' character, ie wm/. Browse the pseudo-filesystem like this:

     ; wmir read /wm/

    Feel free to browse deep into the filesystem.

8.  Now you will use wmir(1) instead, to select the other page.
    Just enter following command in your terminal:

     ; wmir write /wm/ctl 'select prev'

    Note that the quotes are needed.

9.  To see what's also possible try following command in a terminal:

     ; wmir write /wm/page/sel/mode/sel/sel-style/bg-color '#FF0000'

    Note, that also here the quotes are important, otherwise your shell
    will ignore the color tuple.

    To gain further insight of the power of the fileserver based
    inter-process and customization approach of wmii, look at the scripts
    included with wmii.

10. You might be interested of what key bindings are currently in use,
    just execute following command in your terminal:

     ; wmir read /keys/mode/normal/

    Afterwards you get a list of all shortcuts, which are currently in use.
    To see what happens if such a shortcut is pressed, just read the
    specific file contents, also using wmir read, ie:

     ; wmir read /keys/mode/normal/mod1+t

    The above command will return something like 'term', which is an
    action usually from [/usr/local]/etc/wmii/action/ directory.

11. If you have installed latex and xdvi, you can create a wmii
    reference card now, through invoking following command:

     ; wmirefcard

Hopefully these steps have given you an idea how things work.
Now it would be time to read further the wmii(1) and wmii.rc(5) man pages.
