Find a file
Julien Danjou 80b79717ba various documentation update for _index()
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-07-28 16:03:38 +02:00
build-utils build: add support for __index in widgets 2008-07-02 17:57:16 +02:00
common tasklist: use label to determine which objects are drawn 2008-07-28 15:57:17 +02:00
icons awesomerc: display icons when client is floating 2008-07-09 12:34:42 +02:00
layouts client: honor size hints is now by client 2008-06-25 15:42:07 +02:00
lib mouse: merge screen_get() into index 2008-07-02 09:14:17 +02:00
widgets various documentation update for _index() 2008-07-28 16:03:38 +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
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: update keybindings 2008-07-23 09:42:04 +02:00
awesome.c length of static string s should be sizeof(s)-1 2008-07-22 10:30:53 +02:00
awesome.doxygen.in doxygen: add lfield 2008-07-02 17:59:26 +02:00
awesomeConfig.cmake Fix default search path for configurations 2008-07-24 20:10:13 +02:00
awesomerc.5.txt awesomerc: document markup 2008-07-09 10:43:23 +02:00
awesomerc.lua.in awesomerc: fix string escape 2008-07-28 15:58:30 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
client.c various documentation update for _index() 2008-07-28 16:03:38 +02:00
client.h tasklist: stop using client markup 2008-07-10 11:02:11 +02:00
CMakeLists.txt config: Fix default config path and documents. 2008-07-13 13:00: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 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: use ewmh restart 2008-07-23 09:03:52 +02:00
event.h Make event handler setup private to the event module. 2008-06-26 22:47:56 +02:00
ewmh.c Reload awesome on SIGHUP 2008-07-22 10:23:07 +02:00
ewmh.h Reload awesome on SIGHUP 2008-07-22 10:23:07 +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 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 layout: arrange before focus is gave 2008-07-23 09:00:53 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
lua.c Fix default search path for configurations 2008-07-24 20:10:13 +02:00
lua.h lua: pop error 2008-07-10 11:02:11 +02:00
Makefile Add a tags target, cmake already knows install needs build. 2008-07-01 22:19:44 +02:00
mouse.c various documentation update for _index() 2008-07-28 16:03:38 +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
README use ON/OFF in cmake option docs 2008-07-23 09:42:04 +02:00
screen.c screen: merge tag_client_with_current_selected() code 2008-06-27 23:00:20 +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 various documentation update for _index() 2008-07-28 16:03:38 +02:00
statusbar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
structs.h remove spurious semi colon 2008-07-24 16:22:41 +02:00
STYLE Fix STYLE file to reflect current style [CORRECTIVE] 2008-03-24 07:49:33 +01:00
systray.c systray: use snprintf() result, not strlen 2008-07-10 15:08:07 +02:00
systray.h systray: add KDE work around 2008-06-30 13:06:23 +02:00
tag.c various documentation update for _index() 2008-07-28 16:03:38 +02:00
tag.h draw: iso2utf now gets len as arg 2008-07-01 14:44:19 +02:00
titlebar.c various documentation update for _index() 2008-07-28 16:03:38 +02:00
titlebar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
widget.c various documentation update for _index() 2008-07-28 16:03:38 +02:00
widget.h widget: remove unused WIDGET_CACHE_LAYOUTS 2008-07-26 17:32:35 +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

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
  - 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.