awesome/README

60 lines
1.4 KiB
Plaintext
Raw Normal View History

2007-09-12 14:29:51 +02:00
awesome
=======
2007-09-10 12:06:54 +02:00
awesome is an extremely fast, small, and dynamic window manager for X.
2007-09-05 20:15:00 +02:00
Requirements
------------
In order to build awesome itself, you need header files and libs of:
- cmake
- Xlib, xcb and xcb-util
- Lua 5.1
- cairo
- pango and pangocairo
- libev
- glib
2008-07-18 22:26:23 +02:00
- GdkPixBuf or Imlib2 (use -DWITH_IMLIB2=ON with cmake)
- dbus (optional, use -DWITH_DBUS=OFF with cmake to disable)
- gperf
In order to build the awesome man pages and documentation,
you need these tools:
- asciidoc
- xmlto
- docbook XSL stylesheets
- luadoc
In order to build the source code reference, you need these tools:
- doxygen
- graphviz
Building and Installation
-------------------------
After extracting the dist tarball, run:
2007-09-05 20:15:00 +02:00
2008-01-04 20:49:49 +01:00
make
2007-09-05 20:15:00 +02:00
This will create a build directory, run cmake in it and build awesome.
After the building done, you can type this to install:
make install # might need root permissions
2007-09-10 12:06:54 +02:00
Running awesome
2007-09-05 20:15:00 +02:00
-----------
2007-09-10 12:06:54 +02:00
Add the following line to your .xinitrc to start awesome using startx
or to .xsession to start awesome using gdm/kdm/xdm...:
2007-09-05 20:15:00 +02:00
2007-09-10 12:06:54 +02:00
exec awesome
2007-09-05 20:15:00 +02:00
2007-09-10 12:06:54 +02:00
In order to connect awesome to a specific display, make sure that
2007-09-05 20:15:00 +02:00
the DISPLAY environment variable is set correctly, e.g.:
2007-09-10 12:06:54 +02:00
DISPLAY=foo.bar:1 exec awesome
2007-09-05 20:15:00 +02:00
2007-09-10 12:06:54 +02:00
(This will start awesome on display :1 of the host foo.bar.)
2007-09-05 20:15:00 +02:00
Configuration
-------------
The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
2007-09-12 14:29:51 +02:00
An example is provided in the sources.