documentation.md

---

---

Documentation

The essentials

• install xmonad – how to install xmonad
• configuration tutorial – guide to configuring xmonad
• Hackage documentation:
  • xmonad (last release)
  • xmonad-contrib (last release)
  • xmonad, xmonad-contrib, X11 (nightly snapshot)

Getting started

• about – an overview of xmonad features
• install xmonad – how to install xmonad
• guided tour – a walkthrough of the basic functionality
• configuration tutorial – guide to configuring xmonad
• cheatsheet – an overview of the keybindings

Reference

• manpage – a reference of the default keybindings
• configuring – how to write a config file
• xmonad api docs – reference documentation for xmonad's core API
• the (old) FAQ
• the (old) wiki

Extensions

• user configurations – a sample of user config files, showing off many of the extensions
• extending – a more advanced configuration tutorial
• xmonad-contrib api docs – reference documentation for all of xmonad's contrib modules
• development tutorial – learn to write your own extension

In your environment

Installing xmonad - Gnome - KDE - XFCE - Arch Linux - OS X - OLPC

Quick start for the impatient

1. Install the xmonad binary/library and the xmonad-contrib library.
2. Wire xmonad up to your login manager.
3. Logout and back in. You're in xmonad.
4. M-S-<Enter> to open an xterm.
5. Write a ~/.config/xmonad/xmonad.hs to configure xmonad.
6. M-q to reload your config file.