README

   1 awesome
   2 =======
   3 awesome is a highly configurable, next generation framework window manager for X.
   4
   5 Requirements
   6 ------------
   7 In order to build awesome itself, you need header files and libs of:
   8   - cmake (>= 2.6)
   9   - Xlib
  10   - xproto
  11   - xcb (>= 1.1)
  12   - xcb-util (>= 0.3)
  13   - Lua (>= 5.1)
  14   - cairo built with xcb support
  15   - pango and pangocairo (>= 1.19.3)
  16   - libev
  17   - Imlib2
  18   - dbus (optional, use -DWITH_DBUS=OFF with cmake to disable)
  19   - gperf
  20
  21 In order to build the awesome man pages and documentation,
  22 you need these tools:
  23   - asciidoc
  24   - xmlto
  25   - docbook XSL stylesheets
  26   - luadoc
  27
  28 In order to build the source code reference, you need these tools:
  29   - doxygen
  30   - graphviz
  31
  32 Building and installation
  33 -------------------------
  34 After extracting the dist tarball, run:
  35
  36   make
  37
  38 This will create a build directory, run cmake in it and build awesome.
  39
  40 After the building done, you can type this to install:
  41
  42   make install # might need root permissions
  43
  44 Running awesome
  45 ---------------
  46 You can directly select awesome from your display manager. If not, you can
  47 add the following line to your .xinitrc to start awesome using startx
  48 or to .xsession to start awesome using your display manager:
  49
  50     exec awesome
  51
  52 In order to connect awesome to a specific display, make sure that
  53 the DISPLAY environment variable is set correctly, e.g.:
  54
  55     DISPLAY=foo.bar:1 exec awesome
  56
  57 (This will start awesome on display :1 of the host foo.bar.)
  58
  59 Configuration
  60 -------------
  61 The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
  62 An example is provided in the sources.
  63
  64 Troubleshooting
  65 ---------------
  66 In most systems any message printed by awesome (including warnings and errors)
  67 are written to $HOME/.xsession-errors.
  68
  69 If awesome does not start or the configuration file is not producing the desired
  70 results the user should examine this file to gain insight into the problem.