https://github.com/awesomeWM/awesome
awesome window manager
https://github.com/awesomeWM/awesome
awesomewm c hacktoberfest lua window-manager xorg
Last synced: about 1 month ago
JSON representation
awesome window manager
- Host: GitHub
- URL: https://github.com/awesomeWM/awesome
- Owner: awesomeWM
- License: gpl-2.0
- Created: 2014-03-03T19:56:16.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T19:31:55.000Z (6 months ago)
- Last Synced: 2024-10-29T14:55:45.674Z (6 months ago)
- Topics: awesomewm, c, hacktoberfest, lua, window-manager, xorg
- Language: Lua
- Homepage: https://awesomewm.org/
- Size: 16.2 MB
- Stars: 6,386
- Watchers: 163
- Forks: 598
- Open Issues: 559
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - awesome - awesome window manager (Lua)
- fucking-Awesome-Linux-Software - .
### Installing current git master as a package receipts
#### Arch Linux AUR
```sh
sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/awesome-git.git
cd awesome-git
makepkg -fsri
```#### Debian-based
```sh
sudo apt build-dep awesome
git clone https://github.com/awesomewm/awesome
cd awesome
make package
cd build
sudo apt install ./*.deb
```## 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:```sh
exec awesome
```In order to connect Awesome to a specific display, make sure that
the `DISPLAY` environment variable is set correctly, e.g.:```sh
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:
```sh
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](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).
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
[](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)).