ref: 2b9f6e74bbc1a12d9c5eb231cc0b5809e935cf4d
parent: dffed8b81f0d0f5144f081bd2d1f6d88bb6ca40c
author: Sigrid Solveig Haflínudóttir <[email protected]>
date: Sun Aug 28 17:20:37 EDT 2022
manpage
--- a/mkfile
+++ b/mkfile
@@ -1,6 +1,7 @@
</$objtype/mkfile
TARG=riow
+MAN=/sys/man/1
BIN=/$objtype/bin
OFILES=\
@@ -9,3 +10,5 @@
default:V: all
</sys/src/cmd/mkone
+
+install:V: man
--- /dev/null
+++ b/riow.man
@@ -1,0 +1,75 @@
+.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+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
+https://git.sr.ht/~ft/riow
+.SH BUGS
+Yes.