Go to file
Julien Danjou 435816a811 titlebar: update titlebar.new() documentation for borders
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-06-18 11:27:51 +02:00
build-utils [doxygen] Add \lvalue and convert existing doc. 2008-06-11 07:36:34 +02:00
common Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
icons Added magnifier icons. 2008-06-14 00:03:04 +02:00
layouts Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
widgets ewmh: s/NetWMIcon/netwm_icon_t/ 2008-06-18 09:29:57 +02:00
.gitignore improve .gitignore 2008-06-13 23:39:52 +02:00
AUTHORS [authors] Add Arnaud Fontaine 2008-05-03 12:01:01 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile.am build: build with -fno-strict-aliasing 2008-06-18 11:26:28 +02:00
README README: add libev 2008-06-17 08:21:39 +02:00
STYLE Fix STYLE file to reflect current style [CORRECTIVE] 2008-03-24 07:49:33 +01:00
as_ac_expand.m4 [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
autogen.sh Honor GIT_DIR setting when determining version 2008-01-30 09:22:45 +01:00
awesome-client.1.txt Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
awesome-client.c [util] warn() and eprint() now print \n 2008-05-23 22:56:05 +02:00
awesome.1.txt [manpage] Update 2008-06-11 09:56:19 +02:00
awesome.c The X socket MUST keep us alive. 2008-06-18 02:12:37 +02:00
awesome.doxygen.in [doxygen] Add \lvalue and convert existing doc. 2008-06-11 07:36:34 +02:00
awesomerc.5.txt systray: import widget 2008-06-14 18:12:16 +02:00
awesomerc.lua.in awful: simplify menu args 2008-06-17 16:37:27 +02:00
awful.lua awful: fix a bug with backspace in menu 2008-06-18 08:41:45 +02:00
client.c titlebar: add support for border, refactorize code 2008-06-18 11:22:54 +02:00
client.h [client] Fix border width setting 2008-06-11 08:14:54 +02:00
cnode.c [cleanup] random doxygen fixes 2008-06-08 17:13:09 +02:00
cnode.h [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
configure.ac xshape: remove, nothing prove it's really useful 2008-06-17 15:06:05 +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 Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
event.h xshape: remove, nothing prove it's really useful 2008-06-17 15:06:05 +02:00
ewmh.c ewmh: s/NetWMIcon/netwm_icon_t/ 2008-06-18 09:29:57 +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 lua: _gc are now macros 2008-06-16 11:31:38 +02:00
keygrabber.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14: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 ewmh: add support for _NET_WORKAREA 2008-06-17 22:12:30 +02:00
lua.h And migrate the rest of the loop to the libev. 2008-06-17 00:30:53 +02:00
mouse.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
mouse.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
placement.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
placement.h placement: rename FloatingPlacement to floating_placement_t 2008-06-15 10:55:07 +02:00
screen.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +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 ewmh: add support for _NET_WORKAREA 2008-06-17 22:12:30 +02:00
statusbar.h [lua] Add object as argument to mouse click function 2008-06-04 19:21:21 +02:00
structs.h titlebar: add support for border, refactorize code 2008-06-18 11:22:54 +02:00
systray.c Replace xcb_aux_get_screen() by a safer function 2008-06-17 17:14:00 +02:00
systray.h systray: attach systray to external window, not statusbar 2008-06-15 10:33:10 +02:00
tabulous.lua [tabulous] Fix merge to wrong tabindex 2008-06-11 13:27:05 +02:00
tag.c ewmh: add support for _NET_WORKAREA 2008-06-17 22:12:30 +02:00
tag.h Revert "Replace tags by workspaces" 2008-06-09 21:56:03 +02:00
titlebar.c titlebar: update titlebar.new() documentation for borders 2008-06-18 11:27:51 +02:00
titlebar.h titlebar: add support for border, refactorize code 2008-06-18 11:22:54 +02:00
widget.c widget: use PIXMAP atom directly 2008-06-17 21:23:38 +02:00
widget.h systray: import widget 2008-06-14 18:12:16 +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)

In order to build the awesome man pages, you need these tools:
  - asciidoc (recent version)
  - xmlto (recent version)
  - docbook XSL stylesheets

In order to build the source code reference, you need these tools:
  - doxygen
  - graphviz

Building and Installation
-------------------------
If building from git sources, run "./autogen.sh". When autoreconf has
finished, you can follow the following instructions for building a dist
tarball.

After extracting the dist tarball, run "./configure --help" and figure out
what you might want to adapt for your system. Then run ./configure with the
proper parameters, and build and install:

  ./configure [...]
  make
  make install # might need root permissions

If you're using gcc as your compiler and do not want awesome's default set
of warning flags, add AWESOME_CFLAGS="" to your "make" lines.

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.