espterm
/
espterm-front-end
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update help

Browse Source
pull/2/head
Ondřej Hruška 7 years ago
parent 68a467c33e
commit fed47ffda9
Signed by: MightyPork
GPG Key ID: 2C5FD5035250423D
2 changed files with 142 additions and 102 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 102
      pages/help/cmd_screen.php
  2. 124
      pages/help/cmd_system.php

102
pages/help/cmd_screen.php
Unescape View File

@ -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. If an argument is left out, it's treated as 0 or 1, depending on what makes sense for the command.
</p> </p>
<h3>Erasing &amp; Inserting</h3>
<table class="ansiref w100"> <table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead> <thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody> <tbody>
<tr> <tr>
<td>`\e[<i>m</i>J`</td>
<td> <td>
`\e[<i>m</i>J` Clear part of screen. _m_: 0 - from cursor, 1 - to cursor, 2 - all
</td> </td>
</tr>
<tr>
<td>`\e[<i>m</i>K`</td>
<td> <td>
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
</td> </td>
</tr> </tr>
<tr> <tr>
<td>`\e[<i>n</i>X`</td>
<td> <td>
`\e[<i>m</i>K` Erase _n_ characters in line.
</td> </td>
</tr>
<tr>
<td><code>
\e[<i>n</i>L \\
\e[<i>n</i>M
</code></td>
<td> <td>
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.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>
\e[<i>n</i>@ \\
\e[<i>n</i>P
</code></td>
<td> <td>
`\e[<i>n</i>X`</td> 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.
</td>
</tr>
</tbody>
</table>
<h3>Supersized lines</h3>
<table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody>
<tr>
<td>`\e#1`, `\e#2`</td>
<td> <td>
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.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>`\e#3`, `\e#4`</td>
<td> <td>
`\e[<i>n</i>b`</td> Make the current line part of a double-width, double-height line.
Use `3` for the top, `4` for the bottom half.
</td>
</tr>
<tr>
<td>`\e#6`</td>
<td> <td>
Repeat last printed characters _n_ times (moving cursor and using the current style). Make the current line double-width.
</td> </td>
</tr> </tr>
<tr> <tr>
<td>`\e#5`</td>
<td> <td>
<code> Reset the current line to normal size.
\e[<i>n</i>L \\
\e[<i>n</i>M
</code>
</td> </td>
</tr>
</tbody>
</table>
<h3>Other</h3>
<table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody>
<tr>
<td>`\ec`</td>
<td> <td>
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.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>
\e[?1049h \\
\e[?1049l
</code></td>
<td> <td>
<code> Switch to (`h`) or from (`l`) an alternate screen.
\e[<i>n</i>@ \\ ESPTerm can't implement this fully, so the original screen content is not saved,
\e[<i>n</i>P but it will remember the cursor, screen size, terminal title, button labels and messages.
</code>
</td> </td>
</tr>
<tr>
<td>`\e[8;<i>r</i>;<i>c</i>t`</td>
<td>Set screen size to _r_ rows and _c_ columns (this is a command borrowed from Xterm)</td>
</tr>
<tr>
<td> <td>
Insert (`@`) or delete (`P`) _n_ characters. The rest of the line is pulled left or pushed right. `\e[<i>n</i>b`</td>
Characters going past the end of line are lost. <td>
Repeat last printed characters _n_ times (moving cursor and using the current style).
</td>
</tr>
<tr>
<td>`\e#8`</td>
<td>
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.
</td> </td>
</tr> </tr>
</tbody> </tbody>

124
pages/help/cmd_system.php
Unescape View File

@ -8,6 +8,8 @@
Those changes are not retained after restart. Those changes are not retained after restart.
</p> </p>
<h3>Single-byte commands &amp; queries</h3>
<table class="ansiref w100"> <table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead> <thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody> <tbody>
@ -28,17 +30,6 @@
This message contains the curretn version, unique ID, and the IP address if in Client mode. This message contains the curretn version, unique ID, and the IP address if in Client mode.
</td> </td>
</tr> </tr>
<tr>
<td>`\ec`</td>
<td>
Clear screen, reset attributes and cursor. This command also restores the default
screen size, title, button labels and messages and the background URL.
</td>
</tr>
<tr>
<td>`\e[8;<i>r</i>;<i>c</i>t`</td>
<td>Set screen size to _r_ rows and _c_ columns (this is a command borrowed from Xterm)</td>
</tr>
<tr> <tr>
<td>`\e[5n`</td> <td>`\e[5n`</td>
<td> <td>
@ -46,6 +37,14 @@
Can be used to check if the terminal has booted up and is ready to receive commands. Can be used to check if the terminal has booted up and is ready to receive commands.
</td> </td>
</tr> </tr>
</tbody>
</table>
<h3>Setting parameters</h3>
<table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody>
<tr> <tr>
<td>`\e[<i>n</i> q`</td> <td>`\e[<i>n</i> q`</td>
<td> <td>
@ -77,22 +76,18 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e]28;<i>x</i>;<i>t</i>\a \e]28;<i>x</i>;<i>t</i>\a
</code> </code></td>
</td>
<td> <td>
Set label for button _x_ (1-5) to _t_ - e.g.`\e]28;1;Yes\a` Set label for button _x_ (1-5) to _t_ - e.g.`\e]28;1;Yes\a`
sets the first button text to "Yes". sets the first button text to "Yes".
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e]29;<i>x</i>;<i>m</i>\a \e]29;<i>x</i>;<i>m</i>\a
</code> </code></td>
</td>
<td> <td>
Set message for button _x_ (1-5) to _m_ - e.g.`\e]29;3;+\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 sets the 3rd button to send "+" when pressed. The message can be up to
@ -100,11 +95,9 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e]30;<i>x</i>;<i>c</i>\a \e]30;<i>x</i>;<i>c</i>\a
</code> </code></td>
</td>
<td> <td>
Set button _x_ (1-5) color to _c_ - e.g.`\e]30;2;#00FF00\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 makes the 2nd button green. Supported are SGR colors 1-255
@ -113,58 +106,28 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e]9;<i>t</i>\a
</code>
</td>
<td>
Show a notification with text _t_. This will be either a desktop notification
or a pop-up balloon.
</td>
</tr>
<tr>
<td>
<code>
\e[?<i>n</i>s \\
\e[?<i>n</i>r
</code>
</td>
<td>
Save (`s`) and restore (`r`) any option set using `CSI ? <i>n</i> h`.
This is used by some applications to back up the original state before
making changes.
</td>
</tr>
<tr>
<td>
<code>
\e[?800h \\ \e[?800h \\
\e[?800l \e[?800l
</code> </code></td>
</td>
<td> <td>
Show (`h`) or hide (`l`) the action buttons (the blue buttons under the screen). Show (`h`) or hide (`l`) the action buttons (the blue buttons under the screen).
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e[?801h \\ \e[?801h \\
\e[?801l \e[?801l
</code> </code></td>
</td>
<td> <td>
Show (`h`) or hide (`l`) menu/help links under the screen. Show (`h`) or hide (`l`) menu/help links under the screen.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td><code>
<code>
\e[?2004h \\ \e[?2004h \\
\e[?2004l \e[?2004l
</code> </code></td>
</td>
<td> <td>
Enable (`h`) or disable (`l`) Bracketed Paste mode. Enable (`h`) or disable (`l`) Bracketed Paste mode.
This mode makes any text sent using the Upload Tool be preceded by `\e[200\~` This mode makes any text sent using the Upload Tool be preceded by `\e[200\~`
@ -173,28 +136,41 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>
\e[12h \\
\e[12l
</code></td>
<td> <td>
<code> Enable (`h`) or disable (`l`) Send-Receive Mode (SRM).
\e[?1049h \\ SRM is the opposite of Local Echo, meaning `\e[12h` disables and `\e[12l` enables Local Echo.
\e[?1049l
</code>
</td>
<td>
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.
</td> </td>
</tr> </tr>
</tbody>
</table>
<h3>Other</h3>
<table class="ansiref w100">
<thead><tr><th>Code</th><th>Meaning</th></tr></thead>
<tbody>
<tr> <tr>
<td><code>
\e]9;<i>t</i>\a
</code></td>
<td> <td>
<code> Show a notification with text _t_. This will be either a desktop notification
\e[12h \\ or a pop-up balloon.
\e[12l
</code>
</td> </td>
</tr>
<tr>
<td><code>
\e[?<i>n</i>s \\
\e[?<i>n</i>r
</code></td>
<td> <td>
Enable (`h`) or disable (`l`) Send-Receive Mode (SRM). Save (`s`) and restore (`r`) any option set using `CSI ? <i>n</i> h`.
SRM is the opposite of Local Echo, meaning `\e[12h` disables and `\e[12l` enables Local Echo. This is used by some applications to back up the original state before
making changes.
</td> </td>
</tr> </tr>
</tbody> </tbody>

Write Preview
Loading…
Cancel
Save