1RIVER(1)                    General Commands Manual                   RIVER(1)
2
3
4

NAME

6       river - dynamic tiling Wayland compositor
7

SYNOPSIS

9       river [options]
10

DESCRIPTION

12       river is a dynamic tiling Wayland compositor. Window management is
13       based on a stack of views laid out dynamically by an external layout
14       generator. Tags are used instead of workspaces allowing for increased
15       flexibility.
16
17       All configuration and control happens at runtime through Wayland proto‐
18       cols, including several river-specific protocol extensions. The
19       riverctl(1) utility may be used to communicate with river over these
20       protocols.
21

OPTIONS

23       -h
24           Print a help message and exit.
25
26       -version
27           Print the version number and exit.
28
29       -c shell_command
30           Override the default search paths for an init executable: instead
31           shell_command will be run with /bin/sh -c. See the CONFIGURATION
32           section for more details.
33
34       -log-level [error|warning|info|debug]
35           Set the log level of river. At the error log level, only errors are
36           logged.  At the debug log level, everything is logged including
37           verbose debug messages.
38

CONFIGURATION

40       On startup river will run an executable file at $XDG_CON‐
41       FIG_HOME/river/init if such an executable exists. If $XDG_CONFIG_HOME
42       is not set, ~/.config/river/init will be used instead.
43
44       The executable init file will be run as a process group leader after
45       river's Wayland server is initialized but before entering the main
46       loop. On exit, river will send SIGTERM to this process group.
47
48       Usually this executable is a shell script invoking riverctl(1) to cre‐
49       ate mappings, start programs such as a layout generator or status bar,
50       and perform other configuration.
51

AUTHORS

53       Maintained by Isaac Freund <mail@isaacfreund.com> who is assisted by
54       open source contributors. For more information about river's develop‐
55       ment, see <https://github.com/riverwm/river>.
56

SEE ALSO

58       riverctl(1), rivertile(1)
59
60
61
62github.com/riverwm/river          2023-01-08                          RIVER(1)
Impressum