Nulo/river
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: assorted fixes/cleanups

Browse source
This commit is contained in:
Isaac Freund 2021-11-01 00:29:06 +01:00
parent 8757644b2a
commit 4cee1fb881
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/river.1.scd
View file

@ -14,7 +14,7 @@ river - dynamic tiling Wayland compositor
a stack of views laid out dynamically by an external layout generator. Tags a stack of views laid out dynamically by an external layout generator. Tags
are used instead of workspaces allowing for increased flexibility. are used instead of workspaces allowing for increased flexibility.
All runtime configuration and control happens through Wayland protocols, All configuration and control happens at runtime through Wayland protocols,
including several river-specific protocol extensions. The *riverctl*(1) including several river-specific protocol extensions. The *riverctl*(1)
utility may be used to communicate with river over these protocols. utility may be used to communicate with river over these protocols.

6
doc/riverctl.1.scd
View file

@ -155,9 +155,9 @@ are ignored by river.
Mappings are modal in river. Each mapping is associated with a mode and is Mappings are modal in river. Each mapping is associated with a mode and is
only active while in that mode. There are two special modes: "normal" and only active while in that mode. There are two special modes: "normal" and
"locked". The normal mode is the initial mode for every seat. The locked "locked". The normal mode is the initial mode on startup. The locked mode
mode is automatically entered while an input inhibitor (such as a lockscreen) is automatically entered while an input inhibitor (such as a lockscreen)
is active. It cannot be left or entered manually. is active. It cannot be entered or exited manually.
The following modifiers are available for use in mappings: The following modifiers are available for use in mappings:

8
example/init
View file

@ -17,7 +17,7 @@ riverctl map normal $mod+Shift Return spawn foot
# Mod+Q to close the focused view # Mod+Q to close the focused view
riverctl map normal $mod Q close riverctl map normal $mod Q close
# Mod+E to exit river # Mod+Shift+E to exit river
riverctl map normal $mod+Shift E exit riverctl map normal $mod+Shift E exit
# Mod+J and Mod+K to focus the next/previous view in the layout stack # Mod+J and Mod+K to focus the next/previous view in the layout stack
@ -121,7 +121,7 @@ riverctl map passthrough $mod F11 enter-mode normal
# not have a modifier # not have a modifier
for mode in normal locked for mode in normal locked
do do
# Eject the optical drive # Eject the optical drive (well if you still have one that is)
riverctl map $mode None XF86Eject spawn 'eject -T' riverctl map $mode None XF86Eject spawn 'eject -T'
# Control pulse audio volume with pamixer (https://github.com/cdemoulins/pamixer) # Control pulse audio volume with pamixer (https://github.com/cdemoulins/pamixer)
@ -145,7 +145,7 @@ riverctl background-color 0x002b36
riverctl border-color-focused 0x93a1a1 riverctl border-color-focused 0x93a1a1
riverctl border-color-unfocused 0x586e75 riverctl border-color-unfocused 0x586e75
# Set repeat rate # Set keyboard repeat rate
riverctl set-repeat 50 300 riverctl set-repeat 50 300
# Make certain views start floating # Make certain views start floating
@ -158,4 +158,4 @@ riverctl csd-filter-add app-id "gedit"
# Set and exec into the default layout generator, rivertile. # Set and exec into the default layout generator, rivertile.
# River will send the process group of the init executable SIGTERM on exit. # River will send the process group of the init executable SIGTERM on exit.
riverctl default-layout rivertile riverctl default-layout rivertile
exec rivertile exec rivertile -view-padding 6 -outer-padding 6