summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/01-introduction.md.html70
-rw-r--r--docs/topics/CHANGELOG.md.html121
-rw-r--r--docs/topics/LICENSE.md.html79
3 files changed, 270 insertions, 0 deletions
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 @@
+<!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>
+
+
+
+
+<h2>Topics</h2>
+<ul class="">
+ <li><strong>1. Introduction</strong></li>
+ <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
+ <li><a href="../topics/LICENSE.md.html">MIT License</a></li>
+</ul>
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../index.html">system</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+
+<h1>1. Introduction</h1>
+
+<p>luasystem is a platform independent system call library for Lua.
+Supports Unix, Windows, MacOS, <code>Lua &gt;= 5.1</code> and <code>luajit &gt;= 2.0.0</code>.</p>
+
+<p>Lua is typically platform independent, but it requires adhering to very old C
+standards. This in turn means that many common features (according to todays standards)
+are not available. This module attempts to overcome some of those hurdles by providing
+functions that cover those common needs.</p>
+
+<p>This is not a kitchen sink library, but a minimalistic one with a focus on platform
+independence.</p>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</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 @@
+<!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>
+
+
+<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><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="../index.html">system</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/time.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:<br/>
+ <code>luarocks upload ./rockspecs/luasystem-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></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 X.Y.Z, unreleased</h3>
+
+<ul>
+ <li>Feat: on Windows <a href="../index.html#sleep">sleep</a> now has a precision parameter</li>
+ <li>Feat: <a href="../index.html#setenv">setenv</a> added to set environment variables.</li>
+ <li>Feat: <a href="../index.html#getenvs">getenvs</a> added to list environment variables.</li>
+ <li>Feat: <a href="../index.html#getenv">getenv</a> added to get environment variable previously set (Windows).</li>
+ <li>Feat: <a href="../index.html#random">random</a> added to return high-quality random bytes</li>
+ <li>Feat: <a href="../index.html#isatty">isatty</a> 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/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</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 @@
+<!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>
+
+
+
+
+<h2>Topics</h2>
+<ul class="">
+ <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
+ <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
+ <li><strong>MIT License</strong></li>
+</ul>
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../index.html">system</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+
+<h1>MIT License</h1>
+
+<h3>Copyright (c) 2016-2023 Oscar Lim</h3>
+
+<p>Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:</p>
+
+<p>The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.</p>
+
+<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.</p>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
generated by cgit v1.2.3 (git 2.25.1) at 2025-01-03 12:02:28 +0000