Go to file
Julien Danjou 21e8c0c89e button: add support for AnyButton
Signed-off-by: Julien Danjou <julien@danjou.info>
2009-04-26 12:34:30 +02:00
build-utils atoms: drop useless strlen usage 2009-04-18 13:37:01 +02:00
common xutil: remove useless conversion function 2009-04-26 12:34:13 +02:00
icons themes: move theme icons to themes/ 2008-11-10 12:02:08 +01:00
lib Fix toggletag 2009-04-23 23:38:31 +02:00
manpages change default binding for run prompt to Mod4+r 2009-04-17 18:20:06 +02:00
themes awful.titlebar: more buttons added 2009-04-12 14:24:50 +02:00
utils awesome-client: Use rlwrap if it is available 2009-04-18 14:05:14 +02:00
widgets screen: remove index field 2009-04-18 17:51:31 +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 mouse: split button out 2009-04-26 10:46:09 +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 libxdg-basedir 1.0.0 compatibility 2009-04-18 18:51:04 +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 libxdg-basedir 1.0.0 compatibility 2009-04-18 18:51:04 +02:00
awesomerc.lua.in change default binding for run prompt to Mod4+r 2009-04-17 18:20:06 +02:00
button.c button: add support for AnyButton 2009-04-26 12:34:30 +02:00
button.h xutil: remove useless conversion function 2009-04-26 12:34:13 +02:00
client.c Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
client.h stack: remove client_node type and inverse order 2009-04-17 23:26:26 +02:00
color.c color: simplify includes 2009-04-18 14:02:21 +02:00
color.h color: simplify includes 2009-04-18 14:02:21 +02:00
config.h.in config.h: always compile with Imlib2, so remove define 2009-04-17 16:34:00 +02:00
dbus.c Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
dbus.h dbus: allow usage of the system bus 2009-04-18 16:07:31 +02:00
draw.c Make the draw_*() functions take a color_t* 2009-04-18 14:02:21 +02:00
draw.h Make the draw_*() functions take a color_t* 2009-04-18 14:02:21 +02:00
event.c button: add support for AnyButton 2009-04-26 12:34:30 +02:00
event.h cleanup #includes 2009-04-17 16:52:25 +02:00
ewmh.c stack: remove client_node type and inverse order 2009-04-17 23:26:26 +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 Make the image code use color instead of xcolor 2009-04-18 14:02:21 +02:00
image.h image: use new object system 2009-04-12 15:11:32 +02:00
key.c key: add __index metamethod 2009-04-25 16:00:08 +02:00
key.h cleanup #includes 2009-04-17 16:52:25 +02:00
keygrabber.c Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
layout.c screen: remove index field 2009-04-18 17:51:31 +02:00
layout.h layout: move layout code to Lua 2008-12-14 10:28:21 +01:00
luaa.c Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
luaa.h Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
mouse.c mouse: split button out 2009-04-26 10:46:09 +02:00
mouse.h mouse: split button out 2009-04-26 10:46:09 +02:00
mousegrabber.c mouse: split button out 2009-04-26 10:46:09 +02:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c property: fix bad deletion of reply (FS#502) 2009-04-21 08:46:48 +02:00
property.h property: make use of xcb_get_wm_class_from_reply() when possible 2009-04-18 14:20:06 +02:00
root.c mouse: split button out 2009-04-26 10:46:09 +02:00
screen.c Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
screen.h Focus stealing prevention - should fix FS#497 2009-04-23 23:40:46 +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 Replace lua_newtable() with lua_createtable() 2009-04-25 15:04:27 +02:00
spawn.h cleanup #includes 2009-04-17 16:52:25 +02:00
stack.c stack: remove client_node type and inverse order 2009-04-17 23:26:26 +02:00
stack.h stack: remove client_node type and inverse order 2009-04-17 23:26:26 +02:00
structs.h stack: remove client_node type and inverse order 2009-04-17 23:26:26 +02:00
swindow.c Move the definition of globalconf into a header file 2009-04-10 16:32:42 +02:00
swindow.h cleanup #includes 2009-04-17 16:52:25 +02:00
systray.c cleanup #includes 2009-04-17 16:52:25 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c screen: remove index field 2009-04-18 17:51:31 +02:00
tag.h cleanup #includes 2009-04-17 16:52:25 +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: remove index field 2009-04-18 17:51:31 +02:00
wibox.h wibox: move struct definition into wibox.h 2009-04-17 16:25:14 +02:00
widget.c Make the draw_*() functions take a color_t* 2009-04-18 14:02:21 +02:00
widget.h mouse: split button out 2009-04-26 10:46:09 +02:00
window.c mouse: split button out 2009-04-26 10:46:09 +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.