Go to file
Julien Danjou 8b5f6266da lua: add support for __pairs and __next metamethods
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-08-10 16:15:15 +02:00
build-utils awful,tabulous: fix copyright for luadoc 2008-08-04 16:41:23 +02:00
common titlebar: replace client_get() by client attribute 2008-08-08 16:04:18 +02:00
icons icons: resize 2008-07-30 09:41:06 +02:00
layouts focus: remove focus history 2008-07-31 17:30:01 +02:00
lib libs: fix callback call and untab 2008-08-10 08:04:09 +02:00
themes beautiful: allow extra spaces in theme file 2008-08-07 08:20:08 +02:00
widgets taglist: append area even if function fails 2008-08-10 16:15:15 +02:00
.gitignore build: add a Makefile to run cmake automagically 2008-07-01 08:25:40 +02:00
AUTHORS update AUTHORS file 2008-06-26 22:01:09 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt beautiful: import 2008-08-05 22:24:14 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile build: any target need cmake first 2008-08-04 11:51:11 +02:00
README README: add xcb-util minimum version 2008-08-01 14:36:01 +02:00
STYLE Fix STYLE file to reflect current style [CORRECTIVE] 2008-03-24 07:49:33 +01:00
awesome-client.1.txt Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
awesome-client.c comments fixing 2008-06-20 08:38:00 +02:00
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.1.txt doc: add SIGHUP 2008-08-05 17:51:46 +02:00
awesome.c remove useless include 2008-08-06 20:54:20 +02:00
awesome.doxygen.in doxygen: add lfield 2008-07-02 17:59:26 +02:00
awesomeConfig.cmake build: fix gdkpixbuf dependency 2008-08-09 09:55:01 +02:00
awesomerc.5.txt awesomerc: document markup 2008-07-09 10:43:23 +02:00
awesomerc.lua.in awesomerc: put systray into statusbar 2008-08-09 10:00:20 +02:00
client.c client: allow screen change only if xinerama is active 2008-08-10 10:32:59 +02:00
client.h statusbar: handle systray invisibility 2008-08-05 16:59:54 +02:00
cnode.c comments fixing 2008-06-20 08:38:00 +02:00
cnode.h [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
config.h.in Fix default search path for configurations 2008-07-24 20:10:13 +02:00
dbus.c dbus: simply execute call 2008-07-08 14:40:41 +02:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
event.c event: fix memory leak on client size hints update 2008-08-06 16:13:42 +02:00
event.h Make event handler setup private to the event module. 2008-06-26 22:47:56 +02:00
ewmh.c ewmh: check tags tab size 2008-08-07 16:23:43 +02:00
ewmh.h ewmh: introduce and use netwm_icon_delete() 2008-07-29 16:44:57 +02:00
keybinding.c fix ARRAY_TYPE decl 2008-07-24 16:25:11 +02:00
keybinding.h Hide keybidings_t away, subsequent simplifications 2/2 2008-07-01 08:12:22 +02:00
keygrabber.c Simplify keygrabber. 2008-06-30 00:47:11 +02:00
keygrabber.h [keygrabber] Fix key mapping 2008-06-10 22:37:45 +02:00
layout.c focus: remove focus history 2008-07-31 17:30:01 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
lua.c lua: add support for __pairs and __next metamethods 2008-08-10 16:15:15 +02:00
lua.h lua: add support for __pairs and __next metamethods 2008-08-10 16:15:15 +02:00
mouse.c mouse: refresh titlebars on the fly 2008-08-08 17:38:51 +02:00
mouse.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
placement.c remove useless #include 2008-06-26 18:10:45 +02:00
placement.h placement: rename FloatingPlacement to floating_placement_t 2008-06-15 10:55:07 +02:00
screen.c focus: remove focus history 2008-07-31 17:30:01 +02:00
screen.h statusbar: use screen attribute to add to screen 2008-07-24 17:37:24 +02:00
stack.c ewmh: add support for _NET_CLIENT_LIST_STACKING 2008-06-17 21:47:57 +02:00
stack.h [client] Add proper stacking support 2008-05-25 19:32:30 +02:00
statusbar.c titlebar: widgets are now returned/set as array 2008-08-08 16:49:26 +02:00
statusbar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
structs.h systray: remove has_systray 2008-08-05 17:03:14 +02:00
systray.c systray: remove has_systray 2008-08-05 17:03:14 +02:00
systray.h systray: add KDE work around 2008-06-30 13:06:23 +02:00
tag.c tag: add support for tag screen change 2008-08-08 14:39:03 +02:00
tag.h draw: iso2utf now gets len as arg 2008-07-01 14:44:19 +02:00
titlebar.c titlebar: add position in __newindex 2008-08-08 17:15:23 +02:00
titlebar.h titlebar: use need_update system (like statusbar, …) 2008-07-31 14:11:07 +02:00
widget.c widget: optimize cache invalidation 2008-08-06 14:24:54 +02:00
widget.h appicon: new widget, used in titlebar 2008-07-29 16:51:21 +02:00
window.c Hide keybindings away 1/2 2008-07-01 08:12:22 +02:00
window.h Hide keybindings away 1/2 2008-07-01 08:12:22 +02:00

README

awesome
=======
awesome is an extremely fast, small, and dynamic window manager for X.

Requirements
------------
In order to build awesome itself, you need header files and libs of:
  - cmake
  - Xlib, xcb and xcb-util (>= 0.2.1)
  - Lua 5.1
  - cairo
  - pango and pangocairo
  - libev
  - glib
  - 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:

  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
-----------
Add the following line to your .xinitrc to start awesome using startx
or to .xsession to start awesome using gdm/kdm/xdm...:

    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.