diff --git a/html_orig/pages/help.php b/html_orig/pages/help.php index 4aa8920..cf42f87 100644 --- a/html_orig/pages/help.php +++ b/html_orig/pages/help.php @@ -12,9 +12,14 @@
\e
to indicate ESC.
+ forming the body of the command.
-
- - Escape sequences can be divided based on their first character and structure. Most common types are: -
- -\e[
followed by 1 optional leading character, multiple numbers divided by
- semicolons, and one or two trailing characters. Those control the cursor, set attributes and manipulate screen content. E.g. \e[?7;10h
, \e[2J
m
. Those set text attributes and colors. E.g. \e[
\e]
followed by any number of UTF-8 characters (ESPTerm supports up to 64)
- terminated by \e\\
(ESC and backslash) or Bell (7). Those are used to exchange text strings.\e7
or
- \e#8
, mostly for historical reasons.A list of the most important escape sequences is presented in the following sections.
+ +Examples on this help page use the following symbols for special characters and command types: + (spaces are for clarity only, DO NOT include them in the commands!)
+ +Name | Symbol | ASCII | C string | Function |
---|---|---|---|---|
ESC | +\e |
+ ESC (27) |
+ "\e" , "\x1b" , "\033" |
+ Introduces an escape sequence. (Note: \e is a GCC extension) | +
Bell | +\a |
+ BEL (7) |
+ "\a" , "\x7" , "\07" |
+ Audible beep | +
String Terminator | +ST |
+ ESC \ (27 92) or \a (7)
|
+ "\x1b\\", |
+ Terminates a string command (\a can be used as an alternative) |
+
Control Sequence Introducer | +CSI |
+ ESC [ |
+ "\x1b[" |
+ Starts a CSI command. Examples: \e[?7;10h , \e[2J |
+
Operating System Command | +OSC |
+ ESC ] |
+ "\x1b]" | +Starts an OSC command. Is followed by a command string terminated by ST . Example: \e]0;My Screen Title\a |
+
Select Graphic Rendition | +SGR |
+ CSI n ; n ; n m |
+ "\x1b[1;2;3m" |
+ Set text attributes, like color or style. 0 to 10 numbers can be used, \e[m is treated as \e[0m |
+
There are also some other commands that don't follow the CSI, SGR or OSC pattern, such as \e7
or
+ \e#8
. A list of the most important escape sequences is presented in the following sections.
The initial screen size, title text and button labels can be configured in Terminal Settings.
@@ -192,25 +237,25 @@Key | Code | Key | Code | |
---|---|---|---|---|
🡑 | +Up | \e[A |
F1 | \eOP |
🡓 | +Down | \e[B |
F2 | \eOQ |
🡒 | +Right | \e[C |
F3 | \eOR |
🡐 | +Left | \e[D |
F4 | \eOS |
@@ -287,9 +332,11 @@