From 06691764e87c2979f4a00ed386e237150f055d5a Mon Sep 17 00:00:00 2001
From: Thijs Schreijer <thijs@thijsschreijer.nl>
Date: Thu, 10 Apr 2025 10:29:39 +0200
Subject: Release v0.6.0 (#61)

---
 docs/modules/system.html | 55 +++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 50 insertions(+), 5 deletions(-)

(limited to 'docs/modules/system.html')

diff --git a/docs/modules/system.html b/docs/modules/system.html
index fa41458..28ccf5a 100644
--- a/docs/modules/system.html
+++ b/docs/modules/system.html
@@ -124,6 +124,10 @@
 	<td class="summary">Backs up terminal settings and restores them on application exit.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#detachfds">detachfds ()</a></td>
+	<td class="summary">Creates new file descriptions for <code>stdout</code> and <code>stderr</code>.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#getconsolecp">getconsolecp ()</a></td>
 	<td class="summary">Gets the current console code page (Windows).</td>
 	</tr>
@@ -496,6 +500,40 @@ sequences will be buffered internally and returned one byte at a time.
 
 
 
+</dd>
+    <dt>
+    <a name = "detachfds"></a>
+    <strong>detachfds ()</strong>
+    </dt>
+    <dd>
+    Creates new file descriptions for <code>stdout</code> and <code>stderr</code>.
+Even if the file descriptors are unique, they still might point to the same
+file description, and hence share settings like <code>O_NONBLOCK</code>. This means that
+if one of them is set to non-blocking, the other will be as well. This can
+lead to unexpected behavior.</p>
+
+<p>This function is used to detach <code>stdout</code> and <code>stderr</code> from the original
+file descriptions, and create new file descriptions for them. This allows
+independent control of flags (e.g., <code>O_NONBLOCK</code>) on <code>stdout</code> and <code>stderr</code>,
+avoiding shared side effects.</p>
+
+<p>Does not modify <code>stdin</code> (fd 0), and does nothing on Windows.
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+        boolean <code>true</code> on success, or throws an error on failure.
+    </ol>
+
+
+    <h3>See also:</h3>
+    <ul>
+         <a href="../modules/system.html#setnonblock">setnonblock</a>
+    </ul>
+
+
 </dd>
     <dt>
     <a name = "getconsolecp"></a>
@@ -632,6 +670,10 @@ for more information on the flags.
     </ol>
 
 
+    <h3>See also:</h3>
+    <ul>
+         <a href="../modules/system.html#setnonblock">setnonblock</a>
+    </ul>
 
 
 </dd>
@@ -801,7 +843,7 @@ system.<span class="function-name">listconsoleflags</span>(<span class="global">
         </li>
         <li><span class="parameter">fsleep</span>
             <span class="types"><span class="type">function</span></span>
-         the function to call for sleeping.
+         the function to call for sleeping; <code>ok, err = fsleep(secs)</code>
          (<em>default</em> system.sleep)
         </li>
     </ul>
@@ -819,7 +861,7 @@ system.<span class="function-name">listconsoleflags</span>(<span class="global">
         if no key was read</li>
         <li>
            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
-        error message; <code>&quot;timeout&quot;</code> if the timeout was reached.</li>
+        error message when the timeout was reached (<code>&quot;timeout&quot;</code>), or if <a href="../modules/system.html#sleep">sleep</a> failed.</li>
     </ol>
 
 
@@ -947,6 +989,7 @@ system.<span class="function-name">listconsoleflags</span>(<span class="global">
     </dt>
     <dd>
     Enables or disables non-blocking mode for a file (Posix).
+Check <a href="../modules/system.html#detachfds">detachfds</a> in case there are shared file descriptions.
 
 
     <h3>Parameters:</h3>
@@ -985,13 +1028,15 @@ system.<span class="function-name">listconsoleflags</span>(<span class="global">
 
     <h3>See also:</h3>
     <ul>
-         <a href="../modules/system.html#getnonblock">getnonblock</a>
+         <li><a href="../modules/system.html#getnonblock">getnonblock</a></li>
+         <li><a href="../modules/system.html#detachfds">detachfds</a></li>
     </ul>
 
     <h3>Usage:</h3>
     <ul>
         <pre class="example"><span class="keyword">local</span> sys = <span class="global">require</span>(<span class="string">'system'</span>)
-
+sys.<span class="function-name">detachfds</span>() <span class="comment">-- detach stdout and stderr, so only stdin becomes non-blocking
+</span>
 <span class="comment">-- set io.stdin to non-blocking mode
 </span><span class="keyword">local</span> old_setting = sys.<span class="function-name">getnonblock</span>(<span class="global">io</span>.stdin)
 sys.<span class="function-name">setnonblock</span>(<span class="global">io</span>.stdin, <span class="keyword">true</span>)
@@ -1422,7 +1467,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-03-12 15:17:50 </i>
+<i style="float:right;">Last updated 2025-04-10 10:12:11 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>
-- 
cgit v1.2.3-55-g6feb