Go to file
Julien Danjou 7294dc55fd [build/doc] Add support for comments on section
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-03-27 17:22:35 +01:00
build-utils [build/doc] Add support for comments on section 2008-03-27 17:22:35 +01:00
common [doc] Add autogeneration of options documentation 2008-03-27 16:48:52 +01:00
icons Add icons in dist tarball and in default statusbar 2008-03-25 16:59:51 +01:00
layouts Remove useless include 2008-03-23 15:52:20 +01:00
widgets [widgets/progressbar] Initialize unit value to 0 2008-03-26 10:59:06 +01:00
.gitignore [doc] Add autogeneration of options documentation 2008-03-27 16:48:52 +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 [doc] Add autogeneration of options documentation 2008-03-27 16:48:52 +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 Fix STYLE file to reflect current style [CORRECTIVE] 2008-03-24 07:49:33 +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 Lot of cosmetic changes: proto change, etc. 2008-03-23 15:52:22 +01:00
awesome-menu.1.txt Documente existing -c option of awesome-menu 2008-03-23 15:52:19 +01:00
awesome-menu.c Do not start to OpenDisplay before reading command line options 2008-03-25 16:56:47 +01:00
awesome-message.1.txt [awesome-message] Check that delay is an integer greater than 0 2008-03-23 20:25:21 +01:00
awesome-message.c Do not start to OpenDisplay before reading command line options 2008-03-25 16:56:47 +01:00
awesome.1.txt Fix SEE ALSO section 2008-03-23 15:52:20 +01:00
awesome.c Fix -c option, and make -k accept -c option better 2008-03-23 21:35:34 +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 [doc] Add autogeneration of options documentation 2008-03-27 16:48:52 +01:00
awesomerc.in Add icons in dist tarball and in default statusbar 2008-03-25 16:59:51 +01:00
client.c [titlebar] Check if titlebar was created before unmaping it 2008-03-27 17:01:57 +01:00
client.h client_focus() now return bool to indicate if it has given focus 2008-03-25 11:28:38 +01:00
config.c Add alignment attribute to titlebar 2008-03-24 17:42:45 +01:00
config.h Remove useless ; after DO_SLIST macro 2008-03-23 15:52:17 +01:00
configure.ac Switch pack name to lowercase 2008-03-24 15:12:31 +01:00
event.c [event] Add more comment about the Bob Marley algorithm 2008-03-26 16:57:50 +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 [ewmh] Use premul alpha for net_wm_icons 2008-03-26 10:26:08 +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 Allow skip to be focused (by mouse) but refuse to focus them if they're newcomer 2008-03-24 10:58:32 +01:00
layout.h Update various copyrights 2008-03-23 15:52:19 +01:00
mouse.c Add window indicating size and position on move and resize (FS#107) 2008-03-25 16:10:12 +01:00
mouse.h Update various copyrights 2008-03-23 15:52:19 +01:00
placement.c [placement] Fix smart placement with window which had titlebars 2008-03-27 10:38:33 +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 additional line width argument to draw_rectangle[_gradient] in draw.c 2008-03-23 15:52:22 +01:00
statusbar.h Update various copyrights 2008-03-23 15:52:19 +01:00
structs.h Add alignment attribute to titlebar 2008-03-24 17:42:45 +01:00
tag.c [uicb] uicb_client_toggletag() with NULL use as sticky toggle 2008-03-26 09:06:53 +01:00
tag.h Clean EWMH desktop calls 2008-03-23 15:52:22 +01:00
titlebar.c [doc] Autogenerate documentation for uicb from source code 2008-03-27 15:00:46 +01:00
titlebar.h [titlebar] Fix resize_hints usage with titlebar 2008-03-26 10:57:06 +01:00
uicb.c [doc] Autogenerate documentation for uicb from source code 2008-03-27 15:00:46 +01:00
uicb.h Add uicb_restart to restart awesome with the real command line 2008-03-23 15:52:22 +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 Change opacity between 0 and 1 and update validation 2008-03-24 07:47:07 +01:00
window.h Normalize some window functions protos 2008-03-23 15:52:22 +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.