Private fork of https://github.com/awesomeWM/awesome
42865a54ef
This is done with vim: ggVG:sort i (Yes, this is a case-insensitive sort) Signed-off-by: Uli Schlachter <psychon@znc.in> Signed-off-by: Julien Danjou <julien@danjou.info> |
||
|---|---|---|
| build-utils | ||
| common | ||
| icons | ||
| lib | ||
| manpages | ||
| themes | ||
| utils | ||
| widgets | ||
| .gitignore | ||
| AUTHORS | ||
| BUGS | ||
| CMakeLists.txt | ||
| LICENSE | ||
| Makefile | ||
| PATCHES | ||
| README | ||
| STYLE | ||
| awesome-version-internal.h.in | ||
| awesome.c | ||
| awesome.desktop | ||
| awesome.doxygen.in | ||
| awesome.h | ||
| awesomeConfig.cmake | ||
| awesomerc.lua.in | ||
| banning.c | ||
| banning.h | ||
| button.c | ||
| button.h | ||
| client.c | ||
| client.h | ||
| color.c | ||
| color.h | ||
| config.h.in | ||
| dbus.c | ||
| dbus.h | ||
| draw.c | ||
| draw.h | ||
| event.c | ||
| event.h | ||
| ewmh.c | ||
| ewmh.h | ||
| hooks.c | ||
| image.c | ||
| image.h | ||
| key.c | ||
| key.h | ||
| keygrabber.c | ||
| keygrabber.h | ||
| luaa.c | ||
| luaa.h | ||
| mouse.c | ||
| mouse.h | ||
| mousegrabber.c | ||
| mousegrabber.h | ||
| property.c | ||
| property.h | ||
| root.c | ||
| screen.c | ||
| screen.h | ||
| selection.c | ||
| selection.h | ||
| spawn.c | ||
| spawn.h | ||
| stack.c | ||
| stack.h | ||
| structs.h | ||
| swindow.c | ||
| swindow.h | ||
| systray.c | ||
| systray.h | ||
| tag.c | ||
| tag.h | ||
| titlebar.c | ||
| titlebar.h | ||
| wibox.c | ||
| wibox.h | ||
| widget.c | ||
| widget.h | ||
| window.c | ||
| window.h | ||
README
awesome
=======
awesome is a highly configurable, next generation framework window manager for X.
Requirements
------------
In order to build awesome itself, you need header files and libs of:
- cmake (>= 2.6)
- Xlib
- xproto
- xcb (>= 1.1)
- xcb-util (>= 0.3)
- Lua (>= 5.1)
- cairo built with xcb support
- pango and pangocairo (>= 1.19.3)
- libev
- Imlib2
- dbus (optional, use -DWITH_DBUS=OFF with cmake to disable)
- gperf
As well as the following tools to build theme icons:
- ImageMagick
In order to build the awesome man pages and documentation,
you need these tools:
- asciidoc
- xmlto
- docbook XSL stylesheets
- luadoc
In order to build the source code reference, you need these tools:
- doxygen
- graphviz
Building and installation
-------------------------
After extracting the dist tarball, run:
make
This will create a build directory, run cmake in it and build awesome.
After the building done, you can type this to install:
make install # 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 is provided in the sources.
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.