diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-26 12:20:48 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-26 12:20:48 +0200 |
| commit | ae871c2fee400eb38ae23d1d0b1f708fe5a31bda (patch) | |
| tree | 4c47fd22dd30f47b21a0c1017d58bb68f5b6d724 | |
| parent | bbfd0c334cd77dd07336ea5ce15f31ac9c4bb816 (diff) | |
| download | river-ae871c2fee400eb38ae23d1d0b1f708fe5a31bda.tar.gz river-ae871c2fee400eb38ae23d1d0b1f708fe5a31bda.tar.xz | |
docs: Wayland should always be capitalized
This matches the style used on https://wayland.freedesktop.org/
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | doc/river.1.scd | 4 |
2 files changed, 5 insertions, 5 deletions
@@ -1,6 +1,6 @@ # river -River is a dynamic tiling wayland compositor with flexible runtime +River is a dynamic tiling Wayland compositor with flexible runtime configuration. Join us at [#river](https://web.libera.chat/?channels=#river) @@ -18,7 +18,7 @@ low cognitive load. - Window management based on a stack of views and tags. - Dynamic layouts generated by external, user-written executables. A default `rivertile` layout generator is provided. -- Scriptable configuration and control through a custom wayland protocol and +- Scriptable configuration and control through a custom Wayland protocol and separate `riverctl` binary implementing it. ## Building @@ -55,7 +55,7 @@ To enable experimental Xwayland support pass the `-Dxwayland` option as well. ## Usage -River can either be run nested in an X11/wayland session or directly +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` diff --git a/doc/river.1.scd b/doc/river.1.scd index e0b7969..a49add8 100644 --- a/doc/river.1.scd +++ b/doc/river.1.scd @@ -14,7 +14,7 @@ river - dynamic tiling Wayland compositor a stack of views laid out dynamically by an external layout generator. Tags are used instead of workspaces allowing for increased flexibility. -All runtime configuration and control happens through wayland protocols, +All runtime configuration and control happens through Wayland protocols, including several river-specific protocol extensions. The *riverctl*(1) utility may be used to communicate with river over these protocols. @@ -43,7 +43,7 @@ such an executable exists. If $XDG_CONFIG_HOME is not set, ~/.config/river/init will be used instead. The executable init file will be run as a process group leader after river's -wayland server is initialized but before entering the main loop. On exit, +Wayland server is initialized but before entering the main loop. On exit, river will send SIGTERM to this process group. Usually this executable is a shell script invoking *riverctl*(1) to create |