Go to file
Michael Gehring f56f34d715 widgets: remove unnecessary #includes 2008-06-26 19:33:43 +02:00
build-utils build: implement make dist using git-archive 2008-06-24 08:58:04 +02:00
common [statusbar] add colors_set 2008-06-26 17:12:41 +02:00
icons Added magnifier icons. 2008-06-14 00:03:04 +02:00
layouts client: honor size hints is now by client 2008-06-25 15:42:07 +02:00
lib awful: fix to use new widget API 2008-06-26 17:53:38 +02:00
widgets widgets: remove unnecessary #includes 2008-06-26 19:33:43 +02:00
.gitignore More ignores. 2008-06-25 11:04:56 +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 fixed out-of-source luac file generation 2008-06-26 19:33:43 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
README "recent version" has no mean 2008-06-24 22:30:46 +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 remove useless #include 2008-06-26 18:10:45 +02:00
awesome.doxygen.in cmake: configure awesome.doxygen 2008-06-19 22:28:47 +02:00
awesomeConfig.cmake cmake: hide CMAKE_INSTALL_PREFIX in ccmake 2008-06-26 19:33:43 +02:00
awesomerc.5.txt widget: new widget index method 2008-06-26 16:35:07 +02:00
awesomerc.lua.in widget: new widget index method 2008-06-26 16:35:07 +02:00
client.c remove useless #include 2008-06-26 18:10:45 +02:00
client.h client: split out of setfloating layer handling 2008-06-25 22:26:53 +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 remove useless #include 2008-06-26 18:10:45 +02:00
dbus.h Plug dbus in the event loop. 2008-06-16 23:51:07 +02:00
event.c remove useless #include 2008-06-26 18:10:45 +02:00
event.h xshape: remove, nothing prove it's really useful 2008-06-17 15:06:05 +02:00
ewmh.c remove useless #include 2008-06-26 18:10:45 +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 remove useless #include 2008-06-26 18:10:45 +02:00
keybinding.h Put keybindings in binary searchable arrays. 2008-06-25 11:04:56 +02:00
keygrabber.c remove useless #include 2008-06-26 18:10:45 +02:00
keygrabber.h [keygrabber] Fix key mapping 2008-06-10 22:37:45 +02:00
layout.c remove useless #include 2008-06-26 18:10:45 +02:00
layout.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
lua.c remove useless #include 2008-06-26 18:10:45 +02:00
lua.h lua: split getopt_string/getopt_lstring; fix mouse corner 2008-06-25 17:33:05 +02:00
mouse.c remove useless #include 2008-06-26 18:10:45 +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 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 remove useless #include 2008-06-26 18:10:45 +02:00
statusbar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
structs.h widget: new widget index method 2008-06-26 16:35:07 +02:00
systray.c remove useless #include 2008-06-26 18:10:45 +02:00
systray.h systray: attach systray to external window, not statusbar 2008-06-15 10:33:10 +02:00
tag.c remove useless #include 2008-06-26 18:10:45 +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 remove useless #include 2008-06-26 18:10:45 +02:00
titlebar.h lua: userdata_new is now macro 2008-06-18 18:31:35 +02:00
widget.c remove useless #include 2008-06-26 18:10:45 +02:00
widget.h widget: new widget index method 2008-06-26 16:35:07 +02:00
window.c remove useless #include 2008-06-26 18:10:45 +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 -DWITH_IMLIB2=1 with cmake)
  - dbus (optional, use -DWITH_DBUS=0 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:

  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.