Go to file
Aldo Cortesi cbf5c474c1 Documentation generation fixes.
- Fix many instances of incorrect and incomplete doxygen annotations.
- Teach doxygen not to complain when it comes accross gcc __attribute__
specifications.
- Turn off graph generation by default.
- Make doxygen quiet, so we can actually see warnings when they occur.
2007-12-19 10:42:24 +01:00
layouts The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
widgets Make textbox foreground and background configurable. 2007-12-19 10:41:50 +01:00
.gitignore remove dual-config: awesomerc is now preprocessed and compiled in awesome 2007-12-13 11:16:43 +01:00
AUTHORS add Nikos Ntarmos in AUTHORS 2007-11-14 17:21:12 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile Widget-ise the statusbar. 2007-12-15 10:15:42 +01:00
README Add more requirements to README. 2007-12-17 18:21:47 +01:00
STYLE The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
awesome-client-common.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
awesome-client.1.txt minor documentation fix 2007-12-15 07:36:06 +01:00
awesome-client.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
awesome-client.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
awesome.1.txt remove default reloadconfig un manpage 2007-12-15 19:22:47 +01:00
awesome.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
awesome.doxygen Documentation generation fixes. 2007-12-19 10:42:24 +01:00
awesome.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
awesomerc change default conf to work with new widget layout 2007-12-16 13:12:35 +01:00
awesomerc.1.txt rename description 2007-12-15 07:42:18 +01:00
client.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
client.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
common.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
config.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
config.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
config.mk Widget-ise the statusbar. 2007-12-15 10:15:42 +01:00
draw.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
draw.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
event.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
event.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
focus.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
focus.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
layout.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
layout.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
mouse.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
mouse.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
rules.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
rules.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
screen.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
screen.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
statusbar.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
statusbar.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
tag.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
tag.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
uicb.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
uicb.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
util.c Remove single occurance of die, and then remove die itself. 2007-12-19 10:42:00 +01:00
util.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
widget.c The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
widget.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
window.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
window.h The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
xutil.c Documentation generation fixes. 2007-12-19 10:42:24 +01:00
xutil.h Make textbox foreground and background configurable. 2007-12-19 10:41:50 +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 you need the Xlib header files, libconfuse and cairo.
Creating the man pages also requires recent versions of the asciidoc and xmlto
tools.

Installation
------------
Edit config.mk to match your local setup (awesome is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install awesome (if
necessary as root):

    make install

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.