Go to file
Emmanuel Lepage Vallee e309059f4c doc: Add more example to awful.client. 2020-01-19 02:58:49 -05:00
build-utils build: Configure the `ruled` module dependency graph. 2020-01-19 02:39:30 -05:00
common capi: Move from `.data` to `._private` for the property data. 2019-11-09 16:43:12 -05:00
docs doc: Add a flowchart for ruled.client. 2020-01-19 02:58:46 -05:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib doc: Add more example to awful.client. 2020-01-19 02:58:49 -05:00
manpages Apply suggestions from code review 2019-09-30 00:49:40 -04:00
objects doc: Add documentation in each objects which emit request:: signals. 2020-01-11 15:43:31 -08:00
spec awful: Rename awful.ewmh to awful.permissions. 2020-01-11 15:43:30 -08:00
tests tests: Port the hardcoded awful.rules test to the sequence template. 2020-01-19 02:58:41 -05:00
themes client: Turn `rc.lua` logic into a new `request::border` signal. 2020-01-11 15:43:11 -08:00
utils awesome-client: handle multiple args (#2551) 2019-01-10 19:10:11 +01: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 awful: Set a miss handler for capi.root 2019-10-05 18:06:50 -04:00
.luacov Travis: codecov: use -f with luacov output (#2563) 2019-01-10 10:56:39 +01:00
.mergify.yml ci: mergify: update for Travis, remove Codacy (#2627) 2019-01-29 12:53:24 +01:00
.travis.yml refactor(test: awesomerc: hotkeys): imitate fake vim client instead of depending on vim as test dep 2019-10-18 19:02:47 +02:00
AutoOption.cmake CMake: Add "AUTO" state for WITH_DBUS and GENERATE_MANPAGES 2019-02-19 07:55:41 +01:00
CMakeLists.txt tests: Use --screen manual for both code coverage jobs. 2019-09-29 18:56:06 -04: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 Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
awesome.c Allow `getopt_long` call to manage the `-m` option (short of `--screen`). 2019-09-30 15:53:21 +02: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 Use xcb-errors library if it is available 2019-03-03 09:15:29 +01:00
awesomerc.lua autofocus: Modify `awful.autofocus` to be a request::. 2020-01-11 15:43:15 -08: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 Merge pull request #2207 from psychon/alpha_borders 2018-04-22 02:02:10 -04: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 client: Rename the `manage` and `unmanage` signals. 2020-01-11 14:43:56 -08:00
event.h XKB update: Use an idle source 2019-02-18 13:45:34 +01:00
ewmh.c Add more TOVOv5 for unfixable APIs. 2020-01-11 15:43:31 -08:00
ewmh.h C code: save all instead of just one client icons 2017-03-07 22:45:49 +01:00
globalconf.h init: Add a command line option to start AwesomeWM without screens. 2019-09-29 18:52:00 -04: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 root: Add support for setting a miss handler. 2019-10-05 18:06:50 -04:00
luaa.h Migrate a bit away from luaL_register(). 2019-02-16 14:25:20 +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 Fix ldoc modules summaries missing the final `.`. 2019-11-28 13:53:59 +01:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01: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 Fix ldoc modules summaries missing the final `.`. 2019-11-28 13:53:59 +01: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 Make alpha work on window borders 2018-03-03 10:57:48 +01: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
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, 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

NOTE: Awesome uses cmake to build. In case you want to pass arguments to cmake, please use the CMAKE_ARGS environment variable. For instance:

CMAKE_ARGS="-DCMAKE_INSTALL_PREFIX=/opt/awesome" make

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

Build dependencies

Awesome has the following dependencies (besides a more-or-less standard POSIX environment):

Additionally, the following optional dependencies exist:

  • DBus for DBus integration and the awesome-client utility
  • asciidoctor for generating man pages
  • gzip for compressing man pages
  • ldoc >= 1.4.5 for generating the documentation
  • busted for running unit tests
  • luacheck for static code analysis
  • LuaCov for collecting code coverage information
  • libexecinfo on systems where libc does not provide backtrace_symbols() to generate slightly better backtraces on crashes
  • Xephyr or Xvfb for running integration tests
  • GTK+ >= 3.10 for ./themes/gtk/
  • xcb-errors for pretty-printing of X11 errors
  • libRSVG for displaying SVG files without scaling artifacts
  • wmctrl for testing WM interactions with external actions
  • xterm for various test cases

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