Go to file
Julien Danjou f3e12dbe52 screen: add .index property
Signed-off-by: Julien Danjou <julien@danjou.info>
2009-08-21 15:30:47 +02:00
build-utils removed WidgetList, name_func_link_t and related function 2009-06-17 16:22:42 +02:00
common screen: add .index property 2009-08-21 15:30:47 +02:00
icons themes: move theme icons to themes/ 2008-11-10 12:02:08 +01:00
lib client: emit signal on list changes 2009-08-21 15:30:47 +02:00
manpages manpages: fix awesome-client to talk about D-Bus 2009-04-27 15:09:42 +02:00
themes themes/sky: Titlebar icons: use current default theme paths 2009-05-20 07:43:15 +02:00
utils awful: split D-Bus name from awesome 2009-06-15 20:52:40 +02:00
widgets luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
AUTHORS Update AUTHORS file 2009-06-17 17:03:17 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt timer: import 2009-08-17 17:49:06 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile build: allow to specify cmake args 2009-05-08 19:54:38 +02:00
PATCHES update STYLE, add PATCHES 2008-08-30 13:09:15 +02:00
README themes: Generate unfocused/inactive icons automatically 2009-05-18 08:30:21 +02: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 Revert "button, key: grab all keys by default, and check for match." 2009-08-14 17:52:49 +02:00
awesome.desktop desktop: change description 2008-10-02 17:19:28 +02:00
awesome.doxygen.in Fix doxygen generation warnings. 2009-07-27 11:18:43 +02:00
awesome.h factorize quit/exec elements, and reparent systray 2008-09-02 17:12:10 +02:00
awesomeConfig.cmake Add a lua api for setting a wibox' shape 2009-07-27 14:23:59 +02:00
awesomerc.lua.in client: emit signal on manage 2009-08-21 15:30:47 +02:00
banning.c client: active BMA when moving windows 2009-08-03 15:57:10 +02:00
banning.h layout: rename to banning 2009-06-10 11:42:43 +02:00
button.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
button.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
client.c client: emit signal on list changes 2009-08-21 15:30:47 +02:00
client.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
color.c color: do not take pointer to push 2009-08-17 17:46:35 +02:00
color.h color: do not take pointer to push 2009-08-17 17:46:35 +02:00
config.h.in build: detect endianness at compile time 2009-04-27 12:06:24 +02:00
dbus.c dbus: move to signal 2009-07-29 16:10:29 +02:00
dbus.h dbus: allow usage of the system bus 2009-04-18 16:07:31 +02:00
draw.c draw: remove useless AlignFixed 2009-08-04 14:35:20 +02:00
draw.h draw: remove useless AlignFixed 2009-08-04 14:35:20 +02:00
event.c widget: emit signals on mouse enter and leave 2009-08-21 15:30:47 +02:00
event.h layout: rename to banning 2009-06-10 11:42:43 +02:00
ewmh.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
ewmh.h image: use new object system 2009-04-12 15:11:32 +02:00
hooks.c spawn: move sn hooks to signals 2009-08-17 17:47:55 +02:00
image.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
image.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
key.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
key.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
keygrabber.c key: looking up for a key use a keysym 2009-04-29 10:53:50 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
luaa.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
luaa.h luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
mouse.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
mouse.h mouse: split button out 2009-04-26 10:46:09 +02:00
mousegrabber.c Fix doxygen generation warnings. 2009-07-27 11:18:43 +02:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
property.h client: store WM_WINDOW_ROLE 2009-08-10 11:53:45 +02:00
root.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
screen.c screen: add .index property 2009-08-21 15:30:47 +02:00
screen.h screen: add signals support 2009-08-21 15:30:47 +02:00
selection.c cleanup #includes 2009-04-17 16:52:25 +02:00
selection.h selection: do not use a useless module 2009-01-06 17:02:08 +01:00
spawn.c spawn: move sn hooks to signals 2009-08-17 17:47:55 +02:00
spawn.h cleanup #includes 2009-04-17 16:52:25 +02:00
stack.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
stack.h luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
structs.h spawn: move sn hooks to signals 2009-08-17 17:47:55 +02:00
systray.c Fix doxygen generation warnings. 2009-07-27 11:18:43 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c tag: emit screen signals when attaching and detaching tags 2009-08-21 15:30:47 +02:00
tag.h tag: port to new object system 2009-08-21 15:30:47 +02:00
timer.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
timer.h timer: import 2009-08-17 17:49:06 +02:00
titlebar.c luaobject: remove useless custom function 2009-08-21 15:30:46 +02:00
titlebar.h wibox: get rid of simple window 2009-07-28 16:11:41 +02:00
wibox.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
wibox.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
widget.c luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
widget.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
window.c button: use new object system 2009-08-21 15:30:46 +02:00
window.h Revert "button, key: grab all keys by default, and check for match." 2009-08-14 17:52:49 +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

As well as the following tools to build theme icons:
  - ImageMagick

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.