Go to file
Julien Danjou 65f5f964ef draw: better GError handling
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-08-18 14:32:05 +02:00
build-utils client: deprecate client_get() and client_set() 2008-08-12 12:17:19 +02:00
common draw: better GError handling 2008-08-18 14:32:05 +02:00
icons icons: resize 2008-07-30 09:41:06 +02:00
layouts screen: introduce screen objects 2008-08-11 17:14:02 +02:00
lib lib: add @release tag 2008-08-18 11:41:58 +02:00
themes default theme: add documentation about taglist_squares and [taglist|tasklist|titlebar] specific variables 2008-08-15 19:12:39 +02:00
widgets textbox: overwrite extents to 0 on nil 2008-08-15 01:11:39 +02:00
.gitignore gitignore: remove all files 2008-08-12 21:13:39 +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 lib: add @release tag 2008-08-18 11:41:58 +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 awesome.1: add missing documentation on M+C+I 2008-08-18 10:43:17 +02:00
awesome.c scan: fix array indice 2008-08-14 21:42:36 +02:00
awesome.desktop build: add desktop file (FS#257) 2008-08-12 11:37:04 +02:00
awesome.doxygen.in doxygen: add lfield 2008-07-02 17:59:26 +02:00
awesomeConfig.cmake lib: add @release tag 2008-08-18 11:41:58 +02:00
awesomerc.5.txt awesomerc: remove widgets info, add file location 2008-08-15 12:47:06 +02:00
awesomerc.lua.in awesomerc: use sub directory for history 2008-08-18 10:45:10 +02:00
client.c lua: otable can now be index by object values 2008-08-17 07:52:04 +02:00
client.h client: implement maybevisible(), and use it for maprequest 2008-08-11 11:57:57 +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 window: rename functions according to the rest of code 2008-08-13 19:06:20 +02:00
event.h Make event handler setup private to the event module. 2008-06-26 22:47:56 +02:00
ewmh.c ewmh: make ewmh_window_icon_get() asynchronous 2008-08-13 12:31:12 +02:00
ewmh.h ewmh: make ewmh_window_icon_get() asynchronous 2008-08-13 12:31:12 +02:00
keybinding.c keybinding: register fct with dedicated fct 2008-08-17 11:58:09 +02:00
keybinding.h keybinding: honor modifier state correctly (FS#264) 2008-08-13 10:30:24 +02:00
keygrabber.c keygrabber: include header file for key_getkeysym() 2008-08-13 12:31:42 +02:00
keygrabber.h [keygrabber] Fix key mapping 2008-06-10 22:37:45 +02:00
layout.c window: rename functions according to the rest of code 2008-08-13 19:06:20 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
lua.c lua: otable can now be index by object values 2008-08-17 07:52:04 +02:00
lua.h screen: fix screen number on error 2008-08-14 18:25:45 +02:00
mouse.c mouse: fix client snapping 2008-08-18 11:04:50 +02:00
mouse.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
placement.c screen: introduce screen objects 2008-08-11 17:14:02 +02:00
placement.h placement: rename FloatingPlacement to floating_placement_t 2008-06-15 10:55:07 +02:00
screen.c screen: reset statusbar and windows properly on padding changes 2008-08-14 18:25:45 +02:00
screen.h screen: introduce screen objects 2008-08-11 17:14:02 +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 screen: reset statusbar and windows properly on padding changes 2008-08-14 18:25:45 +02:00
statusbar.h screen: reset statusbar and windows properly on padding changes 2008-08-14 18:25:45 +02:00
structs.h ewmh: store NET_WM icon 2008-08-11 23:10:02 +02:00
systray.c window: rename functions according to the rest of code 2008-08-13 19:06:20 +02:00
systray.h systray: add KDE work around 2008-06-30 13:06:23 +02:00
tag.c lua: otable can now be index by object values 2008-08-17 07:52:04 +02:00
tag.h screen: make tags array overwritable 2008-08-13 10:33:15 +02:00
titlebar.c draw: make xcolor_init() asynchronous. 2008-08-12 14:53:57 +02:00
titlebar.h titlebar: use need_update system (like statusbar, …) 2008-07-31 14:11:07 +02:00
widget.c xutil: rename xutil functions according to the rest of code. 2008-08-11 18:05:35 +02:00
widget.h appicon: new widget, used in titlebar 2008-07-29 16:51:21 +02:00
window.c client: rework and document opacity field 2008-08-15 02:00:58 +02:00
window.h client: rework and document opacity field 2008-08-15 02:00:58 +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.