Find a file
marco candrian 04ff373a63 New progressbar option: vertical=<boolean>
if 'true', draws the whole progressbar-block vertically
instead of horizontally.
2008-03-23 15:52:16 +01:00
build-utils
common New progressbar option: vertical=<boolean> 2008-03-23 15:52:16 +01:00
icons/layouts
layouts
widgets New progressbar option: vertical=<boolean> 2008-03-23 15:52:16 +01:00
.gitignore
AUTHORS
autogen.sh
awesome-client.1.txt
awesome-client.c
awesome-menu.c
awesome-message.1.txt
awesome-message.c
awesome.1.txt
awesome.c
awesome.doxygen.in
awesome.h
awesomerc.5.txt awesomerc.5 update for the new option "reverse=<boolean>" 2008-03-23 15:52:16 +01:00
awesomerc.in
client.c
client.h
config.c
config.h
configure.ac
event.c
event.h
ewmh.c
ewmh.h
focus.c
focus.h
layout.c
layout.h
LICENSE
Makefile.am
mouse.c
mouse.h
placement.c
placement.h
README
rules.c
rules.h
screen.c
screen.h
statusbar.c
statusbar.h
structs.h widget error infrastructure additions 2008-03-23 15:52:16 +01:00
STYLE
tag.c
tag.h
uicb.c
uicb.h
UPGRADE
widget.c widget error infrastructure additions 2008-03-23 15:52:16 +01:00
widget.h
window.c
window.h

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, 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.