0063c722e5
A true "default" config doesn't make sense for river. Everyone who uses river seriously will customize their init script. Futhermore, the current behavior of embedding the install path of the default system config in the river binary is complex and prone to breaking.
73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
RIVER(1) "github.com/ifreund/river" "General Commands Manual"
|
|
|
|
# NAME
|
|
|
|
river - dynamic tiling Wayland compositor
|
|
|
|
# SYNOPSIS
|
|
|
|
*river* [*-c* _shell_command_] [*-l* _log_level_]
|
|
|
|
# DESCRIPTION
|
|
|
|
*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.
|
|
|
|
# OPTIONS
|
|
|
|
*-c* _shell_command_
|
|
Override the default search paths for an init executable: instead
|
|
_shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION*
|
|
section for more details.
|
|
|
|
*-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.
|
|
|
|
# CONFIGURATION
|
|
|
|
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/ 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,
|
|
river will send SIGTERM to this process group.
|
|
|
|
Usually this executable is a shell script invoking *riverctl*(1) to create
|
|
mappings, start programs such as a layout generator or status bar, and
|
|
preform other configuration.
|
|
|
|
# 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
|
|
|
|
# EXAMPLES
|
|
|
|
Set the keyboard layout to colemak:
|
|
|
|
XKB_DEFAULT_LAYOUT="us(colemak)" river
|
|
|
|
# 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>.
|
|
|
|
# SEE ALSO
|
|
|
|
*riverctl*(1), *rivertile*(1)
|