1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Lua-System docs</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>Lua-System</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Versioning">Versioning </a></li>
<li><a href="#Version_history">Version history </a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
<li><a href="../topics/02-development.md.html">2. Development</a></li>
<li><a href="../topics/03-terminal.md.html">3. Terminal functionality</a></li>
<li><strong>CHANGELOG</strong></li>
<li><a href="../topics/LICENSE.md.html">MIT License</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/system.html">system</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/bitflags.html">bitflags</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/compat.lua.html">compat.lua</a></li>
<li><a href="../examples/flag_debugging.lua.html">flag_debugging.lua</a></li>
<li><a href="../examples/password_input.lua.html">password_input.lua</a></li>
<li><a href="../examples/read.lua.html">read.lua</a></li>
<li><a href="../examples/readline.lua.html">readline.lua</a></li>
<li><a href="../examples/spinner.lua.html">spinner.lua</a></li>
<li><a href="../examples/spiral_snake.lua.html">spiral_snake.lua</a></li>
<li><a href="../examples/terminalsize.lua.html">terminalsize.lua</a></li>
</ul>
</div>
<div id="content">
<h1>CHANGELOG</h1>
<p><a name="Versioning"></a></p>
<h2>Versioning</h2>
<p>This library is versioned based on Semantic Versioning (<a href="https://semver.org/">SemVer</a>).</p>
<h4>Version scoping</h4>
<p>The scope of what is covered by the version number excludes:</p>
<ul>
<li>error messages; the text of the messages can change, unless specifically documented.</li>
</ul>
<h4>Releasing new versions</h4>
<ul>
<li>create a release branch</li>
<li>update the changelog below</li>
<li>update version and copyright-years in <code>./LICENSE.md</code> and <code>./src/core.c</code> (in module constants)</li>
<li>create a new rockspec and update the version inside the new rockspec:<br/>
<code>cp luasystem-scm-0.rockspec ./rockspecs/luasystem-X.Y.Z-1.rockspec</code></li>
<li>clean and render the docs: run <code>ldoc .</code></li>
<li>commit the changes as <code>Release vX.Y.Z</code></li>
<li>push the commit, and create a release PR</li>
<li>after merging tag the release commit with <code>vX.Y.Z</code></li>
<li>upload to LuaRocks will be automatic by the CI runners</li>
<li>test the newly created rock:<br/>
<code>luarocks install luasystem</code></li>
</ul>
<p><a name="Version_history"></a></p>
<h2>Version history</h2>
<h3>version 0.6.3, released 11-Jul-2025</h3>
<ul>
<li>Fix: maximum key-delay, reduced from 0.2 to 0.1 seconds to reduce slugginess feel on some key presses.
See <a href="https://github.com/lunarmodules/luasystem/pull/69">#69</a>.</li>
<li>Fix: <code>readansi</code> now only reports printable chars as characters
See <a href="https://github.com/lunarmodules/luasystem/pull/70">#70</a>.</li>
<li>Fix: readkey now ignores Windows scancodes if received.
See <a href="https://github.com/lunarmodules/luasystem/pull/74">#74</a>.</li>
<li>Fix: readkey now passes errors on.
See <a href="https://github.com/lunarmodules/luasystem/pull/74">#74</a>.</li>
</ul>
<h3>version 0.6.2, released 15-Apr-2025</h3>
<ul>
<li>Fix: autotermrestore didn't work because its metatable was overwritten.</li>
</ul>
<h3>version 0.6.1, released 13-Apr-2025</h3>
<ul>
<li>Docs: document readansi internal buffer for incomplete sequences.</li>
<li>Fix: ensure to properly parse <code><alt>+key</code> key presses</li>
</ul>
<h3>version 0.6.0, released 10-Apr-2025</h3>
<ul>
<li>Fix: when sleep returns an error, pass that on in <code>readkey</code>.</li>
<li>Feat: added <code>detachfds</code> which will create separate file descriptions for <code>stdout</code>
and <code>stderr</code> to ensure that related settings (eg. non-blocking flag) will not be shared
amongst those streams and <code>stdin</code>.</li>
</ul>
<h3>version 0.5.1, released 12-Mar-2025</h3>
<ul>
<li>Fix: on older unixes with glibc < 2.25, fall back to <code>/dev/urandom</code></li>
</ul>
<h3>version 0.5.0, released 02-Mar-2025</h3>
<ul>
<li>Feat: when detecting character display width, also accept unicode codepoints (integers),
since the Lua utf8 library returns codepoints, not strings</li>
<li>Feat: allow passing in a sleep function to <code>readkey</code> and <code>readansi</code></li>
<li>Fix: NetBSD fix compilation, undeclared directives</li>
<li>Refactor: random bytes; remove deprecated API usage on Windows, move to
binary api instead of <code>/dev/urandom</code> file on linux and bsd</li>
</ul>
<h3>version 0.4.5, released 18-Dec-2024</h3>
<ul>
<li>Fix: suppress a warning when building with clang</li>
<li>Fix: do not rely on <code>luaconf.h</code> to include <code>limits.h</code>, fixes builds with latest LuaJIT (#38).</li>
</ul>
<h3>version 0.4.4, released 03-Sep-2024</h3>
<ul>
<li>Fix: include all objects in Makefile</li>
</ul>
<h3>version 0.4.3, released 28-Aug-2024</h3>
<ul>
<li>Chore: add compiler error on Windows if Virtual Terminal Processing is unavailable.</li>
<li>Fix: fix the freebsd build</li>
</ul>
<h3>Version 0.4.2, released 25-Jun-2024</h3>
<ul>
<li>Fix: include additional headers for some MinGW installations</li>
</ul>
<h3>Version 0.4.1, released 25-Jun-2024</h3>
<ul>
<li>Fix: when compiling with <code>msys2</code> the <code>conio.h</code> header is required</li>
</ul>
<h3>Version 0.4.0, released 20-Jun-2024</h3>
<ul>
<li>Feat: <code>getconsoleflags</code> and <code>setconsoleflags</code> for getting/setting the current console configuration flags on Windows</li>
<li>Feat: <code>getconsolecp</code> and <code>setconsolecp</code> for getting/setting the console codepage on Windows</li>
<li>Feat: <code>getconsoleoutputcp</code> and <code>setconsoleoutputcp</code> for getting/setting the console output codepage on Windows</li>
<li>Feat: <code>tcgetattr</code> and <code>tcsetattr</code> for getting/setting the current console configuration flags on Posix</li>
<li>Feat: <code>getnonblock</code> and <code>setnonblock</code> for getting/setting the non-blocking flag on Posix</li>
<li>Feat: <a href="../classes/bitflags.html#">bitflags</a>: a support feature for the above flag type controls to facilitate bit manipulation without resorting to binary operations (to also support PuC Lua 5.1)</li>
<li>Feat: <code>readkey</code> reads a keyboard input from <code>stdin</code> in a non-blocking way (utf8, also on Windows)</li>
<li>Feat: <code>readansi</code> reads a keyboard input from <code>stdin</code> in a non-blocking way, parses ansi and utf8 sequences</li>
<li>Feat: <code>termsize</code> gets the current terminal size in rows and columns</li>
<li>Feat: <code>utf8cwidth</code> and <code>utf8swidth</code> for getting the display width (in columns) of respectively a single utf8 character, or a utf8 string</li>
<li>Feat: helpers; <code>termbackup</code>, <code>termrestore</code>, <code>autotermrestore</code>, and <code>termwrap</code> for managing the many terminal settings on all platforms.</li>
</ul>
<h3>Version 0.3.0, released 15-Dec-2023</h3>
<ul>
<li>Feat: on Windows <code>sleep</code> now has a precision parameter</li>
<li>Feat: <code>setenv</code> added to set environment variables.</li>
<li>Feat: <code>getenvs</code> added to list environment variables.</li>
<li>Feat: <code>getenv</code> added to get environment variable previously set (Windows).</li>
<li>Feat: <code>random</code> added to return high-quality random bytes</li>
<li>Feat: <code>isatty</code> added to check if a file-handle is a tty</li>
</ul>
<h3>Version 0.2.1, released 02-Oct-2016</h3>
<h3>Version 0.2.0, released 08-May-2016</h3>
<h3>Version 0.1.1, released 10-Apr-2016</h3>
<h3>Version 0.1.0, released 11-Feb-2016</h3>
<ul>
<li>initial release</li>
</ul>
</div> <!-- id="content" -->
</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-07-11 22:55:05 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
