Unofficial mirror of https://github.com/xmonad/xmonad
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Peter Simons bb13853929 Bump version number, update changelog, and re-generate the man page. 1 year ago
.github Add CONTRIBUTING.md and GitHub templates 2 years ago
man Bump version number, update changelog, and re-generate the man page. 1 year ago
src `XMonad.Operations` 1 year ago
tests typo fix in delete test comment: identiy -> identity 1 year ago
util GenerateManpage: fix compiler warnings 1 year ago
.gitignore git: ignore "cabal new-build"-style artifacts 1 year ago
.travis.yml Don't build generatemanpage with ghc 8.6.x yet: we're lacking pandoc. 1 year ago
CHANGES.md Bump version number, update changelog, and re-generate the man page. 1 year ago
CONFIG Update CONFIG instructions: defaultConfig -> def 4 years ago
CONTRIBUTING.md Add a section on rebashing and squashing 2 years ago
LICENSE clarify copyright 12 years ago
MAINTAINERS.md Update documentation after final release review 2 years ago
Main.hs Make ~/.xmonad/xmonad-$arch-$os handle args like /usr/bin/xmonad 4 years ago
README.md Update Debian packages in README 1 year ago
STYLE minor update to STYLE and TODO 4 years ago
Setup.lhs Initial import. 12 years ago
cabal.project Update documentation after final release review 2 years ago
stack.yaml Add a `stack.yaml` file for testing and easy Hackage upload 2 years ago
xmonad.cabal Bump version number, update changelog, and re-generate the man page. 1 year ago

README.md

xmonad: A Tiling Window Manager

Build Status

xmonad is a tiling window manager for X. Windows are arranged automatically to tile the screen without gaps or overlap, maximising screen use. Window manager features are accessible from the keyboard: a mouse is optional. xmonad is written, configured and extensible in Haskell. Custom layout algorithms, key bindings and other extensions may be written by the user in config files. Layouts are applied dynamically, and different layouts may be used on each workspace. Xinerama is fully supported, allowing windows to be tiled on several physical screens.

Quick Start

For the full story, read on.

Building

Building is quite straightforward, and requires a basic Haskell toolchain. On many systems xmonad is available as a binary package in your package system (e.g. on Debian or Gentoo). If at all possible, use this in preference to a source build, as the dependency resolution will be simpler.

We’ll now walk through the complete list of toolchain dependencies.

  • GHC: the Glasgow Haskell Compiler

    You first need a Haskell compiler. Your distribution’s package system will have binaries of GHC (the Glasgow Haskell Compiler), the compiler we use, so install that first. If your operating system’s package system doesn’t provide a binary version of GHC and the cabal-install tool, you can install both using the Haskell Platform.

    It shouldn’t be necessary to compile GHC from source -- every common system has a pre-build binary version. However, if you want to build from source, the following links will be helpful:

  • X11 libraries:

    Since you’re building an X application, you’ll need the C X11 library headers. On many platforms, these come pre-installed. For others, such as Debian, you can get them from your package manager:

    # for xmonad
    $ apt-get install libx11-dev libxinerama-dev libxext-dev libxrandr-dev libxss-dev
    
    # for xmonad-contrib
    $ apt-get install libxft-dev
    

Then build and install with:

$ cabal install

Running xmonad

If you built XMonad using cabal then add:

exec $HOME/.cabal/bin/xmonad

to the last line of your .xsession or .xinitrc file.

Configuring

See the CONFIG document and the example configuration file.

XMonadContrib

There are many extensions to xmonad available in the XMonadContrib (xmc) library. Examples include an ion3-like tabbed layout, a prompt/program launcher, and various other useful modules. XMonadContrib is available at:

Other Useful Programs

A nicer xterm replacement, that supports resizing better:

For custom status bars:

For a program dispatch menu:

Authors

  • Spencer Janssen
  • Don Stewart
  • Jason Creighton