Go to file
h 71d3ea6caf gap_mult_client support 2022-04-04 15:24:46 +08:00
.github fix(gh-actions): s/git_url/clone_url/g (#3593) 2022-03-20 18:56:13 +01:00
build-utils chore(github_actions): Remove Travis files 2021-05-06 20:04:56 +02:00
common Move variable declarations from header to C file to fix build with GCC 10 2020-04-17 19:25:40 +02:00
docs fix: Docs update to specify rule callback as being run before properties applied 2021-12-23 14:02:24 -08:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib gap_mult_client support 2022-04-04 15:24:46 +08:00
manpages Make easier to cut-n-paste 2020-10-09 11:30:17 -07:00
objects Relocate a client window as if it is undecorated when reparenting it back. It eliminates the position offset due to re-decorating when a client trys to restore its previous position. (#3253) 2022-02-02 22:59:01 +01:00
spec Multi-row support of systray by taking a beautiful variable specifying the maximum number of rows to fill per column. (#3520) 2021-12-30 13:22:31 -08:00
tests [CI] Run `Run examples tests` on every supported Lua Version (#3575) 2022-03-06 14:04:50 +01:00
themes refactor(theme): remove mouse finder remnants 2022-02-13 15:49:40 +03:00
utils Replace /usr/bin/which with command -v (#3439) 2021-09-20 10:21:43 -07:00
.busted tests: busted: add config file, use --verbose by default (#2076) 2017-10-22 18:05:00 +02:00
.editorconfig Add an EditorConfig file 2015-12-12 17:48:42 +01:00
.gitignore luacheck: enable cache (#2004) 2017-08-20 22:50:30 +02:00
.luacheckrc docs(github_actions): Remove Travis references 2021-05-06 20:05:02 +02:00
.luacov Travis: codecov: use -f with luacov output (#2563) 2019-01-10 10:56:39 +01:00
.mergify.yml fix(mergify) check-success (#3570) 2022-03-05 12:12:14 -08:00
AutoOption.cmake CMake: Add "AUTO" state for WITH_DBUS and GENERATE_MANPAGES 2019-02-19 07:55:41 +01:00
CMakeLists.txt build: Fix a recent regression when tests are built. 2021-11-13 19:28:12 -08:00
ISSUE_TEMPLATE.md Add an ISSUE_TEMPLATE.md file (#997) 2016-07-09 19:18:02 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile Minor: typos, Makefile aesthetics (#2690) 2019-02-22 08:42:43 +01:00
Packaging.cmake Packaging.cmake: cache CPACK_GENERATOR (#1924) 2017-07-21 01:06:59 +02:00
README.md Add README.md symlink 2015-02-28 23:14:13 +01:00
awesome-version-internal.h init: Add an API level concept to `capi`. 2020-02-08 17:18:01 -05:00
awesome.c Merge pull request #3553 from Aire-One/feat/lua54 2022-02-02 14:08:50 -08:00
awesome.desktop Remove deprecated Encoding key from awesome.desktop (#1394) 2017-01-13 22:21:50 +01:00
awesome.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomeConfig.cmake chore: Allow Lua 5.4 to build and run 2022-01-22 17:47:57 +01:00
awesomerc.lua rc.lua: Switch to awful.wallpaper 2021-09-24 08:42:42 -07:00
banning.c Fix recursive enterleave ignore (#1747) 2017-04-21 18:53:25 +02:00
banning.h Clean up header includes 2014-03-30 20:07:48 +02:00
color.c Fix some spelling errors (#3450) 2021-10-04 19:20:03 -07:00
color.h Correctly convert colors with alpha to a Lua string 2018-03-03 10:57:48 +01:00
config.h Use xcb-errors library if it is available 2019-03-03 09:15:29 +01:00
dbus.c dbus.c: Handle invalid bus names 2019-05-05 12:48:34 +02:00
dbus.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
draw.c Add awesome.pixbuf_to_surface 2018-01-18 18:10:35 +01:00
draw.h Add awesome.pixbuf_to_surface 2018-01-18 18:10:35 +01:00
event.c Refocus focused window for focus in events on the root window. (#3543) 2022-01-22 03:28:24 -08:00
event.h XKB update: Use an idle source 2019-02-18 13:45:34 +01:00
ewmh.c Fix _NET_CURRENT_DESKTOP ClientMessage handling (#3237) 2021-04-25 15:33:39 -07:00
ewmh.h C code: save all instead of just one client icons 2017-03-07 22:45:49 +01:00
globalconf.h cmd: Add more info to --version. 2020-02-08 17:18:01 -05:00
keygrabber.c keygrabber: Refactor to be an object instead of a function. 2018-08-06 19:03:25 -04:00
keygrabber.h Clean up header includes 2014-03-30 20:07:48 +02:00
luaa.c Fix some spelling errors (#3450) 2021-10-04 19:20:03 -07:00
luaa.h chore: Allow Lua 5.4 to build and run 2022-01-22 17:47:57 +01:00
mouse.c doc: Modify the template to allow merging sections. 2019-11-03 01:28:29 -05:00
mouse.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
mousegrabber.c doc(mousegrabber): Improve cursor list 2021-07-31 15:04:54 +02:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
options.c Fix some spelling errors (#3450) 2021-10-04 19:20:03 -07:00
options.h modeline: Check the first XDG and fallback paths for modelines. (#3172) 2020-09-14 11:02:09 -07:00
property.c Add more TOVOv5 for unfixable APIs. 2020-01-11 15:43:31 -08:00
property.h Add support for motif wm hints 2018-08-03 19:19:43 +02:00
root.c Update root.c 2021-10-04 19:49:22 -07:00
selection.c doc: Use an explicit tag for all static functions. 2019-06-08 18:14:13 -04:00
selection.h Move setup of selection() to selection.c 2019-02-16 15:44:42 +01:00
spawn.c doc: Use an explicit tag for all static functions. 2019-06-08 18:14:13 -04:00
spawn.h Handle SIGCHLD ourselves instead of through GLib 2018-08-21 15:30:07 +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 geometry: Use the relevant rounding functions instead of integers 2016-04-18 04:20:22 -04:00
strut.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.c Multi-row support of systray by taking a beautiful variable specifying the maximum number of rows to fill per column. (#3520) 2021-12-30 13:22:31 -08:00
systray.h Remove unused argument to systray_request_handle() 2016-05-29 14:33:23 +02:00
xkb.c doc: Use an explicit tag for all static functions. 2019-06-08 18:14:13 -04:00
xkb.h XKB update: Use an idle source 2019-02-18 13:45:34 +01:00
xkb_utf32_to_keysym_compat.c Quick fix to support libxkbcommon >= 1.0. 2020-09-13 21:54:56 -07:00
xrdb.c Don't print warnings for non-existing xrdb values 2017-05-24 10:06:24 +02:00
xrdb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xwindow.c xwindow_translate_for_gravity: Change instead of set argument 2018-08-17 09:58:30 +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 or cloning the repository, run:

make
sudo make install

This will

  1. create a build directory at ./build,
  2. run cmake,
  3. build Awesome and
  4. install it to the default prefix path /usr/local.

Alternatively to the above, you can generate a .deb or .rpm package, for easy installation management:

make package

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

Advanced options and testing

A full list of dependencies, more advanced build options, as well as instructions on how to use the test suite can be found here.

Installing current git master as a package receipts

Arch Linux AUR

sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/awesome-git.git
cd awesome-git
makepkg -fsri

Debian-based

sudo apt build-dep awesome
git clone https://github.com/awesomewm/awesome
cd awesome
make package
sudo apt install *.deb

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 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.

Debugging tips

You can call awesome with gdb like this:

DISPLAY=:2 gdb awesome

Then in gdb set any arguments and run it:

(gdb) set args --replace
(gdb) run

Asking questions

IRC

You can join us in the #awesome channel on the OFTC IRC network.

IRC Webchat

Stack Overflow

You can ask questions on Stack Overflow.

Reddit

We also have a awesome subreddit where you can share your work and ask questions.

Reporting issues

Please report any issues you may find on our bugtracker.

Contributing code

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 here.

License

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