Release v0.6.3 (#75)HEADv0.6.3master

1 files changed, 12 insertions, 3 deletions

diff --git a/docs/modules/system.html b/docs/modules/system.html
index 6840b85..0a2447e 100644
--- a/docs/modules/system.html
+++ b/docs/modules/system.html
@@ -1051,7 +1051,7 @@ sequences will be buffered internally and returned one byte at a time.
         the character that was received (can be multi-byte), or a complete ANSI sequence</li>
         <li>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-        the type of input: <code>&quot;char&quot;</code> for a single key, <code>&quot;ansi&quot;</code> for an ANSI sequence</li>
+        the type of input: <code>&quot;ctrl&quot;</code> for 0-31 and 127 bytes, <code>&quot;char&quot;</code> for other UTF-8 characters, <code>&quot;ansi&quot;</code> for an ANSI sequence</li>
     </ol>
      <h3>Or</h3>
     <ol>
@@ -1070,6 +1070,15 @@ sequences will be buffered internally and returned one byte at a time.
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> key, keytype = system.<span class="function-name">readansi</span>(<span class="number">5</span>)
+<span class="keyword">if</span> keytype == <span class="string">"char"</span> <span class="keyword">then</span> ... <span class="keyword">end</span> <span class="comment">-- printable character
+</span><span class="keyword">if</span> keytype ~= <span class="string">"char"</span> <span class="keyword">then</span> ... <span class="keyword">end</span> <span class="comment">-- non-printable character or sequence
+</span><span class="keyword">if</span> keytype == <span class="string">"ansi"</span> <span class="keyword">then</span> ... <span class="keyword">end</span> <span class="comment">-- a multi-byte sequence, but not a UTF8 character
+</span><span class="keyword">if</span> keytype ~= <span class="string">"ansi"</span> <span class="keyword">then</span> ... <span class="keyword">end</span> <span class="comment">-- a valid UTF8 character (which includes control characters)
+</span><span class="keyword">if</span> keytype == <span class="string">"ctrl"</span> <span class="keyword">then</span> ... <span class="keyword">end</span> <span class="comment">-- a single-byte ctrl character (0-31, 127)</span></pre>
+    </ul>
 
 </dd>
     <dt>
@@ -1079,7 +1088,7 @@ sequences will be buffered internally and returned one byte at a time.
     <dd>
     Reads a single byte from the console, with a timeout.
  This function uses <code>fsleep</code> to wait until either a byte is available or the timeout is reached.
- The sleep period is exponentially backing off, starting at 0.0125 seconds, with a maximum of 0.2 seconds.
+ The sleep period is exponentially backing off, starting at 0.0125 seconds, with a maximum of 0.1 seconds.
  It returns immediately if a byte is available or if <code>timeout</code> is less than or equal to <code>0</code>.</p>
 
 <p> Using <a href="../modules/system.html#readansi">system.readansi</a> is preferred over this function. Since this function can leave stray/invalid
@@ -1509,7 +1518,7 @@ This function will sleep, without doing a busy-loop and wasting CPU cycles.
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2025-04-17 09:50:39 </i>
+<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>