Go to file
Julien Danjou 0a6c6e017b Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys()
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-03-23 15:52:22 +01:00
build-utils Add support for package codename into codename-stamp (like version) 2008-03-13 10:57:10 +01:00
common Cosmetic formating changes 2008-03-23 15:52:22 +01:00
icons/layouts rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
layouts Remove useless include 2008-03-23 15:52:20 +01:00
widgets Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
.gitignore Add awesome-menu manpage 2008-03-23 15:52:19 +01:00
AUTHORS update authors, add Marco Candrian & Hans Ulrich Niedermann 2008-01-26 18:02:57 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile.am Revert "Add preliminary support for XPM format" 2008-03-23 15:52:22 +01:00
README Use Pango for fonts instead of Xft (which hasn't been ported yet to 2008-03-23 15:52:21 +01:00
STYLE Add a note about writing documentation 2008-03-15 09:47:43 +01:00
UPGRADE add UPGRADE to dist 2008-02-02 18:13:55 +01:00
autogen.sh Honor GIT_DIR setting when determining version 2008-01-30 09:22:45 +01:00
awesome-client.1.txt Fix default example in awesome-client.1 2008-03-23 15:52:21 +01:00
awesome-client.c Use warn() instead of perror() 2008-03-23 15:52:21 +01:00
awesome-menu.1.txt Documente existing -c option of awesome-menu 2008-03-23 15:52:19 +01:00
awesome-menu.c Use warn() instead of perror() 2008-03-23 15:52:21 +01:00
awesome-message.1.txt Add a manpage for awesome-message 2008-03-13 11:33:58 +01:00
awesome-message.c Revert "Add preliminary support for XPM format" 2008-03-23 15:52:22 +01:00
awesome.1.txt Fix SEE ALSO section 2008-03-23 15:52:20 +01:00
awesome.c Simplify scan() function 2008-03-23 15:52:22 +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.5.txt new graph-widget option: grow = <{right, left}> 2008-03-23 15:52:21 +01:00
awesomerc.in Add support for mouse bindings on titlebars 2008-03-23 15:52:22 +01:00
client.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
client.h Change the way to do resize 2008-03-23 15:52:20 +01:00
config.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
config.h Remove useless ; after DO_SLIST macro 2008-03-23 15:52:17 +01:00
configure.ac Revert "Add preliminary support for XPM format" 2008-03-23 15:52:22 +01:00
event.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
event.h Move grabkeys() out of event, and move it into window; clean and remove setup() function in awesome.c 2008-03-06 16:18:01 +01:00
ewmh.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
ewmh.h rework include 2008-01-29 11:27:14 +01:00
focus.c trailing whitespaces removed 2008-02-13 09:05:10 +01:00
focus.h Remove useless ; after DO_SLIST macro 2008-03-23 15:52:17 +01:00
layout.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
layout.h Update various copyrights 2008-03-23 15:52:19 +01:00
mouse.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
mouse.h Update various copyrights 2008-03-23 15:52:19 +01:00
placement.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
placement.h add under_mouse placement aglo 2008-02-13 18:14:34 +01:00
rules.c Add missing includes 2008-03-23 15:52:20 +01:00
rules.h Update various copyrights 2008-03-23 15:52:19 +01:00
screen.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
screen.h Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
statusbar.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
statusbar.h Update various copyrights 2008-03-23 15:52:19 +01:00
structs.h Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
tag.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
tag.h Update various copyrights 2008-03-23 15:52:19 +01:00
titlebar.c Store physical screen id in statusbar and client, change get_phys_s() to screen_virttophys() 2008-03-23 15:52:22 +01:00
titlebar.h Move titlebar initialization routine in titlebar.c 2008-03-23 15:52:20 +01:00
uicb.c Use warn() instead of perror() 2008-03-23 15:52:21 +01:00
uicb.h Update various copyrights 2008-03-23 15:52:19 +01:00
widget.c make sure command is some text != "" 2008-03-23 15:52:18 +01:00
widget.h Update various copyrights 2008-03-23 15:52:19 +01:00
window.c Rename Area to area_t 2008-03-23 15:52:18 +01:00
window.h Rename Area to area_t 2008-03-23 15:52:18 +01: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, Xinerama, Xrandr, Pango
  - 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.