l-warden / xwm Goto Github PK

xwm - a tiny XCB floating window manager

FEATURES
========

*   Few features (just works)
*   Extensible & configurable
*   Focus follows mouse

BUILD REQUIREMENTS
==================

xcb-util-keysyms, along with any default or user defined utilities:

    application launcher   https://git.suckless.org/dmenu
    terminal emulator      https://git.suckless.org/st
    internet browser       https://git.suckless.org/surf

COMMANDS
========

Default keys and behavior can be customized via the config.h file:

    Win+Button1+[drag]     interactive window move
    Win+Button3+[drag]     interactive window resize
    Win+Space              run launcher menu (default: dmenu_run)
    Win+Enter              create new terminal window (default: st)
    Win+b                  create new browser window (default: surf)
    Win+q                  kill focused window
    Win+Shift+q            quit window manager

INSTALL
=======

Building and installing from source:
    git clone https://github.com/mcpcpc/xwm
    cd xwm
    make
    sudo make install

Building and installing on KISS Linux:
    kiss b xwm
    kiss i xwm

Build and install from Arch Linux AUR:
    git clone https://aur.archlinux.org/xwm.git
    cd kirc
    makepkg -si

PATCHES
=======

For additional features, I have provided a respository for sharing
and hosting user created patches:
    http://github.com/mcpcpc/xwm-patches

EXAMPLES
========

Check your xwm installed version:
    xwm -v

Usimg startx to run xwm:
    echo "exec xwm" > ~/.xinitrc
    startx

Using imagemagick to set a wallpaper:
    display -window root background.png

Patching xwm:
    patch -p0 < mypatch.patch

DISCLAIMER
==========

xwm ("XCB Window Manager") is an homage to the original and 
now-defunct "X Window Manager". Both projects are unaffiliated 
and do not share any common source code.

CONTACT
=======

For questions or issues, please contact info[at]mcpcpc[dot]com.