Go to file
Julien Danjou b4899653c2 awesomerc: use awful.util.getdir rather than env
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-10-22 17:57:03 +02:00
build-utils layout: add fair layout 2008-09-11 13:31:28 +02:00
common Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
icons awful.menu: import 2008-10-22 15:25:20 +02:00
layouts Fine tuned 'fairh' and 'fairv' layouts. 2008-10-14 09:05:51 +02:00
lib awful.util: add support for config dir 2008-10-22 17:56:51 +02:00
themes awful.menu: import 2008-10-22 15:25:20 +02:00
utils awsetbg: enhance display command 2008-10-01 09:26:03 +02:00
widgets widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
.gitignore gitignore: add binaries 2008-09-22 10:37:07 +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 Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile build: do not do build link if it exists 2008-09-29 16:21:36 +02:00
PATCHES update STYLE, add PATCHES 2008-08-30 13:09:15 +02:00
README doc: change description in README 2008-10-02 17:20:08 +02:00
STYLE update STYLE, add PATCHES 2008-08-30 13:09:15 +02:00
awesome-client.1.txt Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
awesome-client.c awesome-client: reconnect if disconnected 2008-09-26 15:00:27 +02:00
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.1.txt lua: add --check option 2008-09-30 16:59:08 +02:00
awesome.c event: handle background changes 2008-10-10 18:27:43 +02:00
awesome.desktop desktop: change description 2008-10-02 17:19:28 +02:00
awesome.doxygen.in doxygen: add lfield 2008-07-02 17:59:26 +02:00
awesome.h factorize quit/exec elements, and reparent systray 2008-09-02 17:12:10 +02:00
awesomeConfig.cmake build: add x11-xcb as dep 2008-10-13 08:57:51 +02:00
awesomerc.5.txt awesomerc: add an explicit sentence 2008-08-21 13:57:20 +02:00
awesomerc.lua.in awesomerc: use awful.util.getdir rather than env 2008-10-22 17:57:03 +02:00
client.c structs: move some define out 2008-10-21 17:37:14 +02:00
client.h structs: move some define out 2008-10-21 17:37:14 +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, lua: set CLOEXEC on fds 2008-08-27 14:20:51 +02:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
draw.c draw: allow text to be on multiple lines 2008-10-01 14:07:30 +02:00
draw.h wibox: rework, merge titlebar 2008-09-26 15:00:42 +02:00
event.c widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
event.h wibox: wibox_refresh merge statusbar and titlebar 2008-09-22 11:11:56 +02:00
ewmh.c Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
ewmh.h ewmh: update window hints 2008-09-22 11:11:55 +02:00
image.c image: add width and height attributes 2008-10-21 18:29:35 +02:00
image.h image: add function to create from argb32 data 2008-09-22 11:11:55 +02:00
keybinding.c xutil: use token for keys 2008-10-01 11:09:57 +02:00
keybinding.h image: merge draw_image_t and image_t 2008-09-22 11:11:55 +02:00
keygrabber.c keygrabber: add support for XKB_KEYS 2008-09-26 09:46:34 +02:00
keygrabber.h [keygrabber] Fix key mapping 2008-06-10 22:37:45 +02:00
layout.c screen: merge with xscreen, remove screens_info 2008-09-22 11:11:56 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
luaa.c Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
luaa.h Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
mouse.c lua: check for ref value before getting them 2008-10-21 10:35:23 +02:00
mouse.h mouse: rework mouse buttons API, support release events 2008-09-22 11:11:53 +02:00
property.c client: icon_name is stored and watched 2008-10-21 15:15:28 +02:00
property.h client: icon_name is stored and watched 2008-10-21 15:15:28 +02:00
screen.c client, screen: use geometry rather coords as keyword 2008-10-21 15:31:52 +02:00
screen.h wibox: merge statusbar and titlebar types 2008-09-22 11:11:56 +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 wibox: rework, merge titlebar 2008-09-26 15:00:42 +02:00
structs.h widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
swindow.c wibox: rework, merge titlebar 2008-09-26 15:00:42 +02:00
swindow.h wibox: rework, merge titlebar 2008-09-26 15:00:42 +02:00
systray.c systray: use a_ functions 2008-09-22 11:11:56 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
tag.h structs: move some define out 2008-10-21 17:37:14 +02:00
titlebar.c titlebar: fix border color setting 2008-09-29 17:29:34 +02:00
titlebar.h wibox: rework, merge titlebar 2008-09-26 15:00:42 +02:00
wibox.c widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
wibox.h Rewrite {tag,task}list in Lua. 2008-10-20 20:06:09 +02:00
widget.c widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
widget.h widgets: use a geometry callback 2008-10-22 17:32:17 +02:00
window.c window: remove spurious printf 2008-09-22 11:11:56 +02:00
window.h mouse: rework mouse buttons API, support release events 2008-09-22 11:11:53 +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
  - libev
  - glib
  - 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.