blob: d5fe7ee813c2bfe3f22d600a7b0a6a6b644efdeb (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
RIVERCTL(1) "github.com/ifreund/river" "General Commands Manual"
# NAME
riverctl - command-line interface for controlling river
# SYNOPSIS
*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-view-tags*|*spawn*|*toggle-float*|
*toggle-focused-tags*|*toggle-view-tags*|*zoom* [_command specific arguments_]
# 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.
*layout* *top-master*|*right-master*|*bottom-master*|*left-master*|*full*
Change the view layout.
*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.
*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_
_mode_ is either *normal* (the default mode) or a mode created with
*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)
- Mod (Alt)
- 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:
- *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_
# 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
*river*(1), *bspc*(1)
|
