xmonad: A tiling window manager

[ bsd3, program, system ] [ Propose Tags ]

xmonad is a tiling window manager for X. Windows are arranged automatically to tile the screen without gaps or overlap, maximising screen use. All features of the window manager are accessible from the keyboard: a mouse is strictly optional. xmonad is written and extensible in Haskell. Custom layout algorithms, 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 screens.


[Skip to Readme]
Versions 0.1, 0.2, 0.3, 0.4, 0.4.1, 0.5, 0.6, 0.7, 0.8, 0.8.1, 0.9, 0.9.1, 0.9.2, 0.10, 0.11, 0.11.1, 0.12, 0.13, 0.14, 0.14.1, 0.14.2, 0.15 (info)
Change log CHANGES.md
Dependencies base (>=4.9 && <5), containers, data-default, directory, extensible-exceptions, filepath, mtl, process, setlocale, unix, utf8-string (>=0.3 && <1.1), X11 (>=1.8 && <1.10), xmonad [details]
License BSD-3-Clause
Author Spencer Janssen, Don Stewart, Adam Vogt, David Roundy, Jason Creighton, Brent Yorgey, Peter Jones, Peter Simons, Andrea Rossato, Devin Mullins, Lukas Mai, Alec Berryman, Stefan O'Rear, Daniel Wagner, Peter J. Jones, Daniel Schoepe, Karsten Schoelzel, Neil Mitchell, Joachim Breitner, Peter De Wachter, Eric Mertens, Geoff Reedy, Michiel Derhaeg, Philipp Balzarek, Valery V. Vorotyntsev, Alex Tarkovsky, Fabian Beuke, Felix Hirn, Michael Sloan, Tomas Janousek, Vanessa McHale, Nicolas Pouillard, Aaron Denney, Austin Seipp, Benno Fünfstück, Brandon S Allbery, Chris Mears, Christian Thiemann, Clint Adams, Daniel Neri, David Lazar, Ferenc Wagner, Francesco Ariis, Gábor Lipták, Ivan N. Veselov, Ivan Tarasov, Javran Cheng, Jens Petersen, Joey Hess, Jonne Ransijn, Josh Holland, Khudyakov Alexey, Klaus Weidner, Michael G. Sloan, Mikkel Christiansen, Nicolas Dudebout, Ondřej Súkup, Paul Hebble, Shachaf Ben-Kiki, Siim Põder, Tim McIver, Trevor Elliott, Wouter Swierstra, Conrad Irwin, Tim Thelion
Maintainer xmonad@haskell.org
Category System
Home page http://xmonad.org
Bug tracker https://github.com/xmonad/xmonad/issues
Source repo head: git clone https://github.com/xmonad/xmonad
Uploaded by PeterSimons at Sun Sep 30 12:17:10 UTC 2018
Distributions Arch:0.15, Debian:0.14.2, Fedora:0.13, FreeBSD:0.11.1, NixOS:0.15, Stackage:0.15, openSUSE:0.15
Executables generatemanpage, xmonad
Downloads 27999 total (267 in the last 30 days)
Rating 2.5 (votes: 4) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-09-30 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
testing

Testing mode, only build minimal components

DisabledManual
generatemanpage

Build the tool for generating the man page

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for xmonad-0.15

[back to package description]

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