diff options
-rw-r--r-- | docs/index.html | 366 | ||||
-rw-r--r-- | docs/ldoc.css | 291 | ||||
-rw-r--r-- | docs/topics/01-introduction.md.html | 70 | ||||
-rw-r--r-- | docs/topics/CHANGELOG.md.html | 121 | ||||
-rw-r--r-- | docs/topics/LICENSE.md.html | 79 |
5 files changed, 927 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..eb241c6 --- /dev/null +++ b/docs/index.html | |||
@@ -0,0 +1,366 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
3 | <html> | ||
4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
5 | <head> | ||
6 | <title>Lua-System docs</title> | ||
7 | <link rel="stylesheet" href="ldoc.css" type="text/css" /> | ||
8 | </head> | ||
9 | <body> | ||
10 | |||
11 | <div id="container"> | ||
12 | |||
13 | <div id="product"> | ||
14 | <div id="product_logo"></div> | ||
15 | <div id="product_name"><big><b></b></big></div> | ||
16 | <div id="product_description"></div> | ||
17 | </div> <!-- id="product" --> | ||
18 | |||
19 | |||
20 | <div id="main"> | ||
21 | |||
22 | |||
23 | <!-- Menu --> | ||
24 | |||
25 | <div id="navigation"> | ||
26 | <br/> | ||
27 | <h1>Lua-System</h1> | ||
28 | |||
29 | |||
30 | <h2>Contents</h2> | ||
31 | <ul> | ||
32 | <li><a href="#environment_Functions">environment Functions</a></li> | ||
33 | <li><a href="#random_Functions">random Functions</a></li> | ||
34 | <li><a href="#term_Functions">term Functions</a></li> | ||
35 | <li><a href="#time_Functions">time Functions</a></li> | ||
36 | </ul> | ||
37 | |||
38 | |||
39 | <h2>Modules</h2> | ||
40 | <ul class="nowrap"> | ||
41 | <li><strong>system</strong></li> | ||
42 | </ul> | ||
43 | <h2>Topics</h2> | ||
44 | <ul class=""> | ||
45 | <li><a href="topics/01-introduction.md.html">1. Introduction</a></li> | ||
46 | <li><a href="topics/CHANGELOG.md.html">CHANGELOG</a></li> | ||
47 | <li><a href="topics/LICENSE.md.html">MIT License</a></li> | ||
48 | </ul> | ||
49 | |||
50 | </div> | ||
51 | |||
52 | <div id="content"> | ||
53 | |||
54 | <h1>Module <code>system</code></h1> | ||
55 | <p>Platform independent system calls for Lua.</p> | ||
56 | <p> | ||
57 | |||
58 | </p> | ||
59 | |||
60 | |||
61 | <h2><a href="#environment_Functions">environment Functions</a></h2> | ||
62 | <table class="function_list"> | ||
63 | <tr> | ||
64 | <td class="name" nowrap><a href="#getenv">getenv (name)</a></td> | ||
65 | <td class="summary">Gets the value of an environment variable.</td> | ||
66 | </tr> | ||
67 | <tr> | ||
68 | <td class="name" nowrap><a href="#getenvs">getenvs ()</a></td> | ||
69 | <td class="summary">Returns a table with all environment variables.</td> | ||
70 | </tr> | ||
71 | <tr> | ||
72 | <td class="name" nowrap><a href="#setenv">setenv (name[, value])</a></td> | ||
73 | <td class="summary">Sets an environment variable.</td> | ||
74 | </tr> | ||
75 | </table> | ||
76 | <h2><a href="#random_Functions">random Functions</a></h2> | ||
77 | <table class="function_list"> | ||
78 | <tr> | ||
79 | <td class="name" nowrap><a href="#random">random ([length=1])</a></td> | ||
80 | <td class="summary">Generate random bytes.</td> | ||
81 | </tr> | ||
82 | </table> | ||
83 | <h2><a href="#term_Functions">term Functions</a></h2> | ||
84 | <table class="function_list"> | ||
85 | <tr> | ||
86 | <td class="name" nowrap><a href="#isatty">isatty (file)</a></td> | ||
87 | <td class="summary">Checks if a file-handle is a TTY.</td> | ||
88 | </tr> | ||
89 | </table> | ||
90 | <h2><a href="#time_Functions">time Functions</a></h2> | ||
91 | <table class="function_list"> | ||
92 | <tr> | ||
93 | <td class="name" nowrap><a href="#gettime">gettime ()</a></td> | ||
94 | <td class="summary">Get system time.</td> | ||
95 | </tr> | ||
96 | <tr> | ||
97 | <td class="name" nowrap><a href="#monotime">monotime ()</a></td> | ||
98 | <td class="summary">Get monotonic time.</td> | ||
99 | </tr> | ||
100 | <tr> | ||
101 | <td class="name" nowrap><a href="#sleep">sleep (seconds[, precision=16])</a></td> | ||
102 | <td class="summary">Sleep without a busy loop.</td> | ||
103 | </tr> | ||
104 | </table> | ||
105 | |||
106 | <br/> | ||
107 | <br/> | ||
108 | |||
109 | |||
110 | <h2 class="section-header "><a name="environment_Functions"></a>environment Functions</h2> | ||
111 | |||
112 | <dl class="function"> | ||
113 | <dt> | ||
114 | <a name = "getenv"></a> | ||
115 | <strong>getenv (name)</strong> | ||
116 | </dt> | ||
117 | <dd> | ||
118 | Gets the value of an environment variable. </p> | ||
119 | |||
120 | <p><strong>NOTE</strong>: Windows has multiple copies of environment variables. For this reason, | ||
121 | the <a href="index.html#setenv">setenv</a> function will not work with Lua's <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.getenv">os.getenv</a> on Windows. If you want | ||
122 | to use <a href="index.html#setenv">setenv</a> then consider patching <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.getenv">os.getenv</a> with this implementation of <a href="index.html#getenv">getenv</a>. | ||
123 | |||
124 | |||
125 | <h3>Parameters:</h3> | ||
126 | <ul> | ||
127 | <li><span class="parameter">name</span> | ||
128 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> | ||
129 | name of the environment variable | ||
130 | </li> | ||
131 | </ul> | ||
132 | |||
133 | <h3>Returns:</h3> | ||
134 | <ol> | ||
135 | |||
136 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a> or <span class="type">nil</span></span> | ||
137 | value of the environment variable, or nil if the variable is not set | ||
138 | </ol> | ||
139 | |||
140 | |||
141 | |||
142 | |||
143 | </dd> | ||
144 | <dt> | ||
145 | <a name = "getenvs"></a> | ||
146 | <strong>getenvs ()</strong> | ||
147 | </dt> | ||
148 | <dd> | ||
149 | Returns a table with all environment variables. | ||
150 | |||
151 | |||
152 | |||
153 | <h3>Returns:</h3> | ||
154 | <ol> | ||
155 | |||
156 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> | ||
157 | table with all environment variables and their values | ||
158 | </ol> | ||
159 | |||
160 | |||
161 | |||
162 | |||
163 | </dd> | ||
164 | <dt> | ||
165 | <a name = "setenv"></a> | ||
166 | <strong>setenv (name[, value])</strong> | ||
167 | </dt> | ||
168 | <dd> | ||
169 | Sets an environment variable. </p> | ||
170 | |||
171 | <p><strong>NOTE</strong>: Windows has multiple copies of environment variables. For this reason, the | ||
172 | <a href="index.html#setenv">setenv</a> function will not work with Lua's <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.getenv">os.getenv</a> on Windows. If you want to use | ||
173 | it then consider patching <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.getenv">os.getenv</a> with the implementation of <a href="index.html#getenv">system.getenv</a>. | ||
174 | |||
175 | |||
176 | <h3>Parameters:</h3> | ||
177 | <ul> | ||
178 | <li><span class="parameter">name</span> | ||
179 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> | ||
180 | name of the environment variable | ||
181 | </li> | ||
182 | <li><span class="parameter">value</span> | ||
183 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> | ||
184 | value of the environment variable, if <code>nil</code> the variable will be deleted (on | ||
185 | Windows, setting an empty string, will also delete the variable) | ||
186 | (<em>optional</em>) | ||
187 | </li> | ||
188 | </ul> | ||
189 | |||
190 | <h3>Returns:</h3> | ||
191 | <ol> | ||
192 | |||
193 | <span class="types"><span class="type">boolean</span></span> | ||
194 | success | ||
195 | </ol> | ||
196 | |||
197 | |||
198 | |||
199 | |||
200 | </dd> | ||
201 | </dl> | ||
202 | <h2 class="section-header "><a name="random_Functions"></a>random Functions</h2> | ||
203 | |||
204 | <dl class="function"> | ||
205 | <dt> | ||
206 | <a name = "random"></a> | ||
207 | <strong>random ([length=1])</strong> | ||
208 | </dt> | ||
209 | <dd> | ||
210 | Generate random bytes. | ||
211 | This uses <code>CryptGenRandom()</code> on Windows, and <code>/dev/urandom</code> on other platforms. It will return the | ||
212 | requested number of bytes, or an error, never a partial result. | ||
213 | |||
214 | |||
215 | <h3>Parameters:</h3> | ||
216 | <ul> | ||
217 | <li><span class="parameter">length</span> | ||
218 | <span class="types"><span class="type">int</span></span> | ||
219 | number of bytes to get | ||
220 | (<em>default</em> 1) | ||
221 | </li> | ||
222 | </ul> | ||
223 | |||
224 | <h3>Returns:</h3> | ||
225 | <ol> | ||
226 | |||
227 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> | ||
228 | string of random bytes | ||
229 | </ol> | ||
230 | <h3>Or</h3> | ||
231 | <ol> | ||
232 | <li> | ||
233 | <span class="types"><span class="type">nil</span></span> | ||
234 | |||
235 | |||
236 | </li> | ||
237 | <li> | ||
238 | <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> | ||
239 | error message</li> | ||
240 | </ol> | ||
241 | |||
242 | |||
243 | |||
244 | |||
245 | </dd> | ||
246 | </dl> | ||
247 | <h2 class="section-header "><a name="term_Functions"></a>term Functions</h2> | ||
248 | |||
249 | <dl class="function"> | ||
250 | <dt> | ||
251 | <a name = "isatty"></a> | ||
252 | <strong>isatty (file)</strong> | ||
253 | </dt> | ||
254 | <dd> | ||
255 | Checks if a file-handle is a TTY. | ||
256 | |||
257 | |||
258 | <h3>Parameters:</h3> | ||
259 | <ul> | ||
260 | <li><span class="parameter">file</span> | ||
261 | <span class="types"><span class="type">file</span></span> | ||
262 | the file-handle to check | ||
263 | </li> | ||
264 | </ul> | ||
265 | |||
266 | <h3>Returns:</h3> | ||
267 | <ol> | ||
268 | |||
269 | <span class="types"><span class="type">boolean</span></span> | ||
270 | true if the file is a tty | ||
271 | </ol> | ||
272 | |||
273 | |||
274 | |||
275 | |||
276 | </dd> | ||
277 | </dl> | ||
278 | <h2 class="section-header "><a name="time_Functions"></a>time Functions</h2> | ||
279 | |||
280 | <dl class="function"> | ||
281 | <dt> | ||
282 | <a name = "gettime"></a> | ||
283 | <strong>gettime ()</strong> | ||
284 | </dt> | ||
285 | <dd> | ||
286 | Get system time. | ||
287 | The time is returned as the seconds since the epoch (1 January 1970 00:00:00). | ||
288 | |||
289 | |||
290 | |||
291 | <h3>Returns:</h3> | ||
292 | <ol> | ||
293 | |||
294 | <span class="types"><span class="type">number</span></span> | ||
295 | seconds (fractional) | ||
296 | </ol> | ||
297 | |||
298 | |||
299 | |||
300 | |||
301 | </dd> | ||
302 | <dt> | ||
303 | <a name = "monotime"></a> | ||
304 | <strong>monotime ()</strong> | ||
305 | </dt> | ||
306 | <dd> | ||
307 | Get monotonic time. | ||
308 | The time is returned as the seconds since system start. | ||
309 | |||
310 | |||
311 | |||
312 | <h3>Returns:</h3> | ||
313 | <ol> | ||
314 | |||
315 | <span class="types"><span class="type">number</span></span> | ||
316 | seconds (fractional) | ||
317 | </ol> | ||
318 | |||
319 | |||
320 | |||
321 | |||
322 | </dd> | ||
323 | <dt> | ||
324 | <a name = "sleep"></a> | ||
325 | <strong>sleep (seconds[, precision=16])</strong> | ||
326 | </dt> | ||
327 | <dd> | ||
328 | Sleep without a busy loop. | ||
329 | This function will sleep, without doing a busy-loop and wasting CPU cycles. | ||
330 | |||
331 | |||
332 | <h3>Parameters:</h3> | ||
333 | <ul> | ||
334 | <li><span class="parameter">seconds</span> | ||
335 | <span class="types"><span class="type">number</span></span> | ||
336 | seconds to sleep (fractional). | ||
337 | </li> | ||
338 | <li><span class="parameter">precision</span> | ||
339 | <span class="types"><span class="type">integer</span></span> | ||
340 | minimum stepsize in milliseconds (Windows only, ignored elsewhere) | ||
341 | (<em>default</em> 16) | ||
342 | </li> | ||
343 | </ul> | ||
344 | |||
345 | <h3>Returns:</h3> | ||
346 | <ol> | ||
347 | |||
348 | <code>true</code> on success, or <code>nil+err</code> on failure | ||
349 | </ol> | ||
350 | |||
351 | |||
352 | |||
353 | |||
354 | </dd> | ||
355 | </dl> | ||
356 | |||
357 | |||
358 | </div> <!-- id="content" --> | ||
359 | </div> <!-- id="main" --> | ||
360 | <div id="about"> | ||
361 | <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> | ||
362 | <i style="float:right;">Last updated 2023-11-15 07:42:18 </i> | ||
363 | </div> <!-- id="about" --> | ||
364 | </div> <!-- id="container" --> | ||
365 | </body> | ||
366 | </html> | ||
diff --git a/docs/ldoc.css b/docs/ldoc.css new file mode 100644 index 0000000..5b9fbbf --- /dev/null +++ b/docs/ldoc.css | |||
@@ -0,0 +1,291 @@ | |||
1 | body { | ||
2 | color: #47555c; | ||
3 | font-size: 16px; | ||
4 | font-family: "Open Sans", sans-serif; | ||
5 | margin: 0; | ||
6 | background: #eff4ff; | ||
7 | } | ||
8 | |||
9 | a:link { color: #008fee; } | ||
10 | a:visited { color: #008fee; } | ||
11 | a:hover { color: #22a7ff; } | ||
12 | |||
13 | h1 { font-size:26px; font-weight: normal; } | ||
14 | h2 { font-size:22px; font-weight: normal; } | ||
15 | h3 { font-size:18px; font-weight: normal; } | ||
16 | h4 { font-size:16px; font-weight: bold; } | ||
17 | |||
18 | hr { | ||
19 | height: 1px; | ||
20 | background: #c1cce4; | ||
21 | border: 0px; | ||
22 | margin: 15px 0; | ||
23 | } | ||
24 | |||
25 | code, tt { | ||
26 | font-family: monospace; | ||
27 | } | ||
28 | span.parameter { | ||
29 | font-family: monospace; | ||
30 | font-weight: bold; | ||
31 | color: rgb(99, 115, 131); | ||
32 | } | ||
33 | span.parameter:after { | ||
34 | content:":"; | ||
35 | } | ||
36 | span.types:before { | ||
37 | content:"("; | ||
38 | } | ||
39 | span.types:after { | ||
40 | content:")"; | ||
41 | } | ||
42 | .type { | ||
43 | font-weight: bold; font-style:italic | ||
44 | } | ||
45 | |||
46 | p.name { | ||
47 | font-family: "Andale Mono", monospace; | ||
48 | } | ||
49 | |||
50 | #navigation { | ||
51 | float: left; | ||
52 | background-color: white; | ||
53 | border-right: 1px solid #d3dbec; | ||
54 | border-bottom: 1px solid #d3dbec; | ||
55 | |||
56 | width: 14em; | ||
57 | vertical-align: top; | ||
58 | overflow: visible; | ||
59 | } | ||
60 | |||
61 | #navigation br { | ||
62 | display: none; | ||
63 | } | ||
64 | |||
65 | #navigation h1 { | ||
66 | background-color: white; | ||
67 | border-bottom: 1px solid #d3dbec; | ||
68 | padding: 15px; | ||
69 | margin-top: 0px; | ||
70 | margin-bottom: 0px; | ||
71 | } | ||
72 | |||
73 | #navigation h2 { | ||
74 | font-size: 18px; | ||
75 | background-color: white; | ||
76 | border-bottom: 1px solid #d3dbec; | ||
77 | padding-left: 15px; | ||
78 | padding-right: 15px; | ||
79 | padding-top: 10px; | ||
80 | padding-bottom: 10px; | ||
81 | margin-top: 30px; | ||
82 | margin-bottom: 0px; | ||
83 | } | ||
84 | |||
85 | #content h1 { | ||
86 | background-color: #2c3e67; | ||
87 | color: white; | ||
88 | padding: 15px; | ||
89 | margin: 0px; | ||
90 | } | ||
91 | |||
92 | #content h2 { | ||
93 | background-color: #6c7ea7; | ||
94 | color: white; | ||
95 | padding: 15px; | ||
96 | padding-top: 15px; | ||
97 | padding-bottom: 15px; | ||
98 | margin-top: 0px; | ||
99 | } | ||
100 | |||
101 | #content h2 a { | ||
102 | background-color: #6c7ea7; | ||
103 | color: white; | ||
104 | text-decoration: none; | ||
105 | } | ||
106 | |||
107 | #content h2 a:hover { | ||
108 | text-decoration: underline; | ||
109 | } | ||
110 | |||
111 | #content h3 { | ||
112 | font-style: italic; | ||
113 | padding-top: 15px; | ||
114 | padding-bottom: 4px; | ||
115 | margin-right: 15px; | ||
116 | margin-left: 15px; | ||
117 | margin-bottom: 5px; | ||
118 | border-bottom: solid 1px #bcd; | ||
119 | } | ||
120 | |||
121 | #content h4 { | ||
122 | margin-right: 15px; | ||
123 | margin-left: 15px; | ||
124 | border-bottom: solid 1px #bcd; | ||
125 | } | ||
126 | |||
127 | #content pre { | ||
128 | margin: 15px; | ||
129 | } | ||
130 | |||
131 | pre { | ||
132 | background-color: rgb(50, 55, 68); | ||
133 | color: white; | ||
134 | border-radius: 3px; | ||
135 | /* border: 1px solid #C0C0C0; /* silver */ | ||
136 | padding: 15px; | ||
137 | overflow: auto; | ||
138 | font-family: "Andale Mono", monospace; | ||
139 | } | ||
140 | |||
141 | #content ul pre.example { | ||
142 | margin-left: 0px; | ||
143 | } | ||
144 | |||
145 | table.index { | ||
146 | /* border: 1px #00007f; */ | ||
147 | } | ||
148 | table.index td { text-align: left; vertical-align: top; } | ||
149 | |||
150 | #navigation ul | ||
151 | { | ||
152 | font-size:1em; | ||
153 | list-style-type: none; | ||
154 | margin: 1px 1px 10px 1px; | ||
155 | padding-left: 20px; | ||
156 | } | ||
157 | |||
158 | #navigation li { | ||
159 | text-indent: -1em; | ||
160 | display: block; | ||
161 | margin: 3px 0px 0px 22px; | ||
162 | } | ||
163 | |||
164 | #navigation li li a { | ||
165 | margin: 0px 3px 0px -1em; | ||
166 | } | ||
167 | |||
168 | #content { | ||
169 | margin-left: 14em; | ||
170 | } | ||
171 | |||
172 | #content p { | ||
173 | padding-left: 15px; | ||
174 | padding-right: 15px; | ||
175 | } | ||
176 | |||
177 | #content table { | ||
178 | padding-left: 15px; | ||
179 | padding-right: 15px; | ||
180 | background-color: white; | ||
181 | } | ||
182 | |||
183 | #content p, #content table, #content ol, #content ul, #content dl { | ||
184 | max-width: 900px; | ||
185 | } | ||
186 | |||
187 | #about { | ||
188 | padding: 15px; | ||
189 | padding-left: 16em; | ||
190 | background-color: white; | ||
191 | border-top: 1px solid #d3dbec; | ||
192 | border-bottom: 1px solid #d3dbec; | ||
193 | } | ||
194 | |||
195 | table.module_list, table.function_list { | ||
196 | border-width: 1px; | ||
197 | border-style: solid; | ||
198 | border-color: #cccccc; | ||
199 | border-collapse: collapse; | ||
200 | margin: 15px; | ||
201 | } | ||
202 | table.module_list td, table.function_list td { | ||
203 | border-width: 1px; | ||
204 | padding-left: 10px; | ||
205 | padding-right: 10px; | ||
206 | padding-top: 5px; | ||
207 | padding-bottom: 5px; | ||
208 | border: solid 1px rgb(193, 204, 228); | ||
209 | } | ||
210 | table.module_list td.name, table.function_list td.name { | ||
211 | background-color: white; min-width: 200px; border-right-width: 0px; | ||
212 | } | ||
213 | table.module_list td.summary, table.function_list td.summary { | ||
214 | background-color: white; width: 100%; border-left-width: 0px; | ||
215 | } | ||
216 | |||
217 | dl.function { | ||
218 | margin-right: 15px; | ||
219 | margin-left: 15px; | ||
220 | border-bottom: solid 1px rgb(193, 204, 228); | ||
221 | border-left: solid 1px rgb(193, 204, 228); | ||
222 | border-right: solid 1px rgb(193, 204, 228); | ||
223 | background-color: white; | ||
224 | } | ||
225 | |||
226 | dl.function dt { | ||
227 | color: rgb(99, 123, 188); | ||
228 | font-family: monospace; | ||
229 | border-top: solid 1px rgb(193, 204, 228); | ||
230 | padding: 15px; | ||
231 | } | ||
232 | |||
233 | dl.function dd { | ||
234 | margin-left: 15px; | ||
235 | margin-right: 15px; | ||
236 | margin-top: 5px; | ||
237 | margin-bottom: 15px; | ||
238 | } | ||
239 | |||
240 | #content dl.function dd h3 { | ||
241 | margin-top: 0px; | ||
242 | margin-left: 0px; | ||
243 | padding-left: 0px; | ||
244 | font-size: 16px; | ||
245 | color: rgb(128, 128, 128); | ||
246 | border-bottom: solid 1px #def; | ||
247 | } | ||
248 | |||
249 | #content dl.function dd ul, #content dl.function dd ol { | ||
250 | padding: 0px; | ||
251 | padding-left: 15px; | ||
252 | list-style-type: none; | ||
253 | } | ||
254 | |||
255 | ul.nowrap { | ||
256 | overflow:auto; | ||
257 | white-space:nowrap; | ||
258 | } | ||
259 | |||
260 | .section-description { | ||
261 | padding-left: 15px; | ||
262 | padding-right: 15px; | ||
263 | } | ||
264 | |||
265 | /* stop sublists from having initial vertical space */ | ||
266 | ul ul { margin-top: 0px; } | ||
267 | ol ul { margin-top: 0px; } | ||
268 | ol ol { margin-top: 0px; } | ||
269 | ul ol { margin-top: 0px; } | ||
270 | |||
271 | /* make the target distinct; helps when we're navigating to a function */ | ||
272 | a:target + * { | ||
273 | background-color: #FF9; | ||
274 | } | ||
275 | |||
276 | |||
277 | /* styles for prettification of source */ | ||
278 | pre .comment { color: #bbccaa; } | ||
279 | pre .constant { color: #a8660d; } | ||
280 | pre .escape { color: #844631; } | ||
281 | pre .keyword { color: #ffc090; font-weight: bold; } | ||
282 | pre .library { color: #0e7c6b; } | ||
283 | pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } | ||
284 | pre .string { color: #8080ff; } | ||
285 | pre .number { color: #f8660d; } | ||
286 | pre .operator { color: #2239a8; font-weight: bold; } | ||
287 | pre .preprocessor, pre .prepro { color: #a33243; } | ||
288 | pre .global { color: #c040c0; } | ||
289 | pre .user-keyword { color: #800080; } | ||
290 | pre .prompt { color: #558817; } | ||
291 | pre .url { color: #272fc2; text-decoration: underline; } | ||
diff --git a/docs/topics/01-introduction.md.html b/docs/topics/01-introduction.md.html new file mode 100644 index 0000000..2901cc9 --- /dev/null +++ b/docs/topics/01-introduction.md.html | |||
@@ -0,0 +1,70 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
3 | <html> | ||
4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
5 | <head> | ||
6 | <title>Lua-System docs</title> | ||
7 | <link rel="stylesheet" href="../ldoc.css" type="text/css" /> | ||
8 | </head> | ||
9 | <body> | ||
10 | |||
11 | <div id="container"> | ||
12 | |||
13 | <div id="product"> | ||
14 | <div id="product_logo"></div> | ||
15 | <div id="product_name"><big><b></b></big></div> | ||
16 | <div id="product_description"></div> | ||
17 | </div> <!-- id="product" --> | ||
18 | |||
19 | |||
20 | <div id="main"> | ||
21 | |||
22 | |||
23 | <!-- Menu --> | ||
24 | |||
25 | <div id="navigation"> | ||
26 | <br/> | ||
27 | <h1>Lua-System</h1> | ||
28 | |||
29 | |||
30 | |||
31 | |||
32 | <h2>Topics</h2> | ||
33 | <ul class=""> | ||
34 | <li><strong>1. Introduction</strong></li> | ||
35 | <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li> | ||
36 | <li><a href="../topics/LICENSE.md.html">MIT License</a></li> | ||
37 | </ul> | ||
38 | <h2>Modules</h2> | ||
39 | <ul class="nowrap"> | ||
40 | <li><a href="../index.html">system</a></li> | ||
41 | </ul> | ||
42 | |||
43 | </div> | ||
44 | |||
45 | <div id="content"> | ||
46 | |||
47 | |||
48 | <h1>1. Introduction</h1> | ||
49 | |||
50 | <p>luasystem is a platform independent system call library for Lua. | ||
51 | Supports Unix, Windows, MacOS, <code>Lua >= 5.1</code> and <code>luajit >= 2.0.0</code>.</p> | ||
52 | |||
53 | <p>Lua is typically platform independent, but it requires adhering to very old C | ||
54 | standards. This in turn means that many common features (according to todays standards) | ||
55 | are not available. This module attempts to overcome some of those hurdles by providing | ||
56 | functions that cover those common needs.</p> | ||
57 | |||
58 | <p>This is not a kitchen sink library, but a minimalistic one with a focus on platform | ||
59 | independence.</p> | ||
60 | |||
61 | |||
62 | </div> <!-- id="content" --> | ||
63 | </div> <!-- id="main" --> | ||
64 | <div id="about"> | ||
65 | <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> | ||
66 | <i style="float:right;">Last updated 2023-11-15 07:42:18 </i> | ||
67 | </div> <!-- id="about" --> | ||
68 | </div> <!-- id="container" --> | ||
69 | </body> | ||
70 | </html> | ||
diff --git a/docs/topics/CHANGELOG.md.html b/docs/topics/CHANGELOG.md.html new file mode 100644 index 0000000..f909b4b --- /dev/null +++ b/docs/topics/CHANGELOG.md.html | |||
@@ -0,0 +1,121 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
3 | <html> | ||
4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
5 | <head> | ||
6 | <title>Lua-System docs</title> | ||
7 | <link rel="stylesheet" href="../ldoc.css" type="text/css" /> | ||
8 | </head> | ||
9 | <body> | ||
10 | |||
11 | <div id="container"> | ||
12 | |||
13 | <div id="product"> | ||
14 | <div id="product_logo"></div> | ||
15 | <div id="product_name"><big><b></b></big></div> | ||
16 | <div id="product_description"></div> | ||
17 | </div> <!-- id="product" --> | ||
18 | |||
19 | |||
20 | <div id="main"> | ||
21 | |||
22 | |||
23 | <!-- Menu --> | ||
24 | |||
25 | <div id="navigation"> | ||
26 | <br/> | ||
27 | <h1>Lua-System</h1> | ||
28 | |||
29 | |||
30 | <h2>Contents</h2> | ||
31 | <ul> | ||
32 | <li><a href="#Versioning">Versioning </a></li> | ||
33 | <li><a href="#Version_history">Version history </a></li> | ||
34 | </ul> | ||
35 | |||
36 | |||
37 | <h2>Topics</h2> | ||
38 | <ul class=""> | ||
39 | <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li> | ||
40 | <li><strong>CHANGELOG</strong></li> | ||
41 | <li><a href="../topics/LICENSE.md.html">MIT License</a></li> | ||
42 | </ul> | ||
43 | <h2>Modules</h2> | ||
44 | <ul class="nowrap"> | ||
45 | <li><a href="../index.html">system</a></li> | ||
46 | </ul> | ||
47 | |||
48 | </div> | ||
49 | |||
50 | <div id="content"> | ||
51 | |||
52 | |||
53 | <h1>CHANGELOG</h1> | ||
54 | |||
55 | <p><a name="Versioning"></a></p> | ||
56 | <h2>Versioning</h2> | ||
57 | |||
58 | <p>This library is versioned based on Semantic Versioning (<a href="https://semver.org/">SemVer</a>).</p> | ||
59 | |||
60 | <h4>Version scoping</h4> | ||
61 | |||
62 | <p>The scope of what is covered by the version number excludes:</p> | ||
63 | |||
64 | <ul> | ||
65 | <li>error messages; the text of the messages can change, unless specifically documented.</li> | ||
66 | </ul> | ||
67 | |||
68 | <h4>Releasing new versions</h4> | ||
69 | |||
70 | <ul> | ||
71 | <li>create a release branch</li> | ||
72 | <li>update the changelog below</li> | ||
73 | <li>update version and copyright-years in <code>./LICENSE.md</code> and <code>./src/time.c</code> (in module constants)</li> | ||
74 | <li>create a new rockspec and update the version inside the new rockspec:<br/> | ||
75 | <code>cp luasystem-scm-0.rockspec ./rockspecs/luasystem-X.Y.Z-1.rockspec</code></li> | ||
76 | <li>clean and render the docs: run <code>ldoc .</code></li> | ||
77 | <li>commit the changes as <code>Release vX.Y.Z</code></li> | ||
78 | <li>push the commit, and create a release PR</li> | ||
79 | <li>after merging tag the release commit with <code>vX.Y.Z</code></li> | ||
80 | <li>upload to LuaRocks:<br/> | ||
81 | <code>luarocks upload ./rockspecs/luasystem-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></li> | ||
82 | <li>test the newly created rock:<br/> | ||
83 | <code>luarocks install luasystem</code></li> | ||
84 | </ul> | ||
85 | |||
86 | <p><a name="Version_history"></a></p> | ||
87 | <h2>Version history</h2> | ||
88 | |||
89 | <h3>Version X.Y.Z, unreleased</h3> | ||
90 | |||
91 | <ul> | ||
92 | <li>Feat: on Windows <a href="../index.html#sleep">sleep</a> now has a precision parameter</li> | ||
93 | <li>Feat: <a href="../index.html#setenv">setenv</a> added to set environment variables.</li> | ||
94 | <li>Feat: <a href="../index.html#getenvs">getenvs</a> added to list environment variables.</li> | ||
95 | <li>Feat: <a href="../index.html#getenv">getenv</a> added to get environment variable previously set (Windows).</li> | ||
96 | <li>Feat: <a href="../index.html#random">random</a> added to return high-quality random bytes</li> | ||
97 | <li>Feat: <a href="../index.html#isatty">isatty</a> added to check if a file-handle is a tty</li> | ||
98 | </ul> | ||
99 | |||
100 | <h3>Version 0.2.1, released 02-Oct-2016</h3> | ||
101 | |||
102 | <h3>Version 0.2.0, released 08-May-2016</h3> | ||
103 | |||
104 | <h3>Version 0.1.1, released 10-Apr-2016</h3> | ||
105 | |||
106 | <h3>Version 0.1.0, released 11-Feb-2016</h3> | ||
107 | |||
108 | <ul> | ||
109 | <li>initial release</li> | ||
110 | </ul> | ||
111 | |||
112 | |||
113 | </div> <!-- id="content" --> | ||
114 | </div> <!-- id="main" --> | ||
115 | <div id="about"> | ||
116 | <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> | ||
117 | <i style="float:right;">Last updated 2023-11-15 07:42:18 </i> | ||
118 | </div> <!-- id="about" --> | ||
119 | </div> <!-- id="container" --> | ||
120 | </body> | ||
121 | </html> | ||
diff --git a/docs/topics/LICENSE.md.html b/docs/topics/LICENSE.md.html new file mode 100644 index 0000000..67614d2 --- /dev/null +++ b/docs/topics/LICENSE.md.html | |||
@@ -0,0 +1,79 @@ | |||
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | ||
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | ||
3 | <html> | ||
4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> | ||
5 | <head> | ||
6 | <title>Lua-System docs</title> | ||
7 | <link rel="stylesheet" href="../ldoc.css" type="text/css" /> | ||
8 | </head> | ||
9 | <body> | ||
10 | |||
11 | <div id="container"> | ||
12 | |||
13 | <div id="product"> | ||
14 | <div id="product_logo"></div> | ||
15 | <div id="product_name"><big><b></b></big></div> | ||
16 | <div id="product_description"></div> | ||
17 | </div> <!-- id="product" --> | ||
18 | |||
19 | |||
20 | <div id="main"> | ||
21 | |||
22 | |||
23 | <!-- Menu --> | ||
24 | |||
25 | <div id="navigation"> | ||
26 | <br/> | ||
27 | <h1>Lua-System</h1> | ||
28 | |||
29 | |||
30 | |||
31 | |||
32 | <h2>Topics</h2> | ||
33 | <ul class=""> | ||
34 | <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li> | ||
35 | <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li> | ||
36 | <li><strong>MIT License</strong></li> | ||
37 | </ul> | ||
38 | <h2>Modules</h2> | ||
39 | <ul class="nowrap"> | ||
40 | <li><a href="../index.html">system</a></li> | ||
41 | </ul> | ||
42 | |||
43 | </div> | ||
44 | |||
45 | <div id="content"> | ||
46 | |||
47 | |||
48 | <h1>MIT License</h1> | ||
49 | |||
50 | <h3>Copyright (c) 2016-2023 Oscar Lim</h3> | ||
51 | |||
52 | <p>Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
53 | this software and associated documentation files (the "Software"), to deal in | ||
54 | the Software without restriction, including without limitation the rights to | ||
55 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
56 | of the Software, and to permit persons to whom the Software is furnished to do | ||
57 | so, subject to the following conditions:</p> | ||
58 | |||
59 | <p>The above copyright notice and this permission notice shall be included in all | ||
60 | copies or substantial portions of the Software.</p> | ||
61 | |||
62 | <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
63 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
64 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
65 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
66 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
67 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
68 | SOFTWARE.</p> | ||
69 | |||
70 | |||
71 | </div> <!-- id="content" --> | ||
72 | </div> <!-- id="main" --> | ||
73 | <div id="about"> | ||
74 | <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> | ||
75 | <i style="float:right;">Last updated 2023-11-15 07:42:18 </i> | ||
76 | </div> <!-- id="about" --> | ||
77 | </div> <!-- id="container" --> | ||
78 | </body> | ||
79 | </html> | ||