A titling keyboard driven window manager written in Common Lisp
Common Lisp Other
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contrib
.gitattributes
.gitignore
AUTHORS
COPYING
HACKING
Makefile.in
NEWS
README
asdf.lisp
autogen.sh
bindings.lisp
color.lisp
command.lisp
configure.ac
core.lisp
events.lisp
fdump.lisp
floating-group.lisp
group.lisp
help.lisp
input.lisp
iresize.lisp
keysyms.lisp
keytrans.lisp
kmap.lisp
make-image.lisp.in
manual.lisp
menu.lisp
message-window.lisp
mode-line-cubes.lisp
mode-line.lisp
module.lisp
package.lisp
primitives.lisp
sample-stumpwmrc.lisp
screen.lisp
selection.lisp
stumpwm.asd
stumpwm.lisp
stumpwm.texi.in
test-wm.lisp
tile-group.lisp
tile-window.lisp
time.lisp
user.lisp
version.lisp.in
window-placement.lisp
window.lisp
workarounds.lisp
wrappers.lisp

README

The Stump Window Manager
------------------------

Stumpwm is a window manager written entirely in Common Lisp. It
attempts to be highly customizable while relying entirely on the
keyboard for input. You will not find buttons, icons, title bars, tool
bars, or any of the other conventional GUI widgets. 

These design decisions reflect the growing popularity of productive,
customizable lisp based systems.

Build & Start Stumpwm
---------------------

Prerequisites
=============

* a common lisp distribution. clisp and SBCL both work.
* clx
* cl-ppcre

If you intend to use sbcl you need to install portable-clx. If you're
using clisp, make sure you use at least version 2.42 and that clisp is
compiled with new-clx. As of clisp 2.42, new-clx works fine with
stumpwm. Any version before that is too buggy to run stumpwm.

You can use asdf-install to install lisp libraries:
  $ sbcl
    * (require 'asdf)
    * (require 'asdf-install)
    * (asdf-install:install 'clx)
    * (asdf-install:install 'cl-ppcre)

If using clisp, you'll need to install asdf first to use asdf-install.
  $ mkdir -p ~/.cl/asdf && cd ~/.cl
  $ wget http://cclan.cvs.sourceforge.net/*checkout*/cclan/asdf/asdf.lisp -O ~/.cl/asdf/asdf.lisp
  $ echo "(load #p\"/home/USER/.cl/asdf/asdf\")" >> ~/.clisprc.lisp
  $ mkdir -p ~/.cl/systems
  $ echo "(push #p\"/home/USER/.cl/systems\" asdf:*central-registry*)" >> ~/.clisprc.lisp
  $ wget http://common-lisp.net/project/asdf-install/asdf-install_latest.tar.gz
  $ tar xf asdf-install_latest.tar.gz
  $ ln -s ~/.cl/asdf-install/asdf-install/asdf-install.asd ~/.cl/systems/
  $ clisp
    * (asdf:operate 'asdf:compile-op 'asdf-install)
    * (asdf:operate 'asdf:load-op 'asdf-install)
    * (asdf-install:install :cl-ppcre)

Your operating system distribution may also have these libraries
available.

Building
========

Building stumpwm from CVS requires that you build the configure script:

$ autoconf

If there's already a configure script then just run it.

$ ./configure

By default stumpwm elects sbcl. If you have both installed, you can
explicitly select clisp like so:

$ ./configure --with-lisp=clisp

If your lisps are in strange places you may need to tell the script where to find them:

$ configure --with-sbcl=/home/sabetts/opt/bin/sbcl --with-clisp=/usr/local/downstairs/to/the/left/clisp

Now build it:

$ make

If all goes well, you should have a stumpwm binary now. Sorry there's
no install yet. Just copy the binary wherever you want or run it out
of the stumpwm/ directory.

Now that you have a binary, call it from your ~/.xinitrc file:

$ echo /path/to/stumpwm >> ~/.xinitrc
$ startx

Hopefully that will put you in X running stumpwm!

SBCL And Threads
----------------

SBCL compiled with threads causes problems with stumpwm. The most
common is sluggishness. It may also cause stumpwm to become
unresponsive. If you use SBCL, consider using a version built without
threads.

Help
----

There's a texinfo manual, stumpwm.texi. the build scripts generate an
info file you can read in emacs or with the `info' program.

For other stuff visit the stumpwm wiki: 

http://stumpwm.antidesktop.net/

There's a #stumpwm channel on irc.freenode.net, too.

Questions?
----------

See http://stumpwm.nongnu.org/community.html for more information on
contacting stumpwm developers and users.