README

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