Go to file
Julien Danjou 7fc41ca7cf [xutil] Fix typo
Signed-off-by: Julien Danjou <julien@danjou.info>
2008-05-28 07:31:09 +02:00
build-utils [build] List all function in manpage 2008-05-26 20:24:30 +02:00
common [xutil] Fix typo 2008-05-28 07:31:09 +02:00
icons Add icons in dist tarball and in default statusbar 2008-03-25 16:59:51 +01:00
layouts [max] Only raise if focused window is tiled 2008-05-27 22:04:41 +02:00
widgets [taglist] Add show_empty option 2008-05-27 18:40:41 +02:00
.gitignore [doc] Add new Lua based documentation generator for API 2008-05-26 15:25:40 +02:00
AUTHORS [authors] Add Arnaud Fontaine 2008-05-03 12:01:01 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile.am [layouts] Add magnifier layout 2008-05-27 20:54:53 +02:00
README [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
STYLE Fix STYLE file to reflect current style [CORRECTIVE] 2008-03-24 07:49:33 +01:00
as_ac_expand.m4 [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
autogen.sh Honor GIT_DIR setting when determining version 2008-01-30 09:22:45 +01:00
awesome-client.1.txt [awesome-client] Replace deprecated client_zoom by client_swap in documentation 2008-05-11 17:56:34 +01:00
awesome-client.c [util] warn() and eprint() now print \n 2008-05-23 22:56:05 +02:00
awesome.1.txt [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
awesome.c Revert "[lua] Add a hook on standard fd activity" 2008-05-27 16:36:06 +02:00
awesome.doxygen.in [doc] Generate doc for widgets/layouts/common 2008-05-02 10:55:46 +02:00
awesomerc.5.txt [doc] Add header in API section 2008-05-26 20:24:26 +02:00
awesomerc.lua.in [awesomerc] Make layout box clickable by default 2008-05-28 06:53:49 +02:00
awful.lua [lua] Split screen.* out of awesome.* 2008-05-27 16:07:17 +02:00
client.c [client] Need arrange on focus 2008-05-27 21:46:13 +02:00
client.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
cnode.c [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
cnode.h [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
configure.ac [build] Use good path to Lua interpreter 2008-05-27 10:57:58 +02:00
dbus.c Rename AwesomeConf to awesome_t 2008-05-24 08:59:27 +02:00
dbus.h [dbus] Poll on dbus connection fd 2008-05-03 12:01:06 +02:00
event.c [statusbar] Fix potential error if statusbar is Off on start 2008-05-27 15:21:27 +02:00
event.h [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
ewmh.c Revert "[client] Remove ismax attribute." 2008-05-25 17:42:20 +02:00
ewmh.h [client] Rename Client type to client_t 2008-05-03 12:01:03 +02:00
focus.c [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
focus.h [focus] Split client_node functions out 2008-05-25 18:12:27 +02:00
layout.c [layout] Arrange after focus is gave 2008-05-27 20:52:55 +02:00
layout.h [layout] Stop starting a thread for layout freshing 2008-05-27 11:01:57 +02:00
lua.c [lua] Finish screen luaL_reg with NULL 2008-05-28 06:49:32 +02:00
lua.h [util] warn() and eprint() now print \n 2008-05-23 22:56:05 +02:00
mouse.c [layout] Stop starting a thread for layout freshing 2008-05-27 11:01:57 +02:00
mouse.h [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
placement.c Rename AwesomeConf to awesome_t 2008-05-24 08:59:27 +02:00
placement.h add under_mouse placement aglo 2008-02-13 18:14:34 +01:00
screen.c Revert "[client] Remove ismax attribute." 2008-05-25 17:42:20 +02:00
screen.h [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
stack.c [client] Add proper stacking support 2008-05-25 19:32:30 +02:00
stack.h [client] Add proper stacking support 2008-05-25 19:32:30 +02:00
statusbar.c Revert "[lua] Add a hook on standard fd activity" 2008-05-27 16:36:06 +02:00
statusbar.h [statusbar] Implement multi-threading per statusbar 2008-05-27 11:17:51 +02:00
structs.h Revert "[lua] Add a hook on standard fd activity" 2008-05-27 16:36:06 +02:00
tag.c [layouts] Add magnifier layout 2008-05-27 20:54:53 +02:00
tag.h Revert "[client] Remove ismax attribute." 2008-05-25 17:42:20 +02:00
titlebar.c Rename AwesomeConf to awesome_t 2008-05-24 08:59:27 +02:00
titlebar.h [everything] Switch from libconfuse to Lua 2008-05-20 18:01:15 +02:00
widget.c [statusbar] Implement multi-threading per statusbar 2008-05-27 11:17:51 +02:00
widget.h [widget] Rename WidgetConstructor to widget_constructor_t 2008-05-25 14:07:01 +02:00
window.c [client] Rework raise and mouse stuff 2008-05-26 18:08:29 +02:00
window.h [mouse] Rename Button to button_t 2008-05-23 15:12:01 +02: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, xcb and xcb-util.
  - Lua 5.1
  - cairo
  - pango and pangocairo
  - glib
  - GTK+ or Imlib2 (use --with-imlib2 with ./configure)
  - dbus

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.lua file.
An example is provided in the sources.