Go to file
Julien Danjou 4918614d44 draw: do not include xutil.h
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-12-14 10:28:23 +01:00
build-utils layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
common xutil: remove useless define 2008-12-14 10:28:22 +01:00
icons themes: move theme icons to themes/ 2008-11-10 12:02:08 +01:00
lib beautiful: simplify metatable setting 2008-12-14 10:28:22 +01:00
themes layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
utils awsetbg: add solid xsetroot fallback if no real wpsetters 2008-12-01 19:37:03 +01:00
widgets draw: remove border markup, move it to textbox 2008-12-14 10:28:23 +01:00
.gitignore gitignore: add binaries 2008-09-22 10:37:07 +02:00
AUTHORS AUTHORS: add D. Leone, G. Best and koniu 2008-11-13 14:54:35 +01:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile build: do not do build link if it exists 2008-09-29 16:21:36 +02:00
PATCHES update STYLE, add PATCHES 2008-08-30 13:09:15 +02:00
README doc: change description in README 2008-10-02 17:20:08 +02:00
STYLE STYLE: add missing semi colon 2008-11-12 14:27:42 +01:00
awesome-client.1.txt Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
awesome-client.c socket: fix proto not supported under FreeBSD (FS#349) 2008-11-03 14:53:23 +01:00
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.1.txt awesome.1: add missing key bindings 2008-11-17 20:45:18 +01:00
awesome.c xembed: store windows in an array 2008-12-14 10:28:22 +01: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 change codename 2008-12-12 16:33:23 +01:00
awesomerc.5.txt draw: remove border markup, move it to textbox 2008-12-14 10:28:23 +01:00
awesomerc.lua.in client: move floating state handling to Lua 2008-12-14 10:28:22 +01:00
awsetbg.1.txt awsetbg: add manpage 2008-11-21 11:43:36 +01:00
client.c client: Use window groups to improve initial tag placement. 2008-12-14 10:28:22 +01:00
client.h client: include list 2008-12-14 10:28:23 +01: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 Fix default search path for configurations 2008-07-24 20:10:13 +02:00
dbus.c dbus: add match bindings 2008-12-12 19:19:29 +01:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
draw.c draw: remove border markup, move it to textbox 2008-12-14 10:28:23 +01:00
draw.h draw: do not include xutil.h 2008-12-14 10:28:23 +01:00
event.c xembed: store windows in an array 2008-12-14 10:28:22 +01:00
event.h wibox: wibox_refresh merge statusbar and titlebar 2008-09-22 11:11:56 +02:00
ewmh.c ewmh: fix buffer.h inclusion 2008-12-14 10:28:23 +01:00
ewmh.h ewmh: update window hints 2008-09-22 11:11:55 +02:00
hooks.c client: add mouse_leave hook 2008-12-14 10:28:22 +01:00
image.c image: check image width and height 2008-11-09 15:54:21 +01:00
image.h image: add function to create from argb32 data 2008-09-22 11:11:55 +02:00
keybinding.c event: regrab keys on keyboard mapping change (FS#365) 2008-10-31 19:22:24 +01:00
keybinding.h event: regrab keys on keyboard mapping change (FS#365) 2008-10-31 19:22:24 +01:00
keygrabber.c keygrabber: remove duplicate case (FS#386) 2008-11-24 11:24:19 +01:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
layout.c layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
layout.h layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
luaa.c client: add mouse_leave hook 2008-12-14 10:28:22 +01:00
luaa.h luaa: rename luaA_deprecate() 2008-12-12 16:51:41 +01:00
mouse.c layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
mouse.h mouse: move resize code to awful.mouse 2008-12-12 16:51:41 +01:00
mousegrabber.c mousegrabber: import 2008-12-12 16:51:41 +01:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c client: Expose leader_id. 2008-12-14 10:28:22 +01:00
property.h client: Expose leader_id. 2008-12-14 10:28:22 +01:00
screen.c client: move floating state handling to Lua 2008-12-14 10:28:22 +01:00
screen.h wibox: merge statusbar and titlebar types 2008-09-22 11:11:56 +02:00
stack.c stack: add stack_client_append() 2008-11-12 11:23:28 +01:00
stack.h stack: add stack_client_append() 2008-11-12 11:23:28 +01:00
structs.h client: Expose leader_id. 2008-12-14 10:28:22 +01:00
swindow.c swindow: add cursor_set() 2008-12-12 16:51:41 +01:00
swindow.h swindow: add cursor_set() 2008-12-12 16:51:41 +01:00
systray.c xembed: store windows in an array 2008-12-14 10:28:22 +01:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
tag.h layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
titlebar.c layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
titlebar.h layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
wibox.c xembed: store windows in an array 2008-12-14 10:28:22 +01:00
wibox.h remove a bunch of useless #include-s 2008-10-24 20:57:29 +02:00
widget.c util: precompute funcname in name_func_link 2008-12-12 16:51:41 +01:00
widget.h widget: change widget initialization code 2008-12-12 16:51:41 +01:00
window.c mouse: move declaration from structs to mouse header 2008-10-24 20:38:29 +02:00
window.h mouse: rework mouse buttons API, support release events 2008-09-22 11:11:53 +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
  - libev
  - glib
  - 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.