Go to file
Julien Danjou 62ec664d0f config.h: always compile with Imlib2, so remove define
Signed-off-by: Julien Danjou <julien@danjou.info>
2009-04-17 16:34:00 +02:00
build-utils layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
common xutil: fix proto 2009-04-15 14:43:59 +02:00
icons themes: move theme icons to themes/ 2008-11-10 12:02:08 +01:00
lib client: changing size hints does not arrange() 2009-04-17 11:43:56 +02:00
manpages build: move manpages into their own directory 2009-04-11 16:11:43 +02:00
themes awful.titlebar: more buttons added 2009-04-12 14:24:50 +02:00
utils import new awesome-client using D-Bus 2009-04-08 17:30:18 +02:00
widgets screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
AUTHORS update AUTHORS 2009-04-08 19:01:20 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt root: split out of luaa 2009-04-17 11:50:20 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile awesome-client: remove socket code 2009-04-08 17:56:25 +02:00
PATCHES update STYLE, add PATCHES 2008-08-30 13:09:15 +02:00
README build: set minimum pango version required 2008-12-29 10:16:11 +01:00
STYLE STYLE: add missing semi colon 2008-11-12 14:27:42 +01:00
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.c awesome: use xcb_event error code 2009-04-15 12:01:55 +02:00
awesome.desktop desktop: change description 2008-10-02 17:19:28 +02:00
awesome.doxygen.in layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
awesome.h factorize quit/exec elements, and reparent systray 2008-09-02 17:12:10 +02:00
awesomeConfig.cmake awesome: use xcb_event error code 2009-04-15 12:01:55 +02:00
awesomerc.lua.in awful.{key,button}: return a table 2009-04-17 11:13:22 +02:00
client.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
client.h client: move struct definition to client.h 2009-04-17 16:27:00 +02:00
cnode.c comments fixing 2008-06-20 08:38:00 +02:00
cnode.h cnode: move struct to cnode header 2008-10-24 20:40:02 +02:00
config.h.in config.h: always compile with Imlib2, so remove define 2009-04-17 16:34:00 +02:00
dbus.c Remove the argument to awesome_refresh() 2009-04-10 18:02:49 +02:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
draw.c Move the definition of globalconf into a header file 2009-04-10 16:32:42 +02:00
draw.h Change xcolor_t::initialized into a bool 2009-04-15 12:01:41 +02:00
event.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
event.h client_stack(): Only stack windows once per mainloop 2009-04-10 18:15:48 +02:00
ewmh.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
ewmh.h image: use new object system 2009-04-12 15:11:32 +02:00
hooks.c spawn: add support for startup-notification 2009-04-14 14:23:38 +02:00
image.c image: export drawing routines to lua 2009-04-16 18:46:54 +02:00
image.h image: use new object system 2009-04-12 15:11:32 +02:00
key.c key: add support for modifier mask Any 2009-04-15 14:43:58 +02:00
key.h key: cleanup modifiers system 2009-04-15 12:01:54 +02:00
keygrabber.c key: stop ignoring arbitrary modifier 2009-04-15 12:01:55 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
layout.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
layout.h layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
luaa.c struct: move void_array definition to luaa 2009-04-17 16:27:16 +02:00
luaa.h screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
mouse.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
mouse.h button: use new Lua object system 2009-04-12 15:11:33 +02:00
mousegrabber.c Move the definition of globalconf into a header file 2009-04-10 16:32:42 +02:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
property.h client: store class and instance 2009-04-04 13:54:51 +02:00
root.c root: split out of luaa 2009-04-17 11:50:20 +02:00
screen.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
screen.h wibox: move struct definition into wibox.h 2009-04-17 16:25:14 +02:00
selection.c Remove the argument to awesome_refresh() 2009-04-10 18:02:49 +02:00
selection.h selection: do not use a useless module 2009-01-06 17:02:08 +01:00
spawn.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
spawn.h spawn: add support for startup-notification 2009-04-14 14:23:38 +02:00
stack.c Move the definition of globalconf into a header file 2009-04-10 16:32:42 +02:00
stack.h stack: add stack_client_append() 2008-11-12 11:23:28 +01:00
structs.h struct: move void_array definition to luaa 2009-04-17 16:27:16 +02:00
swindow.c Move the definition of globalconf into a header file 2009-04-10 16:32:42 +02:00
swindow.h client, swindow: switch to a more convient definition of geometry 2008-12-14 10:28:24 +01:00
systray.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
tag.h tag: move struct definition into tag.h 2009-04-17 16:27:16 +02:00
titlebar.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
titlebar.h screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
wibox.c screen: replace screens pointer by a screen_t array 2009-04-17 16:14:09 +02:00
wibox.h wibox: move struct definition into wibox.h 2009-04-17 16:25:14 +02:00
widget.c client: move struct definition to client.h 2009-04-17 16:27:00 +02:00
widget.h widget: move definition into widget.h 2009-04-17 16:25:13 +02:00
window.c key: stop ignoring arbitrary modifier 2009-04-15 12:01:55 +02:00
window.h client: move window function into window.c 2009-04-07 15:58:09 +02:00

README

awesome
=======
awesome is a highly configurable, next generation framework window manager for X.

Requirements
------------
In order to build awesome itself, you need header files and libs of:
  - cmake (>= 2.6)
  - Xlib
  - xproto
  - xcb (>= 1.1)
  - xcb-util (>= 0.3)
  - Lua (>= 5.1)
  - cairo built with xcb support
  - pango and pangocairo (>= 1.19.3)
  - libev
  - Imlib2
  - 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:

  make

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

Running awesome
---------------
You can directly select awesome from your display manager. If not, you can
add the following line to your .xinitrc to start awesome using startx
or to .xsession to start awesome using your display manager:

    exec awesome

In order to connect awesome to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:

    DISPLAY=foo.bar:1 exec awesome

(This will start awesome on display :1 of the host foo.bar.)

Configuration
-------------
The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
An example is provided in the sources.

Troubleshooting
---------------
In most systems any message printed by awesome (including warnings and errors)
are written to $HOME/.xsession-errors.

If awesome does not start or the configuration file is not producing the desired
results the user should examine this file to gain insight into the problem.