Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
The Stump Window Manager
branch: master

This branch is 326 commits behind stumpwm:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
contrib
.dir-locals.el
.gitattributes
.gitignore
AUTHORS
COPYING
HACKING
Makefile.in
NEWS
README
autogen.sh
bindings.lisp
color.lisp
command.lisp
configure.ac
core.lisp
events.lisp
fdump.lisp
floating-group.lisp
group.lisp
head.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.lisp
module.lisp
package.lisp
pathnames.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
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.  sbcl, clisp, ccl and ecl all work.
* asdf
* clx
* cl-ppcre

The recommended way to install the dependencies is using Quicklisp.
Follow the instructions at http://www.quicklisp.org/ to install it.
Make sure you have added it to your lisp init file using:

 (ql:add-to-init-file)

Then, in a repl:

 (ql:quickload "clx")
 (ql:quickload "cl-ppcre")

Building
========

Building stumpwm from git 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 multiple lisps installed,
you can explicitly select clisp, ccl, or ecl 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
 ./configure --with-clisp=/usr/local/downstairs/to/the/left/clisp

Now build it:

 make

If all goes well, you should have a stumpwm binary now.  You can run
the binary from where it is or install it, along with the .info
documentation, with:

 make install

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!

CCL And Virtual Memory
----------------------

On 64bit platforms, CCL reserves a "very large" amount of virtual
memory. If this bothers you for some reason, you can pass the -R or
--heap-reserve option to the binary in your ~/.xinitrc file. See
http://ccl.clozure.com/manual/chapter15.1.html for an explanation.

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.  The
manual for the latest release is available to read online at:

http://www.nongnu.org/stumpwm/manual/stumpwm.html

For other stuff visit the stumpwm wiki:

https://github.com/sabetts/stumpwm/wiki

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

See http://stumpwm.nongnu.org/community.html for more information on
contacting stumpwm developers and users.
Something went wrong with that request. Please try again.