8f8d94aa45
Currently the session lock client has no 100% safe way to know when it is safe to suspend after requesting that the session be locked. For a suspend to be safe the compositor must have either blanked or rendered a lock surface on all outputs before suspending. This is because the current framebuffer on suspend appears to be saved and displayed again after suspend, at least on my Linux system. If a new "locked" frame for all outputs is not rendered before suspend, an "unlocked" frame or frames will likely be briefly displayed on resume before the lock surfaces are rendered or the screen is blanked. To fix this, wait until a lock surface has been rendered on all outputs, or if that times out until all outputs have been blanked, before sending the locked event to the client. Resolving this race on the compositor side without protocol changes is the most effective way to avoid this potential information leak, regardless of which session lock client is used. |
||
|---|---|---|
| .builds | ||
| common | ||
| completions | ||
| contrib | ||
| deps | ||
| doc | ||
| example | ||
| protocol | ||
| river | ||
| riverctl | ||
| rivertile | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| build.zig | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| PACKAGING.md | ||
| README.md | ||
river
River is a dynamic tiling Wayland compositor with flexible runtime configuration.
Join us at #river on irc.libera.chat. Read our man pages and our wiki.
Note: river is currently early in development. Expect breaking changes and missing features. Bugs should however be rare at this point, if you run into one don't hesitate to open an issue
Design goals
- Simple and predictable behavior, river should be easy to use and have a low cognitive load.
- Window management based on a stack of views and tags.
- Dynamic layouts generated by external, user-written executables. A default
rivertilelayout generator is provided. - Scriptable configuration and control through a custom Wayland protocol and
separate
riverctlbinary implementing it.
Building
On cloning the repository, you must init and update the submodules as well with e.g.
git submodule update --init
To compile river first ensure that you have the following dependencies installed. The "development" versions are required if applicable to your distribution.
- zig 0.9
- wayland
- wayland-protocols
- wlroots 0.16
- xkbcommon
- libevdev
- pixman
- pkg-config
- scdoc (optional, but required for man page generation)
Then run, for example:
zig build -Drelease-safe --prefix ~/.local install
To enable experimental Xwayland support pass the -Dxwayland option as well.
If you are packaging river for distribution, see also PACKAGING.md.
Usage
River can either be run nested in an X11/Wayland session or directly
from a tty using KMS/DRM. Simply run the river command.
On startup river will run an executable file at $XDG_CONFIG_HOME/river/init
if such an executable exists. If $XDG_CONFIG_HOME is not set,
~/.config/river/init will be used instead.
Usually this executable is a shell script invoking riverctl(1) to create mappings, start programs such as a layout generator or status bar, and perform other configuration.
An example init script with sane defaults is provided here in the example directory.
For complete documentation see the river(1), riverctl(1), and
rivertile(1) man pages.
Licensing
River is released under the GNU General Public License v3.0 only.
The protocols in the protocol directory are released under various licenses by
various parties. You should refer to the copyright block of each protocol for
the licensing information. The protocols prefixed with river and developed by
this project are released under the ISC license (as stated in their copyright
blocks).