Go to file
Giuseppe Bilotta f22ef5014d Make beautiful fallback properly if Xft.dpi is missing
As documented in
<https://keithp.com/~keithp/talks/xtc2001/paper/xft.html#sec-editing>,
the fallback value for Xft.dpi should be the vertical DPI reported by X.
On Xorg, this will generally be 96, unless the user has overridden the
value by either forcing Xorg to report the EDID-derived DPI, or by
setting the DPI themselves (via configuration, command line, or xrandr).
The 96 value is kept as ultimate fallback if anything goes wrong.
2017-01-27 13:02:49 +01:00
build-utils travis-apidoc.sh: revert -B with git-checkout (#1431) 2017-01-22 22:52:16 +01:00
common Add fallbacks for when XKB is unavailable 2016-11-04 17:26:28 +01:00
docs change module to class when documention links to a class description (#1440) 2017-01-23 18:55:28 -05:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib Make beautiful fallback properly if Xft.dpi is missing 2017-01-27 13:02:49 +01:00
manpages Add missing $ for XDG_CONFIG_DIRS in manpages (#1311) 2016-12-27 16:29:45 +01:00
objects doc: Add missing dot 2017-01-22 09:35:44 -05:00
spec ci: overhaul coverage processing 2017-01-08 20:34:13 +01:00
tests Merge pull request #1198 from psychon/wibox-shape 2017-01-26 05:30:42 -05:00
themes prompt: Make awful.widget.prompt themeable 2017-01-23 13:15:09 +01:00
utils Remove traces of the old URL (#1280) 2016-12-21 02:03:03 +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 CI: fix new issues reported by luacheck 0.18.0 (#1383) 2017-01-10 17:44:53 +01:00
.luacov luacov: include everything 2017-01-08 20:34:13 +01:00
.travis.yml Do not cat luacov on travis, but test for it 2017-01-08 21:28:05 +01:00
CMakeLists.txt CMakeLists.txt: use source dir with check-unit/check-unit-coverage 2017-01-08 20:34:13 +01: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 Makefile: add "tags" to .PHONY targets 2015-07-11 22:50:11 +02:00
Packaging.cmake Fix "make package" with RPMs (#1370) 2017-01-08 23:44:07 +01: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 Initialise Lua later 2017-01-25 14:55:27 +01: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 awesomeConfig.cmake: docs/06-appearance.md depends on lgi-check (#1386) 2017-01-12 03:28:56 +01:00
awesomerc.lua Fix typo in awesomerc.lua (#1325) 2016-12-29 04:01:21 +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 Stop checking for __builtin_clz (#985) 2016-07-05 22:12:26 +02:00
dbus.c Remove @release @AWESOME_VERSION@ everywhere (#1157) 2016-10-09 22:36:20 +02: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 Update physical size on RRChangeNotifyEvent 2017-01-26 22:04:08 +01:00
event.h Delay client frame window destruction (#1148) 2016-10-07 00:46:57 +02:00
ewmh.c Initialise Lua later 2017-01-25 14:55:27 +01:00
ewmh.h Initialise Lua later 2017-01-25 14:55:27 +01:00
globalconf.h Add fallbacks for when XKB is unavailable 2016-11-04 17:26:28 +01:00
keygrabber.c Remove @release @AWESOME_VERSION@ everywhere (#1157) 2016-10-09 22:36:20 +02:00
keygrabber.h Clean up header includes 2014-03-30 20:07:48 +02:00
luaa.c Refactor config fallback 2017-01-25 14:10:19 +01:00
luaa.h Refactor config fallback 2017-01-25 14:10:19 +01:00
mouse.c Remove @release @AWESOME_VERSION@ everywhere (#1157) 2016-10-09 22:36:20 +02:00
mouse.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
mousegrabber.c Remove @release @AWESOME_VERSION@ everywhere (#1157) 2016-10-09 22:36:20 +02:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
property.c C: Remove unneeded calls to signal_add() 2016-06-04 17:57:08 +02:00
property.h Clean up header includes 2014-03-30 20:07:48 +02:00
root.c Add root.size_mm 2017-01-26 22:06:59 +01:00
selection.c Remove @release @AWESOME_VERSION@ everywhere (#1157) 2016-10-09 22:36:20 +02:00
selection.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
spawn.c Fix build on FreeBSD (#1381) 2017-01-13 22:23:49 +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 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 Properly support the XEMBED_MAPPED bit 2016-05-31 08:55:42 +02:00
systray.h Remove unused argument to systray_request_handle() 2016-05-29 14:33:23 +02:00
xkb.c Add fallbacks for when XKB is unavailable 2016-11-04 17:26:28 +01:00
xkb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xrdb.c Remove obsolete include and Xlib comment. 2017-01-05 23:17:11 +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

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

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
  • asciidoc and xmlto for generating man pages
  • gzip for compressing man pages
  • ldoc 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

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.

Debugging tips

You can call awesome with gdb like this:

DISPLAY=:2 gdb awesome

Then in gdb set any args and run it:

(gdb) set arg --replace
(gdb) run

Inside gdb you can use the following to print the current Lua stack traceback:

(gdb) print luaL_dostring(globalconf.L.real_L_dont_use_directly, "print(debug.traceback())")

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 https://awesomewm.org/apidoc/.

License

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