Go to file
Hans Ulrich Niedermann ad28e78d13 Use pre-defined values for build infos (ifdef)
Use information autoconf determines anyway (machine type
building for, name of machine building on).

Only print build information if it is actually available (defined).

Add descriptions to all AC_DEFINE* macro definitions.

Signed-off-by: Julien Danjou <julien@danjou.info>
2008-01-25 12:10:32 +01:00
build-utils move gen scripts in build-utils 2008-01-21 16:31:14 +01:00
common move draw files to common/ 2008-01-24 18:48:11 +01:00
icons/layouts rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
layouts move list.h and util.[ch] to common/ 2008-01-21 18:14:59 +01:00
widgets remove selscreen arg 2008-01-24 23:48:35 +01:00
.gitignore ignore layoutgen.h 2008-01-21 16:31:15 +01:00
AUTHORS add 2008 copyright notice 2008-01-02 16:59:43 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile.am move draw files to common/ 2008-01-24 18:48:11 +01:00
README More detailed elaboration on build requirements 2008-01-09 17:45:36 +01:00
STYLE The preferred line length is 80 characters. 2007-12-18 11:27:26 +01:00
autogen.sh Add version generation script, version stamp file 2008-01-15 08:21:43 +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 move list.h and util.[ch] to common/ 2008-01-21 18:14:59 +01:00
awesome-client.h add 2008 copyright notice 2008-01-02 16:59:43 +01:00
awesome.1.txt document new layouts 2008-01-15 08:34:17 +01:00
awesome.c Use pre-defined values for build infos (ifdef) 2008-01-25 12:10:32 +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 remove opacity_unfocused 2008-01-24 23:45:04 +01:00
awesomerc.in rename tileup/down to top/bottom 2008-01-21 16:31:15 +01:00
client.c do not drop XSetInputFocus errors; but we can not give focus to unmapped windows 2008-01-25 09:37:41 +01:00
client.h remove selscreen arg 2008-01-24 23:48:35 +01:00
config.c remove opacity_unfocused 2008-01-24 23:45:04 +01:00
config.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
configure.ac Use pre-defined values for build infos (ifdef) 2008-01-25 12:10:32 +01:00
event.c remove selscreen arg 2008-01-24 23:48:35 +01:00
event.h add 2008 copyright notice 2008-01-02 16:59:43 +01:00
ewmh.c fullscreen respect padding 2008-01-23 17:01:39 +01:00
ewmh.h move NetWMIcon get to ewmh.c 2008-01-03 19:02:23 +01:00
focus.c remove selscreen arg 2008-01-24 23:48:35 +01:00
focus.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
layout.c remove selscreen arg 2008-01-24 23:48:35 +01:00
layout.h move draw files to common/ 2008-01-24 18:48:11 +01:00
mouse.c raise window on move 2008-01-24 22:22:52 +01:00
mouse.h replace UICB_PROTO macro by a typedef 2008-01-01 17:25:48 +01:00
rules.c move list.h and util.[ch] to common/ 2008-01-21 18:14:59 +01:00
rules.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
screen.c remove selscreen arg 2008-01-24 23:48:35 +01:00
screen.h detect clone screens (FS#42) 2008-01-22 20:41:10 +01:00
statusbar.c fix bar left position 2008-01-24 23:25:12 +01:00
statusbar.h preinit in config.c 2008-01-21 16:31:14 +01:00
structs.h remove opacity_unfocused 2008-01-24 23:45:04 +01:00
tag.c add tag_view_byinde() 2008-01-23 08:45:02 +01:00
tag.h add tag_view_byinde() 2008-01-23 08:45:02 +01:00
uicb.c rename nscreens to nscreen 2008-01-24 13:48:49 +01:00
uicb.h replace UICB_PROTO macro by a typedef 2008-01-01 17:25:48 +01:00
widget.c break on first button found 2008-01-23 08:47:46 +01:00
widget.h split config.h, and move DO_SLIST() 2008-01-21 16:31:14 +01:00
window.c kick out rotate option 2008-01-24 10:37:16 +01:00
window.h kick out rotate option 2008-01-24 10:37:16 +01:00
xutil.c move list.h and util.[ch] to common/ 2008-01-21 18:14:59 +01:00
xutil.h add Display as arg 2008-01-21 16:31:14 +01:00

README

awesome
=======
awesome is an extremely fast, small, and dynamic window manager for X.
It's based on dwm.

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.