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