WMFS - Window Manager From Scratch - doc

Documentation

[[Manual page of WMFS]]

Get it

The stable version of WMFS will be available in a few weeks. To get the development version, you need to use the Git repository:

$ git clone git://git.wmfs.info/wmfs.git

Otherwise, you can get a snapshot on the gitweb: http://git.wmfs.info/wmfs.git or http://github.com/xorg62/wmfs/tree/master

Install it

To install WMFS, you need to satisfy some dependencies: CMake>=2.6, Freetype, Xlib, Xft. (And, optionally, Doxygen ...)
Run the following commands to install WMFS after you got the source (this perform a build out-of-sources -- all sources are compiled into a single folder, making your sources clean for modifications):

$ cd wmfs/
    $ mkdir build
    $ cd build
    $ cmake ..
    $ make
    # make install

If there is any problem, check the dependencies.
If you want to configure WMFS, you need to put the default configuration file in ~/.config/wmfs/wmfsrc, then, you may edit it.
If ~/.config/wmfs is not present :

$ mkdir -p ~/.config/wmfs

And then (still from wmfs build directory)

$ cp wmfsrc ~/.config/wmfs/

And then, you can edit ~/.config/wmfs/wmfsrc to configure WMFS.

$ $EDITOR ~/.config/wmfs/wmfsrc

Start it

You need to put the WMFS Binary file inside X\'s startup file (~/.xinitrc) if you don\'t use a Desktop Manager (GDM/KDM etc..)

$ echo "exec wmfs" > ~/.xinitrc

When you will run `startx`, X will be started, and execute wmfs.