475b469f96
Closes https://github.com/awesomeWM/awesome/pull/379. |
||
|---|---|---|
| build-tests | ||
| build-utils | ||
| common | ||
| docs | ||
| icons | ||
| lib | ||
| manpages | ||
| objects | ||
| spec | ||
| tests | ||
| themes | ||
| utils | ||
| .gitignore | ||
| .travis.yml | ||
| CMakeLists.txt | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| awesome-version-internal.h | ||
| awesome.c | ||
| awesome.desktop | ||
| awesome.h | ||
| awesomeConfig.cmake | ||
| awesomerc.lua | ||
| banning.c | ||
| banning.h | ||
| color.c | ||
| color.h | ||
| config.h | ||
| dbus.c | ||
| dbus.h | ||
| draw.c | ||
| draw.h | ||
| event.c | ||
| event.h | ||
| ewmh.c | ||
| ewmh.h | ||
| globalconf.h | ||
| keygrabber.c | ||
| keygrabber.h | ||
| luaa.c | ||
| luaa.h | ||
| mouse.c | ||
| mouse.h | ||
| mousegrabber.c | ||
| mousegrabber.h | ||
| property.c | ||
| property.h | ||
| root.c | ||
| selection.c | ||
| selection.h | ||
| spawn.c | ||
| spawn.h | ||
| stack.c | ||
| stack.h | ||
| strut.c | ||
| strut.h | ||
| systray.c | ||
| systray.h | ||
| xkb.c | ||
| xkb.h | ||
| xrdb.c | ||
| xrdb.h | ||
| xwindow.c | ||
| xwindow.h | ||
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, 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 @{02-contributing.md} guide for any coding, documentation or patch guidelines.
Status
Documentation
Online documentation is available at http://awesome.naquadah.org/doc/, and
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).