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