1 files changed, 35 insertions, 11 deletions

diff --git a/docs/index.html b/docs/index.html
index 4dd5848..116fc0a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -64,13 +64,13 @@
                 <font size="-1">
                         <p>
                                 <br />
-                                <i>Copyright &copy; 2007-24 Asko Kauppi, Benoit Germain. All rights reserved.</i>
+                                <i>Copyright &copy; 2007-25 Asko Kauppi, Benoit Germain. All rights reserved.</i>
                                 <br />
                                 Lua Lanes is published under the same <a href="http://en.wikipedia.org/wiki/MIT_License">MIT license</a> as Lua 5.1, 5.2, 5.3 and 5.4.
                         </p>
 
                         <p>
-                                This document was revised on 17-Mar-25, and applies to version <tt>4.0.0</tt>.
+                                This document was revised on 18-Apr-25, and applies to version <tt>4.0.0</tt>.
                         </p>
                 </font>
         </center>
@@ -271,7 +271,7 @@
 </p>
 
 <p>
-        <tt>lanes.configure</tt> accepts an optional options table as sole argument.
+        <tt>lanes.configure</tt> accepts an optional table as sole argument.
         <table border="1" cellpadding="10" style="width:100%">
                 <tr>
                         <th style="width:15%">name</th>
@@ -337,6 +337,22 @@
                 </tr>
 
                 <tr valign=top>
+                        <td id="linda_wake_period">
+                                <code>.linda_wake_period</code>
+                        </td>
+                        <td>
+                                number > 0
+                        </td>
+                        <td>
+                                Sets the default period in seconds a linda will wake by itself during blocked operations. Default is never.<br />
+                                When a Linda enters a blocking call (<tt>send()</tt>, <tt>receive()</tt>, <tt>receive_batched()</tt>, <tt>sleep()</tt>), it normally sleeps either until the operation completes
+                                or the specified timeout expires. With this setting, the default behavior can be changed to wake periodically. This can help for example with timing issues where a lane is signalled
+                                for cancellation, but a linda inside the lane was in the middle of processing an operation but did not actually start the wait. This can result in the signal to be ignored, thus
+                                causing the Linda to wait out the full operation timeout before cancellation is processed.
+                        </td>
+                </tr>
+
+                <tr valign=top>
                         <td id="nb_user_keepers">
                                 <code>.nb_user_keepers</code>
                         </td>
@@ -1222,7 +1238,7 @@
 <table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%"><tr><td><pre>
         local lanes = require "lanes"
 
-        local linda = lanes.linda("my linda")
+        local linda = lanes.linda{name = "my linda"}
 
         local function loop(max)
                 for i = 1, max do
@@ -1276,16 +1292,24 @@
 </p>
 
 <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
-        h = lanes.linda([name],[group],[close_handler])
+        h = lanes.linda(table|nil)
 </pre></td></tr></table>
 
 <p>
-        Arguments to <tt>lanes.linda()</tt>  can be provided in any order, as long as there is a single string, a single number, and a single callable value (all are optional).<br />
-        Converting the linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.<br />
-        If <tt>opt_name</tt> is omitted, it will evaluate to an hexadecimal number uniquely representing that linda when the linda is converted to a string. The value is the same as returned by <tt>linda:deep()</tt>.<br />
-        If <tt>opt_name</tt> is <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the linda name will be <tt>"&lt;unresolved&gt;"</tt>.<br />
-        If Lanes is configured with more than one Keeper state, <tt>group</tt> is mandatory.<br />
-        If the linda is to-be-closed (Lua 5.4+), and a <tt>close_handler</tt> is provided, it will be called with all the provided arguments. For older Lua versions, its presence will cause an error.
+        Argument to <tt>lanes.linda()</tt> is either <tt>nil</tt> or a single table. The table may contain the following entries:
+        <ul>
+                <li><tt>close_handler</tt>: a callable object (function or table/userdata with <tt>__call</tt> metamethod). If provided, and the linda is to-be-closed (Lua 5.4+), it will be called with all the provided arguments. For older Lua versions, its presence is ignored.</li>
+                <li><tt>group</tt>: an integer between 0 and the number of Keeper states. Mandatory if Lanes is configured with more than one Keeper state. Group 0 is used by the internal timer linda.</li>
+                <li>
+                        <tt>name</tt>: a string. Converting the linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.
+                        If omitted or empty, it will evaluate to the string representation of a hexadecimal number uniquely representing that linda when the linda is converted to a string. The numeric value is the same as returned by <tt>linda:deep()</tt>.<br />
+                        If <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the linda name will be <tt>"&lt;unresolved&gt;"</tt>.
+                </li>
+                <li>
+                        <tt>wake_period</tt>: a number > 0 (unit: seconds). If provided, overrides <a href="#linda_wake_period"><tt>linda_wake_period</tt></a> provided to <a href="#initialization"><tt>lanes.configure()</tt></a>.
+                </li>
+        </ul>
+        Unknown fields are silently ignored.
 </p>
 
 <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>