foo-wm

(Archived) Experimental Zooming IPC-based WM
git clone http://milesalan.com/git/foo-wm
Log | Files | Refs | Mirror | README | LICENSE

README.md (3512B)


      1 foo-wm: Foo Window Manager
      2 ============================
      3 Foo Window Manager is a minimalistic window manager that does two things and two things only:
      4 
      5 1. Provides a tree data structure in which you can organize windows.
      6 2. Provides a socket for IPC along with a basic DSL for manipulating and traversing the tree.
      7 
      8 As a results of *only* doing these two things, `foo-wm` most likely works a bit differently than other window managers you may be acquainted with. Mainly, strangest of all to the newcomer, `foo-wm` **does not provide**: workspaces or keybindings. The former can be emulated through foo-wm's tree and the latter can be provided through any X keybinding program (such as `xbindkeys`).
      9 
     10 > A foreword: `foo-wm` should be considered unusable alpha software. I use `foo-wm` on a daily basis, although that doesn't mean you should (unless you are interested in contributing). `foo-wm` doesn't have full support for many basic window managment functions (ICCCM/EWMH). Although, ICCCM/EWMH support is a top priority currently.
     11 
     12 ### The Makefile will generate:
     13 `foo-wm`: The window manager itself which can be thrown in `.xinitrc`. It is reccomeneded that you start `foo-wm` with a keybindings manager, such as `.xbindkeys`, as it will be very diffucult to interact with `foo-wm`'s socket otherwise. The location and name of the socket, is to be specified in `src/config.h`. If no `SOCKET_NAME`, is specified then a name will be automatically generated based on the PID of the socket in the form of `/tmp/foo-wm-pid.socket`.
     14 
     15 `foo-wm-c`: This is a simple and dumb command line client for interacting with `foo-wm`. `foo-wm-c` takes the syntax of `foo-wm-c '/tmp/your-foo-socket.socket' 'ipc command'`. Any language that provides a UNIX socket interface can be used to communicate with `foo-wm`, `foo-wm-c` is just a simple C client for doing so. Additionally a ruby client for interacting with `foo-wm`'s socket can be found at `scrips/client.rb`
     16 
     17 The Tree
     18 --------
     19 All operations in `foo-wm` are related to manipulating and the traversal of the tree.  All nodes within the tree are one of two types.
     20 
     21 1. **Client** Nodes
     22 	- Just a single  X11 Window
     23 2. **Container** Nodes
     24     - Holds one or more other **Client** or **Container** Nodes
     25     - Has a *Layout* property which may be changed with the *layout* IPC command
     26 
     27 At any given time using `foo-wm` there are three essential nodes within the tree at play:
     28 
     29 1. **Root** Node
     30     - The top of the tree
     31     - Issuing a zoom command with a negative delta approximates this node
     32 2. **Focus** Node
     33     - The node which is currently manipulated on by using IPC commands
     34     - Issuing a zoom command with a positive delta approximates  this node
     35 3. **View** Node
     36     - The node which the screen is currently viewing
     37 
     38 
     39 The FOO-DSL and the Zooming Nature
     40 ---------------------------
     41 Now that you understand that all foo-wm does is maintain a tree of windows, now you'll want to know how to mainuplate the windows in the tree. For this, you simply send commands to foo-wm in the specifications provided in `FOO-DSL.md`. 
     42 
     43 For example, sending the zoom command through the provided command line client. 
     44 `foo-wm-c '/tmp/foo-wm.socket' 'zoom 2'`
     45 
     46 
     47 Inspiration
     48 -----------
     49 Inspirations include: 
     50 DWM, monsterwm, catwm, dminiwm, i3, herbstluftwm, wmii, and tinywm
     51 
     52 Contributing
     53 ------------
     54 Foo Window Manager is very much open to contribution. Please get in touch via email if you are interested or just take a stab at something in `TODO.md` and send a pull request.