Go to file
Hans Ulrich Niedermann 593f92c24d Check whether 'xmlto man' actually works
If xmlto is present, create a very simple example man page by
running 'xmlto man'. Only generate man pages at "make all" time
if this works.

The check is a little lenthy, so we might want to put it into
a separate .m4 file some time.

Signed-off-by: Julien Danjou <julien@danjou.info>
2008-02-11 11:06:35 +01:00
build-utils Honor GIT_DIR setting when determining version 2008-01-30 09:22:45 +01:00
common return the right buffer, iconv modify one 2008-02-11 10:52:05 +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 change focus raising 2008-02-09 23:12:40 +01:00
.gitignore remove awesome-check 2008-01-31 10:43:31 +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 Check whether 'xmlto man' actually works 2008-02-11 11:06:35 +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 an emtpy line flushes data into awesome (in awesome-client) 2008-01-10 07:10:35 +01:00
awesome-client.c rework include 2008-01-29 11:27:14 +01:00
awesome-message.c use PROGNAME 2008-02-08 11:51:40 +01:00
awesome.1.txt remove awesome-check, move that to an -k option to awesome 2008-01-31 10:21:03 +01:00
awesome.c drop error about killing client already killed 2008-02-08 16:06:01 +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.1.txt add align option to widget to specify their alignment 2008-02-08 10:59:55 +01:00
awesomerc.in add scratch window support 2008-02-06 09:06:43 +01:00
client.c change focus raising 2008-02-09 23:12:40 +01:00
client.h add scratch window support 2008-02-06 09:06:43 +01:00
config.c switch KeySym to KeyCode 2008-02-08 14:35:32 +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 change focus raising 2008-02-09 23:12:40 +01:00
event.h add 2008 copyright notice 2008-01-02 16:59:43 +01:00
ewmh.c rename some screens function 2008-01-30 09:36:52 +01:00
ewmh.h rework include 2008-01-29 11:27:14 +01:00
focus.c change focus raising 2008-02-09 23:12:40 +01:00
focus.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
layout.c call grab with phys_screen 2008-02-11 09:32:22 +01:00
layout.h fix handling of window raisings 2008-01-25 23:43:16 +01:00
mouse.c rename some screens function 2008-01-30 09:36:52 +01:00
mouse.h move define 2008-01-29 08:23:20 +01:00
rules.c introduce fuzzy logic: fix problem with not_master 2008-02-05 17:31:47 +01:00
rules.h introduce fuzzy logic: fix problem with not_master 2008-02-05 17:31:47 +01:00
screen.c change focus raising 2008-02-09 23:12:40 +01:00
screen.h rename some screens function 2008-01-30 09:36:52 +01:00
statusbar.c add align option to widget to specify their alignment 2008-02-08 10:59:55 +01:00
statusbar.h preinit in config.c 2008-01-21 16:31:14 +01:00
structs.h switch KeySym to KeyCode 2008-02-08 14:35:32 +01:00
tag.c fix was_selected tag attribute handling 2008-02-04 14:32:06 +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 align option to widget to specify their alignment 2008-02-08 10:59:55 +01:00
widget.h rename netwmicon to focusicon 2008-02-06 20:13:41 +01:00
window.c rework include 2008-01-29 11:27:14 +01:00
window.h split out simple window handling 2008-01-26 17:58:01 +01:00
xutil.c unban() all clients before execing or quitting awesome 2008-02-04 14:43:20 +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.