summaryrefslogtreecommitdiff
path: root/doc/terminal.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/terminal.txt')
-rw-r--r--doc/terminal.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/terminal.txt b/doc/terminal.txt
new file mode 100644
index 0000000..ebdc898
--- /dev/null
+++ b/doc/terminal.txt
@@ -0,0 +1,14 @@
+The virtual terminals support some ANSI escape sequences.
+
+By default, the keyboard input is NOT echoed to the screen.
+Keyboard echoing can be enabled by sending 0x1b[e and disabled by sending 0x1b[h.
+
+When keyboard echo is enabled:
+- what is written to keyboard is echoed ONLY IF A PROCESS IS CURRENTLY READING THE INPUT
+- escape sequences are ignored (arrows, commands, etc.)
+- backspaces are taken into account, so that they don't need post-processing
+- read returns when a newline is read from keyboard
+When keyboard echo is disabled:
+- what is written to keyboard is NEVER ECHOED
+- read returns after each keystroke (can also be an escape sequence)
+Default is keyboard echo disabled.