# 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:

```sh make sudo make install` ``<p>This will <p>1. create a build directory at` ./build`, 2. run` cmake`, 3. build Awesome and 4. install it to the default prefix path` /usr/local`. <p>Alternatively to the above, you can generate a` .deb`or` .rpm`package, for easy installation management: <p>```sh make package <p>sudo dpkg -i awesome-x.y.z.deb # or sudo rpm -Uvh awesome-x.y.z.rpm` ``<p>### Advanced options and testing <p>A full list of dependencies, more advanced build options, as well as instructions on how to use the test suite can be found [here](https://awesomewm.org/apidoc/documentation/10-building-and-testing.md.html). <p>### Installing current git master as a package receipts <p>#### Arch Linux AUR <p>```sh sudo pacman -S --needed base-devel git git clone https://aur.archlinux.org/awesome-git.git cd awesome-git makepkg -fsri` ``<p>#### Debian-based <p>```sh sudo apt build-dep awesome sudo apt install libxcb-xfixes0-dev git clone https://github.com/awesomewm/awesome cd awesome make package cd build sudo apt install ./*.deb` ``<p>## Running Awesome <p>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: <p>```sh exec awesome` ``<p>In order to connect Awesome to a specific display, make sure that the` DISPLAY`environment variable is set correctly, e.g.: <p>```sh DISPLAY=foo.bar:1 exec awesome` ``<p>(This will start Awesome on display` :1`of the host foo.bar.) <p>## Configuration <p>The configuration of Awesome is done by creating a` $XDG_CONFIG_HOME/awesome/rc.lua`file, typically` ~/.config/awesome/rc.lua`. <p>An example configuration named` awesomerc.lua`is provided in the source. <p>## Troubleshooting <p>On most systems any message printed by Awesome (including warnings and errors) is written to` ~/.xsession-errors`. <p>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. <p>### Debugging tips <p>You can call` awesome`with` gdb`like this: <p>```sh DISPLAY=:2 gdb awesome` ``<p>Then in` gdb`set any arguments and run it: <p>```(gdb) set args --replace (gdb) run` ``<p>## Asking questions <p>#### IRC <p>You can join us in the` #awesome` channel on the [OFTC](http://www.oftc.net/) IRC network.

[IRC Webchat](https://webchat.oftc.net/?channels=awesome)

#### Stack Overflow You can ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/awesome-wm).

#### Reddit We also have an [awesome subreddit](https://www.reddit.com/r/awesomewm/) where you can share your work and ask questions.

## Reporting issues

Please report any issues you may find on [our bugtracker](https://github.com/awesomeWM/awesome/issues).

## Contributing code

You can submit pull requests on the [GitHub repository](https://github.com/awesomeWM/awesome). Please read the [contributing guide](https://github.com/awesomeWM/awesome/blob/master/docs/02-contributing.md) for any coding, documentation or patch guidelines.

## Status [![Build Status](https://travis-ci.com/awesomeWM/awesome.svg?branch=master)](https://travis-ci.com/awesomeWM/awesome)

## Documentation

Online documentation is available [here](https://awesomewm.org/apidoc/).

## License

The project is licensed under GNU General Public License v2 or later. You can read it online at ([v2](http://www.gnu.org/licenses/gpl-2.0.html) or [v3](http://www.gnu.org/licenses/gpl.html)).

generated by LDoc 1.5.0