Go to file
Julien Danjou 83a0a4daf8 add a common infra to drop events 2008-01-21 16:31:15 +01:00
build-utils move gen scripts in build-utils 2008-01-21 16:31:14 +01:00
icons/layouts rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
layouts add a new cache system for arrange()ing 2008-01-21 16:31:15 +01:00
widgets draw a background for icons in tasklist 2008-01-21 16:31:15 +01:00
.gitignore autogenerate widget list 2008-01-21 16:31:14 +01:00
AUTHORS add 2008 copyright notice 2008-01-02 16:59:43 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile.am rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
README More detailed elaboration on build requirements 2008-01-09 17:45:36 +01:00
STYLE The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
autogen.sh Add version generation script, version stamp file 2008-01-15 08:21:43 +01:00
awesome-client-common.c add 2008 copyright notice 2008-01-02 16:59:43 +01:00
awesome-client.1.txt an emtpy line flushes data into awesome (in awesome-client) 2008-01-10 07:10:35 +01:00
awesome-client.c Add a 'flush'-like function to awesome-client 2008-01-07 19:59:26 +01:00
awesome-client.h add 2008 copyright notice 2008-01-02 16:59:43 +01:00
awesome.1.txt document new layouts 2008-01-15 08:34:17 +01:00
awesome.c add a common infra to drop events 2008-01-21 16:31:15 +01:00
awesome.doxygen.in switch to autotools as build system 2008-01-04 20:49:49 +01:00
awesome.h simplify unmanage code 2008-01-06 21:57:53 +01:00
awesomerc.1.txt rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
awesomerc.in rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
client.c add a common infra to drop events 2008-01-21 16:31:15 +01:00
client.h add client_find_next_visible() 2008-01-21 16:31:15 +01:00
config.c add more functions to manipulate tags 2008-01-21 16:31:15 +01:00
config.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
configure.ac Add check for --help and --version support 2008-01-21 15:52:22 +01:00
draw.c draw_text takes a Area as arg 2008-01-21 16:31:14 +01:00
draw.h draw_text takes a Area as arg 2008-01-21 16:31:14 +01:00
event.c add a common infra to drop events 2008-01-21 16:31:15 +01:00
event.h add 2008 copyright notice 2008-01-02 16:59:43 +01:00
ewmh.c init geometry, and do not need to set need_arrange, setfloating() does it 2008-01-21 16:31:15 +01:00
ewmh.h move NetWMIcon get to ewmh.c 2008-01-03 19:02:23 +01:00
focus.c rename FocusList to client_node_t 2008-01-21 16:31:14 +01:00
focus.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
layout.c add a new cache system for arrange()ing 2008-01-21 16:31:15 +01:00
layout.h add a new cache system for arrange()ing 2008-01-21 16:31:15 +01:00
list.h add prefix##_list_next_cycle 2008-01-21 16:31:15 +01:00
mouse.c use client_setfloating() 2008-01-21 16:31:15 +01:00
mouse.h replace UICB_PROTO macro by a typedef 2008-01-01 17:25:48 +01:00
rules.c insert and use rule_matching_client() 2008-01-21 16:31:14 +01:00
rules.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
screen.c add a common infra to drop events 2008-01-21 16:31:15 +01:00
screen.h rework headers inclusion 2008-01-01 18:02:36 +01:00
statusbar.c clean out some need_arrange uneeded 2008-01-21 16:31:15 +01:00
statusbar.h preinit in config.c 2008-01-21 16:31:14 +01:00
structs.h add a common infra to drop events 2008-01-21 16:31:15 +01:00
tag.c add a new cache system for arrange()ing 2008-01-21 16:31:15 +01:00
tag.h store screen in tag 2008-01-21 16:31:15 +01:00
uicb.c auto generate uicb list 2008-01-21 16:31:14 +01:00
uicb.h replace UICB_PROTO macro by a typedef 2008-01-01 17:25:48 +01:00
util.c documentation update 2008-01-21 16:31:14 +01:00
util.h change ifdef 2008-01-21 16:31:13 +01:00
widget.c autogenerate widget list 2008-01-21 16:31:14 +01:00
widget.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
window.c doc update, and window_settrans return status 2008-01-21 16:31:14 +01:00
window.h doc update, and window_settrans return status 2008-01-21 16:31:14 +01:00
xutil.c add Display as arg 2008-01-21 16:31:14 +01:00
xutil.h add Display as arg 2008-01-21 16:31:14 +01:00

README

awesome
=======
awesome is an extremely fast, small, and dynamic window manager for X.
It's based on dwm.

Requirements
------------
In order to build awesome itself, you need header files and libs of:
  - Xlib, Xinerama, Xrandr, Xft
  - libconfuse >= 2.6
  - cairo

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