From fed47ffda9ca9f3868d5f1aae201cfb9db2eef42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Sun, 19 Nov 2017 22:26:37 +0100 Subject: [PATCH] update help --- pages/help/cmd_screen.php | 102 ++++++++++++++++++++++----- pages/help/cmd_system.php | 142 ++++++++++++++++---------------------- 2 files changed, 142 insertions(+), 102 deletions(-) diff --git a/pages/help/cmd_screen.php b/pages/help/cmd_screen.php index d19c0b3..dc1bc91 100644 --- a/pages/help/cmd_screen.php +++ b/pages/help/cmd_screen.php @@ -8,60 +8,124 @@ If an argument is left out, it's treated as 0 or 1, depending on what makes sense for the command.

+

Erasing & Inserting

+ + + + + + + + + + + Insert (`@`) or delete (`P`) _n_ characters. The rest of the line is pulled left or pushed right. + Characters going past the end of line are lost. + + + +
CodeMeaning
`\e[mJ` - `\e[mJ` + Clear part of screen. _m_: 0 - from cursor, 1 - to cursor, 2 - all
`\e[mK` - Clear part of screen. _m_: 0 - from cursor, 1 - to cursor, 2 - all + Erase part of line. _m_: 0 - from cursor, 1 - to cursor, 2 - all
`\e[nX` - `\e[mK` + Erase _n_ characters in line.
+ \e[nL \\ + \e[nM + - Erase part of line. _m_: 0 - from cursor, 1 - to cursor, 2 - all + Insert (`L`) or delete (`M`) _n_ lines. Following lines are pulled up or pushed down.
+ \e[n@ \\ + \e[nP + - `\e[nX`
+ +

Supersized lines

+ + + + + + + + Make the current line part of a double-width, double-height line. + Use `3` for the top, `4` for the bottom half. + + + + + + + +
CodeMeaning
`\e#1`, `\e#2` - Erase _n_ characters in line. + Make the current line part of a double-height line. + Use `1` for the top, `2` for the bottom half.
`\e#3`, `\e#4` - `\e[nb`
`\e#6` - Repeat last printed characters _n_ times (moving cursor and using the current style). + Make the current line double-width.
`\e#5` - - \e[nL \\ - \e[nM - + Reset the current line to normal size.
+ +

Other

+ + + + + + + + + + + + + + + + + + diff --git a/pages/help/cmd_system.php b/pages/help/cmd_system.php index e826e61..7633136 100644 --- a/pages/help/cmd_system.php +++ b/pages/help/cmd_system.php @@ -8,6 +8,8 @@ Those changes are not retained after restart.

+

Single-byte commands & queries

+
CodeMeaning
`\ec` - Insert (`L`) or delete (`M`) _n_ lines. Following lines are pulled up or pushed down. + Clear screen, reset attributes and cursor. This command also restores the default + screen size, title, button labels and messages and the background URL.
+ \e[?1049h \\ + \e[?1049l + - - \e[n@ \\ - \e[nP - + Switch to (`h`) or from (`l`) an alternate screen. + ESPTerm can't implement this fully, so the original screen content is not saved, + but it will remember the cursor, screen size, terminal title, button labels and messages.
`\e[8;r;ct`Set screen size to _r_ rows and _c_ columns (this is a command borrowed from Xterm)
- Insert (`@`) or delete (`P`) _n_ characters. The rest of the line is pulled left or pushed right. - Characters going past the end of line are lost. + `\e[nb` + Repeat last printed characters _n_ times (moving cursor and using the current style). +
`\e#8` + Reset all screen attributes to default and fill the screen with the letter "E". This was + historically used for aligning CRT displays, now can be useful e.g. for testing erasing commands.
@@ -28,17 +30,6 @@ This message contains the curretn version, unique ID, and the IP address if in Client mode. - - - - - - - - + +
CodeMeaning
`\ec` - Clear screen, reset attributes and cursor. This command also restores the default - screen size, title, button labels and messages and the background URL. -
`\e[8;r;ct`Set screen size to _r_ rows and _c_ columns (this is a command borrowed from Xterm)
`\e[5n` @@ -46,6 +37,14 @@ Can be used to check if the terminal has booted up and is ready to receive commands.
+ +

Setting parameters

+ + + + - + - + - + - - - - - - - - - + - + - + + - + +
CodeMeaning
`\e[n q` @@ -77,22 +76,18 @@
- - \e]28;x;t\a - - + \e]28;x;t\a + Set label for button _x_ (1-5) to _t_ - e.g.`\e]28;1;Yes\a` sets the first button text to "Yes".
- - \e]29;x;m\a - - + \e]29;x;m\a + Set message for button _x_ (1-5) to _m_ - e.g.`\e]29;3;+\a` sets the 3rd button to send "+" when pressed. The message can be up to @@ -100,11 +95,9 @@
- - \e]30;x;c\a - - + \e]30;x;c\a + Set button _x_ (1-5) color to _c_ - e.g.`\e]30;2;#00FF00\a` makes the 2nd button green. Supported are SGR colors 1-255 @@ -113,58 +106,28 @@
- - \e]9;t\a - - - Show a notification with text _t_. This will be either a desktop notification - or a pop-up balloon. -
- - \e[?ns \\ - \e[?nr - - - Save (`s`) and restore (`r`) any option set using `CSI ? n h`. - This is used by some applications to back up the original state before - making changes. -
- - \e[?800h \\ - \e[?800l - - + \e[?800h \\ + \e[?800l + Show (`h`) or hide (`l`) the action buttons (the blue buttons under the screen).
- - \e[?801h \\ - \e[?801l - - + \e[?801h \\ + \e[?801l + Show (`h`) or hide (`l`) menu/help links under the screen.
- - \e[?2004h \\ - \e[?2004l - - + \e[?2004h \\ + \e[?2004l + Enable (`h`) or disable (`l`) Bracketed Paste mode. This mode makes any text sent using the Upload Tool be preceded by `\e[200\~` @@ -173,28 +136,41 @@
+ \e[12h \\ + \e[12l + - - \e[?1049h \\ - \e[?1049l - - - Switch to (`h`) or from (`l`) an alternate screen. - ESPTerm can't implement this fully, so the original screen content is not saved, - but it will remember the cursor, screen size, terminal title, button labels and messages. + Enable (`h`) or disable (`l`) Send-Receive Mode (SRM). + SRM is the opposite of Local Echo, meaning `\e[12h` disables and `\e[12l` enables Local Echo.
+ +

Other

+ + + + + + + +
CodeMeaning
+ \e]9;t\a + - - \e[12h \\ - \e[12l - + Show a notification with text _t_. This will be either a desktop notification + or a pop-up balloon.
+ \e[?ns \\ + \e[?nr + - Enable (`h`) or disable (`l`) Send-Receive Mode (SRM). - SRM is the opposite of Local Echo, meaning `\e[12h` disables and `\e[12l` enables Local Echo. + Save (`s`) and restore (`r`) any option set using `CSI ? n h`. + This is used by some applications to back up the original state before + making changes.