ref: 3bafb462c5d7bf11375cf81e1c8cb0b389a24d6f
parent: 3ac9653205ad8080a36638f6d27a82757bec16cc
author: Sigrid Haflínudóttir <ftrvxmtrx@gmail.com>
date: Wed Feb 19 06:37:59 EST 2020
plan9: man page: add sections describing keys and commands
--- a/orca.man
+++ b/orca.man
@@ -25,7 +25,11 @@
interfaces.
.PP
Every letter of the alphabet is an operation, where lowercase letters
-operate on bang, uppercase letters operate each frame.
+operate on bang, uppercase letters operate each frame. Extensive
+documentation of the language is available on the project's GitHub web
+page, see
+.B SOURCE
+section.
.PP
There are a number of options:
.TP
@@ -55,9 +59,117 @@
.B -c
Set the cursor character.
.PP
-.EE
-Extensive documentation and examples are available on the project's
-GitHub web page.
-.EE
+.SH KEYS
+.TP
+.B '
+Enter rectangle
+.I selection
+mode, use arrows to extend it.
+.TP
+.B Ctrl+i Insert
+Toggle between
+.I append
+and
+.I insert
+(overwrite) mode.
+.TP
+.B Escape
+Return to normal mode or deselect.
+.TP
+.B ´ ` ~
+Toggle
+.I slide
+mode, use arrows to move the selected text around.
+.TP
+.B Space
+Toggle pause.
+.TP
+.B Ctrl+r
+Reset frame counter.
+.TP
+.B Ctrl+f
+Forward one frame, useful in paused mode.
+.TP
+.B Ctrl+c Ctrl+x
+Snarf/cut the selected text.
+.TP
+.B Ctrl+v
+Paste from the snarf buffer.
+.TP
+.B Ctrl+u Ctrl+l
+Convert selected text to upper/lower case.
+.TP
+.B Ctrl+a Ctrl+e
+Jump to the beginning/end of the line.
+.TP
+.B Home End
+Jump to the first/last line.
+.TP
+.B Delete Backspace Ctrl+h
+Keys to remove text.
+.TP
+.B Ctrl+k
+Enter a command. See
+.B COMMANDS
+section for more information.
+.TP
+.B Alt+arrow
+Move selected text.
+.TP
+.B Shift+arrow
+Extend the selection. Works only in drawterm.
+.TP
+.B Ctrl+arrow
+Jump by the number of cells set for the rulers.
+.TP
+.B < >
+Adjust BPM.
+.TP
+.B ( ) _ +
+Adjust grid size.
+.TP
+.B [ ] { }+Adjust rulers.
+.TP
+.B Ctrl+s
+Save to file.
+.SH COMMANDS
+Commands can be entered into Orca either manually with
+.B Ctrl+k
+or with a
+.B $
+operator.
+.PP
+Any command can start with
+.I ,
+(comma) to select the entire grid before executing the command.
+.TP
+.B |cmd arg...
+Pipe the selected text to a shell command and paste its output back
+into the grid.
+.TP
+.B play
+Resume.
+.TP
+.B stop
+Pause.
+.TP
+.B run
+Forward one frame.
+.TP
+.B bpm NUMBER
+Set new BPM value.
+.TP
+.B apm NUMBER
+Animate BPM to the value.
+.TP
+.B frame NUMBER
+Set frame value.
+.TP
+.B skip NUMER
+Increase frame value.
+.TP
+.B rewind NUMBER
+Decrease frame value.
.SH SOURCE
https://github.com/Hundredrabbits/Orca