2019-05-12 21:44:41 +01:00
|
|
|
# labwc
|
|
|
|
|
|
2020-09-01 19:45:36 +01:00
|
|
|
- [1. What is this?](#1-what-is-this)
|
|
|
|
|
- [2. Build](#2-build)
|
2021-03-07 21:25:04 +02:00
|
|
|
- [3. Install](#3-install)
|
|
|
|
|
- [4. Configure](#4-configure)
|
|
|
|
|
- [5. Run](#5-run)
|
|
|
|
|
- [6. Integrate](#6-integrate)
|
2021-03-29 19:36:46 +01:00
|
|
|
- [7. Accept](#7-acceptance-criteria)
|
2020-09-01 19:45:36 +01:00
|
|
|
|
|
|
|
|
## 1. What is this?
|
|
|
|
|
|
2021-03-06 11:45:45 +00:00
|
|
|
Labwc is a wlroots-based stacking compositor for Wayland.
|
2020-11-01 22:21:24 +00:00
|
|
|
|
|
|
|
|
It has the following aims:
|
2020-07-07 21:45:44 +01:00
|
|
|
|
2021-03-18 21:41:54 +00:00
|
|
|
- Be light-weight, small and fast.
|
|
|
|
|
- Use [openbox-3.4](https://github.com/danakj/openbox) specification for configuration and themes.
|
|
|
|
|
- Keep [feature set](https://github.com/johanmalm/labwc/wiki/Acceptance-criteria) small (ca 40% of openbox).
|
|
|
|
|
- Where practicable, use clients for wall-paper, panel, screenshots, and so on.
|
|
|
|
|
- Stay in keeping with wlroots and sway in terms of approach and coding style.
|
2019-05-12 21:44:41 +01:00
|
|
|
|
2021-02-26 19:18:52 +00:00
|
|
|
[Video (3:42) showing features](https://youtu.be/rE1bQjSVJzg)
|
2020-07-08 16:57:41 +01:00
|
|
|
|
2021-03-18 21:42:37 +00:00
|
|
|
<a href="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot2.png"><img src="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot2x.png" width="256px" height="144px"></a> <a href="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot3.png"><img src="https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot3x.png" width="256px" height="179px"></a>
|
2021-02-26 19:18:52 +00:00
|
|
|
|
2020-09-01 19:45:36 +01:00
|
|
|
## 2. Build
|
2019-05-12 21:44:41 +01:00
|
|
|
|
2021-03-06 11:45:45 +00:00
|
|
|
meson build/
|
|
|
|
|
ninja -C build/
|
2020-05-30 21:28:17 +01:00
|
|
|
|
2020-11-01 22:21:24 +00:00
|
|
|
Dependencies include:
|
2020-08-17 21:26:03 +01:00
|
|
|
|
2021-02-19 23:33:21 +00:00
|
|
|
- meson, ninja, gcc/clang
|
2021-03-15 18:09:36 +00:00
|
|
|
- wlroots (master)
|
|
|
|
|
- wayland (>=1.19)
|
2020-12-21 18:51:31 +00:00
|
|
|
- wayland-protocols
|
|
|
|
|
- libinput (>=1.14)
|
2020-08-17 21:26:03 +01:00
|
|
|
- libxml2
|
2020-11-01 22:21:24 +00:00
|
|
|
- cairo, pango, glib-2.0
|
2020-10-07 21:40:53 +01:00
|
|
|
- xkbcommon
|
2021-02-19 23:33:21 +00:00
|
|
|
- xwayland, xcb (optional)
|
2020-10-07 21:40:53 +01:00
|
|
|
|
2021-03-15 18:09:36 +00:00
|
|
|
Disable xwayland with `meson -Dxwayland=disabled build/`
|
2020-12-30 10:29:21 +00:00
|
|
|
|
2020-10-07 21:40:53 +01:00
|
|
|
For further details see [wiki/Build](https://github.com/johanmalm/labwc/wiki/Build).
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-03-07 21:25:04 +02:00
|
|
|
## 3. Install
|
|
|
|
|
|
2021-03-08 21:21:21 +00:00
|
|
|
See [wiki/Install](https://github.com/johanmalm/labwc/wiki/Install).
|
2021-03-07 21:25:04 +02:00
|
|
|
|
|
|
|
|
## 4. Configure
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-02-17 21:08:38 +00:00
|
|
|
If you want to override the defaults, create the following files:
|
2020-09-03 21:06:08 +01:00
|
|
|
|
2021-02-17 21:08:38 +00:00
|
|
|
- ~/.config/labwc/[rc.xml](docs/rc.xml)
|
|
|
|
|
- ~/.config/labwc/[menu.xml](docs/menu.xml)
|
2021-02-17 21:10:37 +00:00
|
|
|
- ~/.local/share/themes/\<theme-name\>/openbox-3/[themerc](docs/themerc)
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2020-09-03 21:06:08 +01:00
|
|
|
See full details in the following:
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-03-18 21:43:13 +00:00
|
|
|
- [labwc(1)](https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc.1.scd)
|
|
|
|
|
- [labwc-config(5)](https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-config.5.scd)
|
|
|
|
|
- [labwc-theme(5)](https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-theme.5.scd)
|
|
|
|
|
- [labwc-actions(5)](https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-actions.5.scd)
|
2021-03-20 14:42:23 +00:00
|
|
|
- [labwc-menu(5)](https://raw.githubusercontent.com/johanmalm/labwc/master/docs/labwc-menu.5.scd)
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-03-07 21:25:04 +02:00
|
|
|
## 5. Run
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-03-06 11:45:45 +00:00
|
|
|
./build/labwc [-s <command>]
|
2021-02-17 20:38:16 +00:00
|
|
|
|
|
|
|
|
Click on the background to launch a menu.
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2020-09-11 21:01:47 +01:00
|
|
|
If you have not created an rc.xml configuration file, default keybinds will be:
|
|
|
|
|
|
|
|
|
|
- Alt-tab: cycle window
|
2021-03-01 18:41:01 +00:00
|
|
|
- Alt-F3: launch bemenu
|
2020-09-11 21:01:47 +01:00
|
|
|
- Alt-escape: exit
|
|
|
|
|
|
2021-03-07 21:25:04 +02:00
|
|
|
## 6. Integrate
|
2020-09-01 19:45:36 +01:00
|
|
|
|
|
|
|
|
Suggested apps to use with labwc:
|
|
|
|
|
|
2021-03-08 21:33:30 +00:00
|
|
|
- Screen-shooter: [grim](https://github.com/emersion/grim)
|
|
|
|
|
- Screen-recorder: [wf-recorder](https://github.com/ammen99/wf-recorder)
|
|
|
|
|
- Background image: [swaybg](https://github.com/swaywm/swaybg)
|
|
|
|
|
- Panel: [waybar](https://github.com/Alexays/Waybar)
|
2021-03-08 21:54:23 +00:00
|
|
|
- Launchers: [bemenu](https://github.com/Cloudef/bemenu), [fuzzel](https://codeberg.org/dnkl/fuzzel), [wofi](https://hg.sr.ht/~scoopta/wofi)
|
|
|
|
|
- Output managers: [kanshi](https://github.com/emersion/kanshi.git), [wlr-randr](https://github.com/emersion/wlr-randr.git)
|
2020-09-01 19:45:36 +01:00
|
|
|
|
2021-03-16 21:25:01 +00:00
|
|
|
## 7. Acceptance Criteria
|
2020-05-18 21:01:01 +01:00
|
|
|
|
2021-03-18 21:42:37 +00:00
|
|
|
A lot of emphasis is put on code simplicy when considering features. The main
|
|
|
|
|
development effort if focused on producing a solid foundation for a stacking
|
|
|
|
|
compositor rather than quickly adding configuration and theming options.
|
|
|
|
|
|
|
|
|
|
See [wiki/Acceptance-criteria](https://github.com/johanmalm/labwc/wiki/Acceptance-criteria)
|
|
|
|
|
for a full down-selection.
|
|
|
|
|
|
|
|
|
|
High-level summary of progress:
|
2020-11-01 22:21:24 +00:00
|
|
|
|
2020-12-30 10:29:21 +00:00
|
|
|
- [x] Optionally support xwayland
|
2020-11-01 22:21:24 +00:00
|
|
|
- [x] Parse openbox config files (rc.xml, autostart, environment)
|
2020-12-23 18:38:49 +00:00
|
|
|
- [x] Parse openbox themes files and associated xbm icons
|
2021-03-01 18:41:01 +00:00
|
|
|
- [x] Support maximize, iconify, close buttons
|
2020-10-08 20:50:20 +01:00
|
|
|
- [x] Catch SIGHUP to re-load config file and theme
|
2021-03-16 21:25:01 +00:00
|
|
|
- [x] Support layer-shell protocol
|
2021-01-09 22:51:20 +00:00
|
|
|
- [x] Support damage tracking to reduce CPU usage
|
2021-03-16 21:25:01 +00:00
|
|
|
- [x] Parse menu.xml to generate a basic root-menu
|
2021-03-08 21:33:30 +00:00
|
|
|
- [x] Support wlr-output-management protocol
|
2021-03-29 19:36:46 +01:00
|
|
|
- [x] Support HiDPI
|
2020-09-21 19:51:16 +01:00
|
|
|
- [ ] Support foreign-toplevel protocol (e.g. to integrate with wlroots panels/bars)
|
2020-11-01 22:21:24 +00:00
|
|
|
- [ ] Support on-screen display (osd), for example to support alt-tab window list
|
2020-12-30 10:29:21 +00:00
|
|
|
- [ ] Support libinput configuration (tap is enabled for the time being)
|
2020-05-18 21:01:01 +01:00
|
|
|
|
2021-03-18 21:42:37 +00:00
|
|
|
The following items are out-of-scope:
|
2020-09-21 19:51:16 +01:00
|
|
|
|
2020-11-01 22:21:24 +00:00
|
|
|
- Icons (except window buttons)
|
|
|
|
|
- Animations
|
2021-03-18 21:42:37 +00:00
|
|
|
- Gradients for decoration and menus
|
2021-03-16 21:25:01 +00:00
|
|
|
- Any theme option not required to reasonably render common themes (amazingig
|
|
|
|
|
how few options are actually required).
|
2020-11-01 22:21:24 +00:00
|
|
|
- Any configuration option not required to provide a simple openbox-like experience
|
2020-09-21 19:51:16 +01:00
|
|
|
|
