Go to file
Daniel Hahler 9dad4f59a4 doc: remove references to Zaphod mode
This has been removed a long time ago (in 32d9a5b).
2015-07-24 15:22:03 +02:00
build-tests use CMake check_function_exists() for execinfo 2010-10-11 22:52:20 +02:00
build-utils Improve git-version-stamp's error messages 2015-06-10 19:41:48 +02:00
common minor: fix/improve doc comments 2015-07-12 17:42:53 +02:00
docs doc: improve docs/02-contributing.md 2015-07-12 17:42:53 +02:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib doc: fix invalid @see references to URLs 2015-07-24 01:56:36 +02:00
manpages Remove F1-9 bindings from the manpages. 2013-03-10 11:22:35 +01:00
objects doc: remove references to Zaphod mode 2015-07-24 15:22:03 +02:00
spec gears.object: Add :weak_connect_signal() 2015-06-25 06:37:04 +02:00
tests tests/_runner.lua: use xpcall+traceback with step error handler 2015-07-22 13:52:47 +02:00
themes feat(themes): add 'useless_gap' prop to all themes 2015-07-03 00:20:28 +02:00
utils Improved awesome-client: exit code, bash, prompt 2015-07-14 00:24:33 +02:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
.travis.yml travis: unpin luassert 2015-07-10 15:54:26 +02:00
CMakeLists.txt Add DPI support and 'xresources' theme 2015-06-25 06:40:38 +02: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
README.md Add README.md symlink 2015-02-28 23:14:13 +01:00
awesome-version-internal.h Remove the *.in from all files. 2015-06-19 22:33:32 +02:00
awesome.c Add DPI support and 'xresources' theme 2015-06-25 06:40:38 +02: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 Merge pull request #273 from blueyed/cmake-no-recurse-into-build-dir 2015-07-03 19:11:09 +02:00
awesomerc.lua Add awful.screen.focused [FS#1029] 2015-07-21 12:51:45 +02: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 Remove the *.in from all files. 2015-06-19 22:33:32 +02:00
dbus.c Document C API directly in the C source code 2015-06-19 23:13:31 +02:00
dbus.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
draw.c Merge pull request #142 from psychon/check-cairo-setup 2015-02-18 21:37:56 +01:00
draw.h Test if cairo-xcb is usable during startup 2015-02-18 21:23:47 +01:00
event.c Use luaA_dofunction with key- and mousegrabber 2015-07-22 13:52:47 +02:00
event.h Clean up header includes 2014-03-30 20:07:48 +02:00
ewmh.c Add support for _NET_FRAME_EXTENTS 2015-07-05 14:45:51 +02:00
ewmh.h Clean up header includes 2014-03-30 20:07:48 +02:00
globalconf.h Add DPI support and 'xresources' theme 2015-06-25 06:40:38 +02:00
keygrabber.c minor: fix/improve doc comments 2015-07-12 17:42:53 +02:00
keygrabber.h Clean up header includes 2014-03-30 20:07:48 +02:00
luaa.c Add DPI support and 'xresources' theme 2015-06-25 06:40:38 +02:00
luaa.h Use luaL_traceback with luaA_warn and luaA_typerror 2015-07-22 13:52:47 +02:00
mouse.c Document mouse.coords().buttons 2015-07-05 16:21:30 +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 Merge pull request #122 from blueyed/fix-ldoc-doxygen-warnings 2015-02-15 11:49:50 +01:00
property.h Clean up header includes 2014-03-30 20:07:48 +02:00
root.c Document C API directly in the C source code 2015-06-19 23:13:31 +02:00
selection.c Document C API directly in the C source code 2015-06-19 23:13:31 +02:00
selection.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
spawn.c doc: remove references to Zaphod mode 2015-07-24 15:22:03 +02: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 remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
strut.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.c Hide globalconf.L 2014-12-06 11:56:58 +01:00
systray.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
xkb.c Document C API directly in the C source code 2015-06-19 23:13:31 +02:00
xkb.h Less reloading of keymap, fixes from psychon comments 2015-05-28 23:20:17 +02:00
xrdb.c minor: fix/improve doc comments 2015-07-12 17:42:53 +02:00
xrdb.h Add DPI support and 'xresources' theme 2015-06-25 06:40:38 +02:00
xwindow.c minor: formatting 2015-03-28 22:17:45 +01:00
xwindow.h Clean up header includes 2014-03-30 20:07:48 +02: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 install:

make install  # you might need root permissions

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.

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

Troubleshooting

In most systems any message printed by awesome (including warnings and errors) are written to $HOME/.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 @{02-contributing.md} guide for any coding, documentation or patch guidelines.

Status

Build Status

License

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