README

   1 awesome
   2 =======
   3 awesome is an extremely fast, small, and dynamic window manager for X.
   4 It's based on dwm.
   5
   6 Requirements
   7 ------------
   8 In order to build awesome itself, you need header files and libs of:
   9   - Xlib, Xinerama, Xrandr, Xft
  10   - libconfuse >= 2.6
  11   - cairo
  12
  13 In order to build the awesome man pages, you need these tools:
  14   - asciidoc (recent version)
  15   - xmlto (recent version)
  16   - docbook XSL stylesheets
  17
  18 In order to build the source code reference, you need these tools:
  19   - doxygen
  20   - graphviz
  21
  22 Building and Installation
  23 -------------------------
  24 If building from git sources, run "./autogen.sh". When autoreconf has
  25 finished, you can follow the following instructions for building a dist
  26 tarball.
  27
  28 After extracting the dist tarball, run "./configure --help" and figure out
  29 what you might want to adapt for your system. Then run ./configure with the
  30 proper parameters, and build and install:
  31
  32   ./configure [...]
  33   make
  34   make install # might need root permissions
  35
  36 If you're using gcc as your compiler and do not want awesome's default set
  37 of warning flags, add AWESOME_CFLAGS="" to your "make" lines.
  38
  39 The source code reference can be built with "make doc".
  40
  41 Running awesome
  42 -----------
  43 Add the following line to your .xinitrc to start awesome using startx
  44 or to .xsession to start awesome using gdm/kdm/xdm...:
  45
  46     exec awesome
  47
  48 In order to connect awesome to a specific display, make sure that
  49 the DISPLAY environment variable is set correctly, e.g.:
  50
  51     DISPLAY=foo.bar:1 exec awesome
  52
  53 (This will start awesome on display :1 of the host foo.bar.)
  54
  55 Configuration
  56 -------------
  57 The configuration of awesome is done by creating a ~/.awesomerc file.
  58 An example is provided in the sources.