Go to file
Uli Schlachter 3f40183177 naughty: Use connect_for_each_screen()
Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-03-27 10:51:28 +02:00
build-tests Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
build-utils Add vim modelines to all shell scripts 2015-12-12 17:36:35 +01:00
common Merge branch 'lua-index-handlers' of https://github.com/psychon/awesome 2016-03-06 14:19:00 +01:00
docs Run shape-example-generation under LuaCov 2016-03-17 10:22:42 +01:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib naughty: Use connect_for_each_screen() 2016-03-27 10:51:28 +02:00
manpages Document "--replace" better 2015-10-11 15:00:08 +02:00
objects screen: Add "added" signal 2016-03-27 10:51:28 +02:00
spec Merge pull request #709 from psychon/implement-set-children-sanely 2016-03-03 02:06:58 -05:00
tests C-API: Return screen objects instead of indicies 2016-03-26 18:09:24 +01:00
themes Themes: Use "local" 2016-02-11 21:55:08 +01:00
utils Add vim modelines to all shell scripts 2015-12-12 17:36:35 +01:00
.editorconfig Add an EditorConfig file 2015-12-12 17:48:42 +01:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
.luacheckrc Add& use Luacheck support 2016-02-16 19:45:10 +01:00
.luacov Run shape-example-generation under LuaCov 2016-03-17 10:22:42 +01:00
.travis.yml Run shape-example-generation under LuaCov 2016-03-17 10:22:42 +01:00
CMakeLists.txt dont add timestamps to created images 2016-03-20 16:22:52 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile Makefile: add "tags" to .PHONY targets 2015-07-11 22:50:11 +02:00
Packaging.cmake implement basic DEB packaging 2016-02-28 20:07:54 +11:00
README.md Add README.md symlink 2015-02-28 23:14:13 +01:00
awesome-version-internal.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
awesome.c cmd: Document --no-argb in --help 2016-03-22 03:27:59 -04:00
awesome.desktop Remove NoDisplay from desktop file 2013-02-25 11:50:00 +01:00
awesome.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomeConfig.cmake cmake: Generate gears.shape SVG and example code 2016-03-16 18:02:41 -04:00
awesomerc.lua Merge pull request #746 from psychon/indexless-screen-iteration 2016-03-07 00:26:22 +01:00
banning.c doc: fix warnings from doxygen 2015-02-14 20:17:13 +01:00
banning.h Clean up header includes 2014-03-30 20:07:48 +02:00
color.c Clean up header includes 2014-03-30 20:07:48 +02:00
color.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
config.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
dbus.c dbus.c: Check string return values properly 2016-03-06 11:16:49 +01:00
dbus.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
draw.c awesome.load_image(): Return errors instead of "throwing" them 2016-01-15 18:38:51 +01:00
draw.h awesome.load_image(): Return errors instead of "throwing" them 2016-01-15 18:38:51 +01:00
event.c Fix stack handling on errors for the mouse grabber 2016-03-06 10:52:58 +01:00
event.h Lazily apply changes to border_width and border_color 2016-02-28 16:24:30 +01:00
ewmh.c Fix icons 2015-12-23 14:19:18 +01:00
ewmh.h add an option to set the preferred client icon size 2015-12-07 22:59:32 +01:00
globalconf.h Correctly set globalconf.primary_screen under RandR 2016-02-27 16:45:35 +01:00
keygrabber.c keygrabber: ignore modifiers for name of control keys 2015-08-10 23:05:16 +02:00
keygrabber.h Clean up header includes 2014-03-30 20:07:48 +02:00
luaa.c Add exclamation mark with error in luaA_dofunction_on_error 2016-03-06 14:46:45 +01:00
luaa.h Replace many pushnumber calls with pushinteger 2016-02-06 13:46:46 +01:00
mouse.c Update API doc for mouse.screen 2016-03-27 10:23:20 +02:00
mouse.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
mousegrabber.c Document C API directly in the C source code 2015-06-19 23:13:31 +02:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
property.c Update transient_for when a new window appears 2016-02-22 21:09:25 +01:00
property.h Clean up header includes 2014-03-30 20:07:48 +02:00
root.c Require "integer" instead of "number" in more places 2016-02-06 13:59:14 +01:00
selection.c Set WM_CLASS and WM_NAME on all our windows (#551) 2015-11-19 22:23:25 +01:00
selection.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
spawn.c Replace many pushnumber calls with pushinteger 2016-02-06 13:46:46 +01:00
spawn.h Clean up header includes 2014-03-30 20:07:48 +02:00
stack.c doc: fix warnings from doxygen 2015-02-14 20:17:13 +01:00
stack.h Clean up header includes 2014-03-30 20:07:48 +02:00
strut.c Require "integer" instead of "number" in more places 2016-02-06 13:59:14 +01:00
strut.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.c Unmap the systray immediately when it becomes empty 2016-01-15 17:21:26 +01:00
systray.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
xkb.c Make client key bindings for e.g. xeyes work again 2016-02-28 13:29:25 +01:00
xkb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xrdb.c Make xrdb_get_value() behave as documented 2016-02-29 11:13:58 +01:00
xrdb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xwindow.c Fix obvious typo in xwindow_translate_for_gravity() 2015-10-10 17:38:51 +02:00
xwindow.h Set WM_CLASS and WM_NAME on all our windows (#551) 2015-11-19 22:23:25 +01:00

README.md

Readme

About awesome

awesome is a highly configurable, next generation framework window manager for X.

Building and installation

After extracting the dist tarball, run:

make

This will create a build directory, run cmake in it and build awesome.

After building is finished, you can either install via make install:

make install  # you might need root permissions

or by auto-generating a .deb or .rpm package, for easy removal later on:

make package

sudo dpkg -i awesome-x.y.z.deb
# or
sudo rpm -Uvh awesome-x.y.z.rpm

Running awesome

You can directly select awesome from your display manager. If not, you can add the following line to your .xinitrc to start awesome using startx or to .xsession to start awesome using your display manager:

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 $XDG_CONFIG_HOME/awesome/rc.lua file, typically ~/.config/awesome/rc.lua.

An example configuration named awesomerc.lua.in is provided in the source.

Troubleshooting

On most systems any message printed by awesome (including warnings and errors) is written to ~/.xsession-errors.

If awesome does not start or the configuration file is not producing the desired results the user should examine this file to gain insight into the problem.

Reporting issues

Please report any issues you may find on our bugtracker. You can submit pull requests on the github repository. Please read the contributing guide for any coding, documentation or patch guidelines.

Status

Build Status

Documentation

Online documentation is available at http://awesome.naquadah.org/doc/ for the stable branch and at http://awesomewm.github.io/apidoc/ for the master branch. It can be built using make ldoc.

License

The project is licensed under GNU General Publice License v2 or later. You can read it online at (v2 or v3).