2020-06-15 09:51:23 +02:00
RIVERCTL ( 1 ) "github.com/ifreund/river" "General Commands Manual"
# NAME
riverctl - command-line interface for controlling river
# SYNOPSIS
2020-06-17 10:39:48 +02:00
* riverctl *
* close * |* declare-mode * |* enter-mode * |* exit * |* focus-output * |* focus-view * |* layout * |* map * |* mod-master-count * |* mod-master-factor * |* send-to-output * |* set-focused-tags * |* set-option * |* set-view-tags * |* spawn * |* toggle-float * |* toggle-focused-tags * |* toggle-view-tags * |* zoom * [_ command specific arguments _ ]
2020-06-15 09:51:23 +02:00
# DESCRIPTION
* riverctl * is a command-line interface inspired by bspc from bspwm
used to control and configure river.
# COMMANDS
## ACTIONS
* close *
Close the focused view.
* exit *
Exit the compositor, terminating the Wayland session.
* focus-output * * next * |* previous *
Focus next or previous output.
* focus-view * * next * |* previous *
Focus next or previous view in the stack.
2020-06-13 14:43:12 +02:00
* layout * * full * |_ command _
Provide a command which river will use for generating the layout of
non-floating windows on the currently focused output. See
2020-06-17 10:39:48 +02:00
*river-layouts*(7) for details on the expected formatting of the output
of layout commands. Alternatively, “full” can be given instead of a
2020-06-13 14:43:12 +02:00
command to cause river to use its single internal layout, in which
windows span the entire width and height of the output.
2020-06-15 09:51:23 +02:00
* mod-master-count * _ integer _
Increase or decrease the number of master views. _integer_ can be
positive or negative.
* mod-master-factor * _ float _
Make the master area bigger or smaller. _float_ is a positive or
negative floating point number (such as 0.05) where 1 corresponds to
the whole screen.
* send-to-output * * next * |* previous *
Send the focused view to the next or the previous output.
* spawn * _shell_ command _
Run _shell_command_ using _/bin/sh -c_. Put single quotes around
_shell_command_ if you do not want special characters to get
interpreted by your shell before the command gets passed to _/bin/sh_.
* toggle-float *
If the focused view is floating, make it tiled. If it is tiled, make
it floating.
2020-06-29 01:50:26 +02:00
* toggle-fullscreen *
Toggle the fullscreen state of the focused view.
2020-06-15 09:51:23 +02:00
* zoom *
Bump the focused view to the top of the layout stack to make it the
new master.
## ACTIONS ON TAGS
Tags are like workspaces but more flexible: You can assign views to
multiple tags and look at multiple tags at once. A _ tagmask _ is used
to represent which tags are visible. The following commands take a
_ tagmask _ in base 10 as argument but _ tagmasks _ are best understood in
binary: 000000001 means that the first tag is visible; 111111111 means
that tag 1 through 9 are visible.
* set-focused-tags * _ tagmask _
Show the tags specified with _tagmask_.
* set-view-tags * _ tagmask _
Assign focused view to tags specified with _tagmask_.
* toggle-focused-tags * _ tagmask _
Toggle visibility of tags specified with _tagmask_.
* toggle-view-tags * _ tagmask _
Toggle tags of focused view as specified with _tagmask_.
## CONFIGURATION COMMANDS
* declare-mode * _ name _
Create a new mode called _name_ for use in mappings.
* enter-mode * _ name _
Switch to given mode if it exits.
* map * _ mode _ _ modifiers _ _ key _ _ command _
2020-06-17 10:39:48 +02:00
_mode_ is either “normal” (the default mode) or a mode created with
2020-06-15 09:51:23 +02:00
*declare-mode*. _modifiers_ is a list of one or more of the following
modifiers separated with a plus sign:
- Shift
- Lock (Caps lock)
- Control (Ctrl)
2020-06-17 10:39:48 +02:00
- Mod1 (Alt)
2020-06-15 09:51:23 +02:00
- Mod2
- Mod3
- Mod4 (Super, Logo, Windows)
- Mod5
_key_ is an XKB key name. See _/usr/include/xkbcommon/xkbcommon-keysyms.h_
for a list of special key names. _command_ can be any of the above commands.
A mapping without modifiers can be created by passing an empty string as
the modifiers argument.
* set-option * _ option _ _ value _
Set _option_ to a specified _value_. List of valid options:
2020-06-19 18:44:28 +02:00
- * background_color * _RGB/RGBA_hex_ code _
2020-06-15 09:51:23 +02:00
- * border_width * _non-negative_ integer _
- * border_color_focused * _RGB/RGBA_hex_ code _
- * border_color_unfocused * _RGB/RGBA_hex_ code _
- * outer_padding * _non-negative_ integer _
- * view_padding * _non-negative_ integer _
2020-07-14 17:34:29 +02:00
* xcursor-theme * _theme_ name _ [_ size _ ]
Set the xcursor theme to _theme_name_ and optionally set the
_size_. The theme of the default seat determines the default
for XWayland and made available through the _XCURSOR_THEME_ and
_XCURSOR_SIZE_ environment variables.
2020-06-15 09:51:23 +02:00
# EXAMPLES
Bind bemenu-run to Super+P:
riverctl map normal Mod4 P spawn bemenu-run
See _ contrib/config.sh _ for some basic keybindings.
# SEE ALSO
2020-06-17 10:39:48 +02:00
* river * (1), * river-layouts * (7), * rivertile * (1)
