Go to file
Pierre Habouzit f84e66ddc6 Avoid lists of tag/client pairs, use an array per tag.
Signed-off-by: Pierre Habouzit <madcoder@debian.org>
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-06-24 14:30:13 +02:00
build-utils build: implement make dist using git-archive 2008-06-24 08:58:04 +02:00
common Be more on the safe side. 2008-06-23 18:55:29 +02:00
icons Added magnifier icons. 2008-06-14 00:03:04 +02:00
layouts area_t: make it smaller, use arrays instead of lists. 2008-06-22 22:09:48 +02:00
lib client: rename hide API 2008-06-24 13:44:15 +02:00
widgets Be more on the safe side. 2008-06-23 18:55:29 +02:00
.gitignore Use gperf to tokenize some strings. 2008-06-23 07:41:22 +02:00
AUTHORS add Michael as author 2008-06-22 19:38:55 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt build: implement make dist using git-archive 2008-06-24 08:58:04 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
README doc: fix README 2008-06-23 18:57:49 +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 [manpage] Update 2008-06-11 09:56:19 +02:00
awesome.c comments fixing 2008-06-20 08:38:00 +02:00
awesome.doxygen.in cmake: configure awesome.doxygen 2008-06-19 22:28:47 +02:00
awesomeConfig.cmake build: implement make dist using git-archive 2008-06-24 08:58:04 +02:00
awesomerc.5.txt awesomerc.5.txt don't include the api documentation 2008-06-23 18:43:05 +02:00
awesomerc.lua.in awesomerc: fix mplayer 2008-06-23 11:37:58 +02:00
client.c client: rename hide API 2008-06-24 13:44:15 +02:00
client.h client: export client_geometry_hints 2008-06-18 18:48:38 +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 cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
dbus.c Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
event.c Always use unchecked xcb functions 2008-06-21 19:56:51 +09:00
event.h xshape: remove, nothing prove it's really useful 2008-06-17 15:06:05 +02:00
ewmh.c Replace tag_t lists with arrays. 2008-06-23 17:37:19 +02:00
ewmh.h ewmh: s/NetWMIcon/netwm_icon_t/ 2008-06-18 09:29:57 +02:00
focus.c Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
focus.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
keybinding.c Make refcounting safer. 2008-06-22 14:22:44 +02:00
keygrabber.c comments fixing 2008-06-20 08:38:00 +02:00
keygrabber.h [keygrabber] Fix key mapping 2008-06-10 22:37:45 +02:00
layout.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
lua.c Replace tag_t lists with arrays. 2008-06-23 17:37:19 +02:00
lua.h use more tokenizer, with len 2008-06-23 14:01:33 +02:00
mouse.c mouse: move/resize return if grabbing the pointer fails. 2008-06-24 08:58:04 +02:00
mouse.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
placement.c placement: fix smart 2008-06-23 17:30:35 +02:00
placement.h placement: rename FloatingPlacement to floating_placement_t 2008-06-15 10:55:07 +02:00
screen.c Replace tag_t lists with arrays. 2008-06-23 17:37:19 +02:00
screen.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +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 use more tokenizer, with len 2008-06-23 14:01:33 +02:00
statusbar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
structs.h Avoid lists of tag/client pairs, use an array per tag. 2008-06-24 14:30:13 +02:00
systray.c Always use unchecked xcb functions 2008-06-21 19:56:51 +09:00
systray.h systray: attach systray to external window, not statusbar 2008-06-15 10:33:10 +02:00
tag.c Avoid lists of tag/client pairs, use an array per tag. 2008-06-24 14:30:13 +02:00
tag.h Avoid lists of tag/client pairs, use an array per tag. 2008-06-24 14:30:13 +02:00
titlebar.c titlebar: fix position init 2008-06-23 20:37:31 +02:00
titlebar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
widget.c use more tokenizer, with len 2008-06-23 14:01:33 +02:00
widget.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
window.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
window.h xshape: remove, nothing prove it's really useful 2008-06-17 15:06:05 +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:
  - Xlib, xcb and xcb-util.
  - Lua 5.1
  - cairo
  - pango and pangocairo
  - libev
  - glib
  - GdkPixBuf or Imlib2 (use --with-imlib2 with ./configure)
  - dbus (optional, use --with-dbus=no with ./configure to disable)
  - gperf

In order to build the awesome man pages and documentation,
you need these tools:
  - asciidoc (recent version)
  - xmlto (recent version)
  - 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:

  cmake .
  make
  make install # might need root permissions

The source code reference can be built with "make doc".

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 ~/.awesomerc.lua file.
An example is provided in the sources.