2020-06-15 00:51:23 -07:00
|
|
|
RIVER(1) "github.com/ifreund/river" "General Commands Manual"
|
2020-12-12 15:51:51 -08:00
|
|
|
|
2020-06-15 00:51:23 -07:00
|
|
|
# NAME
|
|
|
|
|
|
2020-12-30 14:10:41 -08:00
|
|
|
river - dynamic tiling Wayland compositor
|
2020-06-15 00:51:23 -07:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2020-06-16 17:01:07 -07:00
|
|
|
*river* [*-c* _shell_command_] [*-l* _log_level_]
|
2020-06-15 00:51:23 -07:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2020-12-30 14:10:41 -08:00
|
|
|
*river* is a dynamic tiling Wayland compositor. Window management is based on
|
|
|
|
|
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,
|
|
|
|
|
including several river-specific protocol extensions. The *riverctl*(1)
|
|
|
|
|
utility may be used to communicate with river over these protocols.
|
2020-06-15 00:51:23 -07:00
|
|
|
|
|
|
|
|
# OPTIONS
|
|
|
|
|
|
|
|
|
|
*-c* _shell_command_
|
2020-12-30 11:29:45 -08:00
|
|
|
Override the default search paths for an init executable: instead
|
2020-12-30 14:10:41 -08:00
|
|
|
_shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION*
|
2020-12-30 11:29:45 -08:00
|
|
|
section for more details.
|
2020-06-15 00:51:23 -07:00
|
|
|
|
2020-06-16 17:01:07 -07:00
|
|
|
*-l* _log_level_
|
|
|
|
|
Set the log level of river to a value from 0 to 7 with 0 being the
|
|
|
|
|
least verbose and 7 being the most verbose. The default log level of
|
|
|
|
|
release-safe builds is 5.
|
|
|
|
|
|
2020-06-15 00:51:23 -07:00
|
|
|
# CONFIGURATION
|
|
|
|
|
|
2020-12-30 11:29:45 -08:00
|
|
|
On startup river will look for and run an executable file at one of the
|
|
|
|
|
following locations, checked in the order listed:
|
|
|
|
|
|
|
|
|
|
- $XDG_CONFIG_HOME/river/init
|
|
|
|
|
- $HOME/.config/river/init
|
|
|
|
|
- /etc/river/init
|
|
|
|
|
|
2021-02-21 13:03:03 -08:00
|
|
|
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,
|
|
|
|
|
river will send SIGTERM to this process group.
|
2020-12-30 11:29:45 -08:00
|
|
|
|
|
|
|
|
Usually this will be a shell script invoking *riverctl*(1) to create mappings,
|
|
|
|
|
start programs such as a status bar, and preform other configuration.
|
2020-06-15 00:51:23 -07:00
|
|
|
|
2020-06-17 01:39:48 -07:00
|
|
|
# ENVIRONMENT
|
|
|
|
|
|
|
|
|
|
The following environment variables are used to configure the keyboard. See
|
|
|
|
|
*xkeyboard-config*(7) for possible values.
|
|
|
|
|
|
|
|
|
|
- XKB_DEFAULT_MODEL
|
|
|
|
|
- XKB_DEFAULT_LAYOUT
|
|
|
|
|
- XKB_DEFAULT_VARIANT
|
|
|
|
|
- XKB_DEFAULT_OPTIONS
|
|
|
|
|
- XKB_DEFAULT_RULES
|
2020-06-15 00:51:23 -07:00
|
|
|
|
2020-12-30 11:29:45 -08:00
|
|
|
# EXAMPLES
|
|
|
|
|
|
|
|
|
|
Set the keyboard layout to colemak:
|
|
|
|
|
|
|
|
|
|
XKB_DEFAULT_LAYOUT="us(colemak)" river
|
|
|
|
|
|
2020-11-11 11:44:41 -08:00
|
|
|
# AUTHORS
|
|
|
|
|
|
|
|
|
|
Maintained by Isaac Freund <ifreund@ifreund.xyz> who is assisted by open
|
|
|
|
|
source contributors. For more information about river's development, see
|
|
|
|
|
<https://github.com/ifreund/river>.
|
|
|
|
|
|
2020-06-15 00:51:23 -07:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
2021-05-03 04:36:52 -07:00
|
|
|
*riverctl*(1), *rivertile*(1)
|
