Go to file
Julien Danjou c1b503af1a Comment event.c functions 2008-03-06 09:05:15 +01:00
build-utils move awesomerc manpages to section 5 (File format) 2008-02-28 12:36:17 +01:00
common add comments for simplewindow functions 2008-03-01 11:25:04 +01:00
icons/layouts rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
layouts tag_setncol and tag_setnmaster shouldn't go over the numbers of clients 2008-02-05 14:21:20 +01:00
widgets textbox can be flex-aligned 2008-02-28 16:19:38 +01:00
.gitignore change awesomerc manpage ignore 2008-03-04 14:28:30 +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 do not use cfg_print() to generate default configuration file: fwrite() the default one 2008-02-29 15:36:13 +01:00
README add new awesome-check program to check configuration file syntax 2008-01-30 14:07:14 +01:00
STYLE The preferred line length is 80 characters. 2007-12-18 11:27:26 +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 move awesomerc manpages to section 5 (File format) 2008-02-28 12:36:17 +01:00
awesome-client.c rename awclient.[ch] to socket.[ch] 2008-02-27 09:07:52 +01:00
awesome-message.c rename awesome-version.[ch] to version.[ch] 2008-02-27 09:04:17 +01:00
awesome.1.txt move awesomerc manpages to section 5 (File format) 2008-02-28 12:36:17 +01:00
awesome.c ignore BadMatch error for XConfigureWindow() calls 2008-03-04 12:56:43 +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 add include() statement in awesomerc manpage 2008-02-29 09:55:39 +01:00
awesomerc.in add scratch window support 2008-02-06 09:06:43 +01:00
client.c Keep floating windows on top of the stack 2008-03-04 15:25:59 +01:00
client.h trailing whitespaces removed 2008-02-13 09:05:10 +01:00
config.c do not use cfg_print() to generate default configuration file: fwrite() the default one 2008-02-29 15:36:13 +01:00
config.h split out config stuff 2008-01-31 16:34:00 +01:00
configure.ac Check whether 'xmlto man' actually works 2008-02-11 11:06:35 +01:00
event.c Comment event.c functions 2008-03-06 09:05:15 +01:00
event.h replace drop_events arch by x,y pointer coordinates saving 2008-03-04 10:14:13 +01:00
ewmh.c fix screen_get_bycoord() 2008-02-25 13:40:30 +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 split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
layout.c remove {load,save}awesomeprops() 2008-02-12 15:43:57 +01:00
layout.h remove {load,save}awesomeprops() 2008-02-12 15:43:57 +01:00
mouse.c fix screen_get_bycoord() 2008-02-25 13:40:30 +01:00
mouse.h move define 2008-01-29 08:23:20 +01:00
placement.c finish list with NULL 2008-02-13 18:23:32 +01:00
placement.h add under_mouse placement aglo 2008-02-13 18:14:34 +01:00
rules.c trailing whitespaces removed 2008-02-13 09:05:10 +01:00
rules.h trailing whitespaces removed 2008-02-13 09:05:10 +01:00
screen.c fix screen_get_bycoord() 2008-02-25 13:40:30 +01:00
screen.h fix screen_get_bycoord() 2008-02-25 13:40:30 +01:00
statusbar.c trailing whitespaces removed 2008-02-13 09:05:10 +01:00
statusbar.h preinit in config.c 2008-01-21 16:31:14 +01:00
structs.h replace drop_events arch by x,y pointer coordinates saving 2008-03-04 10:14:13 +01:00
tag.c Fix segfault after viewing same tag twice and doing a tag_prev_selected. 2008-02-26 22:22:38 +01:00
tag.h rename get_current_tags to tags_get_current() 2008-01-29 08:31:13 +01:00
uicb.c add scratch window support 2008-02-06 09:06:43 +01:00
uicb.h replace UICB_PROTO macro by a typedef 2008-01-01 17:25:48 +01:00
widget.c add widget name in warnings 2008-02-28 16:19:03 +01:00
widget.h rename netwmicon to focusicon 2008-02-06 20:13:41 +01:00
window.c rename screen to phys_screen to avoid confusion 2008-02-25 13:33:29 +01:00
window.h split out simple window handling 2008-01-26 17:58:01 +01:00
xutil.c fix memory leak in smart_placement (with area_list_remove) and fix the algo 2008-02-11 17:15:28 +01:00
xutil.h rename initxcolor to draw_color_new() and move it to draw.c 2008-01-27 18:56:37 +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, 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.