Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ArtsyMacaw/wlogout
A wayland based logout menu
https://github.com/ArtsyMacaw/wlogout
Last synced: 3 months ago
JSON representation
A wayland based logout menu
- Host: GitHub
- URL: https://github.com/ArtsyMacaw/wlogout
- Owner: ArtsyMacaw
- License: mit
- Created: 2019-12-29T00:58:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-04T04:04:20.000Z (6 months ago)
- Last Synced: 2024-08-01T03:21:07.837Z (5 months ago)
- Language: C
- Size: 1.19 MB
- Stars: 603
- Watchers: 4
- Forks: 31
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - Wlogout
- awesome-wayland - wlogout - Logout menu. (Session / Sway Specific)
- awesome-wayland - wlogout - Logout menu. (Session / Sway Specific)
- awesome-linux-ricing - wlogout - Wayland based logout menu (Logout Menu / Utilities)
- awesome-starred - ArtsyMacaw/wlogout - A wayland based logout menu (others)
README
# wlogout
> wlogout is a logout menu for [wayland](https://wayland.freedesktop.org/) environments.
## Running
Run `wlogout` to launch and press `Escape` to exit.
## Config
If you are editing the default layout and CSS file, it is recommended that you copy `/etc/wlogout/layout` and `/etc/wlogout/style.css` to `~/.config/wlogout/` and change them there.
### Layout
Custom buttons can be defined and edited in a layout file. The format is as follows:
```
{
"label" : "CSS Label",
"action" : "command to execute when clicked",
"text" : "text displayed on button",
"keybind" : "character to be bound"
}
```
Check the default [layout file](layout) for examples, and run `man 5 wlogout` for documentation.
### Style
wlogout can be easily styled through the style.css file. If you would like to style a button, use the label given to it in the layout file, and for other styling, refer to the [GTK Manual](https://developer.gnome.org/gtk3/stable/chap-css-properties.html), which shows all the allowed CSS.
## Install
### Archlinux
Arch users can use [wlogout](https://aur.archlinux.org/packages/wlogout/).
```
yay -S wlogout
```
### Other Distros
Install "wlogout" with your distro's package manager.
### Compiling from Source
Install dependencies:
* GTK+
* GObject introspection
* meson
* gtk-layer-shell (optional: transperancy)
* scdoc (optional: man pages)
* systemd (optional: default buttons)
Run these commands:
```
git clone https://github.com/ArtsyMacaw/wlogout.git
cd wlogout
meson build
ninja -C build
sudo ninja -C build install
```
## License
wlogout is licensed under MIT. [Refer to LICENSE for more information](LICENSE)