Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
RIVER(1)		    General Commands Manual		      RIVER(1)

NAME
       river - dynamic tiling Wayland compositor

SYNOPSIS
       river [options]

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 configuration and control happens at	runtime	through	Wayland	proto-
       cols,  including	 several  river-specific  protocol   extensions.   The
       riverctl(1)  utility  may  be used to communicate with river over these
       protocols.

OPTIONS
       -h
	   Print a help	message	and exit.

       -version
	   Print the version number and	exit.

       -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.

       -log-level [error|warning|info|debug]
	   Set the log level of	river. At the error log	level, only errors are
	   logged.  At the debug log level,  everything	 is  logged  including
	   verbose debug messages.

       -no-xwayland
	   Disable  xwayland at	runtime	even if	river has been built with sup-
	   port.

CONFIGURATION
       On  startup  river  will	 run   an   executable	 file	at   $XDG_CON-
       FIG_HOME/river/init  if	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, river will send SIGTERM to this process group.

       Usually this executable is a shell script invoking riverctl(1) to  cre-
       ate  mappings, start programs such as a layout generator	or status bar,
       and perform other configuration.

AUTHORS
       Maintained by Isaac Freund <mail@isaacfreund.com> who  is  assisted  by
       open  source  contributors. For more information	about river's develop-
       ment, see <https://isaacfreund.com/software/river>.

SEE ALSO
       riverctl(1), rivertile(1)

				  2025-04-24			      RIVER(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=river&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help