riow: keyboard-controller for rio

1 files changed, 83 insertions, 0 deletions

diff --git a/sys/man/1/riow b/sys/man/1/riow
new file mode 100644
index 000000000..df5ec7a1f
--- /dev/null
+++ b/sys/man/1/riow
@@ -0,0 +1,83 @@
+.TH RIOW 1
+.SH NAME
+riow \- keyboard-controller for rio(1)
+.SH SYNOPSIS
+.B riow
+[
+.I -s label
+]
+.SH DESCRIPTION
+.I riow
+provides keyboard controlling for
+.I rio(1)
+in the manner of
+.IR i3 ,
+.I sway
+and so on.  It does so by working with
+.I /dev/kbdtap
+(see \fIrio\fR(4)) and
+.IR /dev/wsys .
+.SS Running
+.I riow
+filters all key combinations that include
+.B Kmod4
+modifier, so it has to be placed
+.I last
+in the chain of programs using
+.IR /dev/kbdtap :
+.EX
+	</dev/kbdtap ktrans | \\
+		reform/shortcuts | \\
+		riow >/dev/kbdtap |[3] bar
+.EE
+Note that the current desktop number is printed to fd
+.IR 3 .
+.SS Keyboard shortcuts
+.TP
+.B Kmod4+0…9
+Switches to the specified virtual desktops. There are ten in total.
+.TP
+.B Kmod4+Shift+0…9
+Moves the current window to the specified virtual desktop.
+.TP
+.B Kmod4+f
+Toggle between fullscreen and normal mode for the current window.
+.TP
+.B Kmod4+s
+Toggle "sticky" mode for the current window. In this mode the window is staying
+while the user is switching between desktops. By default, programs like
+.IR winwatch ,
+.IR catclock ,
+.IR kbmap ,
+etc are in sticky mode. Additional programs can be added to that list on startup by
+specifying their labels with
+.I -s
+option.
+.TP
+.B Kmod4+enter
+Spawn a new
+.IR window(1) .
+.TP
+.B Kmod4+h/j/k/l
+Focus left/down/up/right.
+.TP
+.B Kmod4+arrows
+Move the current window in the specified direction.
+.TP
+.B Kmod4+control+arrows
+Same, but in bigger steps.
+.TP
+.B Kmod4+shift+arrows
+Resize the current window.
+.TP
+.B Kmod4+shift+control+arrows
+Same, but in bigger steps.
+.SH SOURCE
+/sys/src/cmd/riow.c
+.SH SEE ALSO
+.IR bar (1),
+.IR rio (4)
+.SH HISTORY
+Riow first appeared in 9front (September, 2022).
+.SH BUGS
+Yes.