aboutsummaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/01-introduction.md.html2
-rw-r--r--docs/topics/02-development.md.html2
-rw-r--r--docs/topics/03-terminal.md.html4
-rw-r--r--docs/topics/CHANGELOG.md.html52
-rw-r--r--docs/topics/LICENSE.md.html2
5 files changed, 52 insertions, 10 deletions
diff --git a/docs/topics/01-introduction.md.html b/docs/topics/01-introduction.md.html
index cf8a21f..264aa71 100644
--- a/docs/topics/01-introduction.md.html
+++ b/docs/topics/01-introduction.md.html
@@ -84,7 +84,7 @@ independence.</p>
84</div> <!-- id="main" --> 84</div> <!-- id="main" -->
85<div id="about"> 85<div id="about">
86<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 86<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
87<i style="float:right;">Last updated 2025-03-02 19:43:40 </i> 87<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
88</div> <!-- id="about" --> 88</div> <!-- id="about" -->
89</div> <!-- id="container" --> 89</div> <!-- id="container" -->
90</body> 90</body>
diff --git a/docs/topics/02-development.md.html b/docs/topics/02-development.md.html
index b9f79fd..15efe55 100644
--- a/docs/topics/02-development.md.html
+++ b/docs/topics/02-development.md.html
@@ -84,7 +84,7 @@ pass locally, and do not rely on CI only.</p>
84</div> <!-- id="main" --> 84</div> <!-- id="main" -->
85<div id="about"> 85<div id="about">
86<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 86<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
87<i style="float:right;">Last updated 2025-03-02 19:43:40 </i> 87<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
88</div> <!-- id="about" --> 88</div> <!-- id="about" -->
89</div> <!-- id="container" --> 89</div> <!-- id="container" -->
90</body> 90</body>
diff --git a/docs/topics/03-terminal.md.html b/docs/topics/03-terminal.md.html
index 8c45d6e..27772ac 100644
--- a/docs/topics/03-terminal.md.html
+++ b/docs/topics/03-terminal.md.html
@@ -93,6 +93,7 @@ up both platforms to make it work.</p>
93 <li><a href="../modules/system.html#setconsoleflags">system.setconsoleflags</a> (Windows)</li> 93 <li><a href="../modules/system.html#setconsoleflags">system.setconsoleflags</a> (Windows)</li>
94 <li><a href="../modules/system.html#setconsolecp">system.setconsolecp</a> (Windows)</li> 94 <li><a href="../modules/system.html#setconsolecp">system.setconsolecp</a> (Windows)</li>
95 <li><a href="../modules/system.html#setconsoleoutputcp">system.setconsoleoutputcp</a> (Windows)</li> 95 <li><a href="../modules/system.html#setconsoleoutputcp">system.setconsoleoutputcp</a> (Windows)</li>
96 <li><a href="../modules/system.html#detachfds">system.detachfds</a> (Posix)</li>
96 <li><a href="../modules/system.html#setnonblock">system.setnonblock</a> (Posix)</li> 97 <li><a href="../modules/system.html#setnonblock">system.setnonblock</a> (Posix)</li>
97 <li><a href="../modules/system.html#tcsetattr">system.tcsetattr</a> (Posix)</li> 98 <li><a href="../modules/system.html#tcsetattr">system.tcsetattr</a> (Posix)</li>
98</ul> 99</ul>
@@ -195,6 +196,7 @@ also not being echoed to the terminal (independent of the echo settings used wit
195</span>sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdin, sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdin) - sys.CIF_ECHO_INPUT - sys.CIF_LINE_INPUT) 196</span>sys.<span class="function-name">setconsoleflags</span>(<span class="global">io</span>.stdin, sys.<span class="function-name">getconsoleflags</span>(<span class="global">io</span>.stdin) - sys.CIF_ECHO_INPUT - sys.CIF_LINE_INPUT)
196 197
197<span class="comment">-- setup Posix by disabling echo, canonical mode, and making non-blocking 198<span class="comment">-- setup Posix by disabling echo, canonical mode, and making non-blocking
199</span>sys.<span class="function-name">detachfds</span>() <span class="comment">-- ensure stdin/out/err have their own file descriptions
198</span><span class="keyword">local</span> of_attr = sys.<span class="function-name">tcgetattr</span>(<span class="global">io</span>.stdin) 200</span><span class="keyword">local</span> of_attr = sys.<span class="function-name">tcgetattr</span>(<span class="global">io</span>.stdin)
199sys.<span class="function-name">tcsetattr</span>(<span class="global">io</span>.stdin, sys.TCSANOW, { 201sys.<span class="function-name">tcsetattr</span>(<span class="global">io</span>.stdin, sys.TCSANOW, {
200 lflag = of_attr.lflag - sys.L_ICANON - sys.L_ECHO, 202 lflag = of_attr.lflag - sys.L_ICANON - sys.L_ECHO,
@@ -218,7 +220,7 @@ For an example see <a href="../examples/password_input.lua.html"><code>examples/
218</div> <!-- id="main" --> 220</div> <!-- id="main" -->
219<div id="about"> 221<div id="about">
220<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 222<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
221<i style="float:right;">Last updated 2025-03-02 19:43:40 </i> 223<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
222</div> <!-- id="about" --> 224</div> <!-- id="about" -->
223</div> <!-- id="container" --> 225</div> <!-- id="container" -->
224</body> 226</body>
diff --git a/docs/topics/CHANGELOG.md.html b/docs/topics/CHANGELOG.md.html
index fd3ba59..9603abd 100644
--- a/docs/topics/CHANGELOG.md.html
+++ b/docs/topics/CHANGELOG.md.html
@@ -98,8 +98,7 @@
98 <li>commit the changes as <code>Release vX.Y.Z</code></li> 98 <li>commit the changes as <code>Release vX.Y.Z</code></li>
99 <li>push the commit, and create a release PR</li> 99 <li>push the commit, and create a release PR</li>
100 <li>after merging tag the release commit with <code>vX.Y.Z</code></li> 100 <li>after merging tag the release commit with <code>vX.Y.Z</code></li>
101 <li>upload to LuaRocks:<br/> 101 <li>upload to LuaRocks will be automatic by the CI runners</li>
102 <code>luarocks upload ./rockspecs/luasystem-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></li>
103 <li>test the newly created rock:<br/> 102 <li>test the newly created rock:<br/>
104 <code>luarocks install luasystem</code></li> 103 <code>luarocks install luasystem</code></li>
105</ul> 104</ul>
@@ -107,7 +106,48 @@
107<p><a name="Version_history"></a></p> 106<p><a name="Version_history"></a></p>
108<h2>Version history</h2> 107<h2>Version history</h2>
109 108
110<h3>unreleased</h3> 109<h3>version 0.6.3, released 11-Jul-2025</h3>
110
111<ul>
112 <li>Fix: maximum key-delay, reduced from 0.2 to 0.1 seconds to reduce slugginess feel on some key presses.
113 See <a href="https://github.com/lunarmodules/luasystem/pull/69">#69</a>.</li>
114 <li>Fix: <code>readansi</code> now only reports printable chars as characters
115 See <a href="https://github.com/lunarmodules/luasystem/pull/70">#70</a>.</li>
116 <li>Fix: readkey now ignores Windows scancodes if received.
117 See <a href="https://github.com/lunarmodules/luasystem/pull/74">#74</a>.</li>
118 <li>Fix: readkey now passes errors on.
119 See <a href="https://github.com/lunarmodules/luasystem/pull/74">#74</a>.</li>
120</ul>
121
122<h3>version 0.6.2, released 15-Apr-2025</h3>
123
124<ul>
125 <li>Fix: autotermrestore didn't work because its metatable was overwritten.</li>
126</ul>
127
128<h3>version 0.6.1, released 13-Apr-2025</h3>
129
130<ul>
131 <li>Docs: document readansi internal buffer for incomplete sequences.</li>
132 <li>Fix: ensure to properly parse <code>&lt;alt&gt;+key</code> key presses</li>
133</ul>
134
135<h3>version 0.6.0, released 10-Apr-2025</h3>
136
137<ul>
138 <li>Fix: when sleep returns an error, pass that on in <code>readkey</code>.</li>
139 <li>Feat: added <code>detachfds</code> which will create separate file descriptions for <code>stdout</code>
140 and <code>stderr</code> to ensure that related settings (eg. non-blocking flag) will not be shared
141 amongst those streams and <code>stdin</code>.</li>
142</ul>
143
144<h3>version 0.5.1, released 12-Mar-2025</h3>
145
146<ul>
147 <li>Fix: on older unixes with glibc &lt; 2.25, fall back to <code>/dev/urandom</code></li>
148</ul>
149
150<h3>version 0.5.0, released 02-Mar-2025</h3>
111 151
112<ul> 152<ul>
113 <li>Feat: when detecting character display width, also accept unicode codepoints (integers), 153 <li>Feat: when detecting character display width, also accept unicode codepoints (integers),
@@ -115,14 +155,14 @@
115 <li>Feat: allow passing in a sleep function to <code>readkey</code> and <code>readansi</code></li> 155 <li>Feat: allow passing in a sleep function to <code>readkey</code> and <code>readansi</code></li>
116 <li>Fix: NetBSD fix compilation, undeclared directives</li> 156 <li>Fix: NetBSD fix compilation, undeclared directives</li>
117 <li>Refactor: random bytes; remove deprecated API usage on Windows, move to 157 <li>Refactor: random bytes; remove deprecated API usage on Windows, move to
118 binary api instead of /dev/urandom file on linux and bsd</li> 158 binary api instead of <code>/dev/urandom</code> file on linux and bsd</li>
119</ul> 159</ul>
120 160
121<h3>version 0.4.5, released 18-Dec-2024</h3> 161<h3>version 0.4.5, released 18-Dec-2024</h3>
122 162
123<ul> 163<ul>
124 <li>Fix: suppress a warning when building with clang</li> 164 <li>Fix: suppress a warning when building with clang</li>
125 <li>Fix: do not rely on luaconf.h to include limits.h, fixes builds with latest LuaJIT (#38).</li> 165 <li>Fix: do not rely on <code>luaconf.h</code> to include <code>limits.h</code>, fixes builds with latest LuaJIT (#38).</li>
126</ul> 166</ul>
127 167
128<h3>version 0.4.4, released 03-Sep-2024</h3> 168<h3>version 0.4.4, released 03-Sep-2024</h3>
@@ -194,7 +234,7 @@
194</div> <!-- id="main" --> 234</div> <!-- id="main" -->
195<div id="about"> 235<div id="about">
196<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 236<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
197<i style="float:right;">Last updated 2025-03-02 19:43:40 </i> 237<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
198</div> <!-- id="about" --> 238</div> <!-- id="about" -->
199</div> <!-- id="container" --> 239</div> <!-- id="container" -->
200</body> 240</body>
diff --git a/docs/topics/LICENSE.md.html b/docs/topics/LICENSE.md.html
index bbe229e..c0b9b93 100644
--- a/docs/topics/LICENSE.md.html
+++ b/docs/topics/LICENSE.md.html
@@ -94,7 +94,7 @@ SOFTWARE.</p>
94</div> <!-- id="main" --> 94</div> <!-- id="main" -->
95<div id="about"> 95<div id="about">
96<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> 96<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
97<i style="float:right;">Last updated 2025-03-02 19:43:40 </i> 97<i style="float:right;">Last updated 2025-07-11 22:55:05 </i>
98</div> <!-- id="about" --> 98</div> <!-- id="about" -->
99</div> <!-- id="container" --> 99</div> <!-- id="container" -->
100</body> 100</body>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-14 02:11:33 +0000