aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Hanspeter Portner <dev@open-music-kontrollers.ch>2017-05-12 18:35:20 +0200
committerGravatar Hanspeter Portner <dev@open-music-kontrollers.ch>2017-05-12 18:35:20 +0200
commitba33f632468e32aa1389cfe283efdf6dbb49c698 (patch)
tree478ac48df7c6a06c8615d57e10c986cfea970adf
parent75a8be2d3fcea6f2249878fb1e61b3a98e2e2725 (diff)
downloadmoony.lv2-ba33f632468e32aa1389cfe283efdf6dbb49c698.zip
moony.lv2-ba33f632468e32aa1389cfe283efdf6dbb49c698.tar.gz
moony.lv2-ba33f632468e32aa1389cfe283efdf6dbb49c698.tar.bz2
moony.lv2-ba33f632468e32aa1389cfe283efdf6dbb49c698.tar.xz
manual: add lua-libraries.
-rw-r--r--VERSION2
-rw-r--r--manual/manual.html.in47
2 files changed, 48 insertions, 1 deletions
diff --git a/VERSION b/VERSION
index 7a794ed..4ab23c5 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.21.383
+0.21.385
diff --git a/manual/manual.html.in b/manual/manual.html.in
index b2d4a2e..09db5e8 100644
--- a/manual/manual.html.in
+++ b/manual/manual.html.in
@@ -123,6 +123,9 @@ pre {
</ul>
</li>
+ <li><a href="#lua-libraries">Lua libraries</a>
+ </li>
+
<li><a href="#log-and-debug">Log &amp; Debug</a>
</li>
@@ -464,6 +467,50 @@ end</code></pre>
</div>
<div class="api-section">
+ <h1 id="lua-libraries">Lua libraries</h1>
+ <p><i>Moony</i> runs its Lua interpreter in sandboxed mode, e.g. because of its
+ real-time requirements, <i>Moony</i> cannot provide any access to blocking functions
+ like file I/O and pipes. Only the following standard Lua libraries are enabled:</p>
+
+ <ul>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.1">base</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.2">coroutine</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.7">math</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.5">utf8</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.10">debug</a></li>
+ </ul>
+
+ <p>The following standard Lua libraries are disabled:</p>
+
+ <ul>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.8">io</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.3">package</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#6.9">os</a></li>
+ </ul>
+
+ <p>The following <a href="https://www.lua.org/manual/5.3/manual.html#6.1">base</a> functions are disabled:</p>
+
+ <ul>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#pdf-loadfile">loadfile</a></li>
+ <li><a href="https://www.lua.org/manual/5.3/manual.html#pdf-dofile">dofile</a></li>
+ </ul>
+
+ <p>Additionally to the standard libraries, <i>Moony</i> ships the
+ following commonly used utility libraries:</p>
+
+ <ul>
+ <li><a href="http://www.inf.puc-rio.br/~roberto/lpeg/">lpeg</a></li>
+ <li><a href="http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lbase64">base64</a></li>
+ <li><a href="http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lascii85">ascii85</a></li>
+ <li><a href="http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lmathx">mathx</a></li>
+ <li><a href="http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lcomplex">complex</a></li>
+ <li><a href="http://webserver2.tecgraf.puc-rio.br/~lhf/ftp/lua/#lrandom">random</a></li>
+ </ul>
+ </div>
+
+ <div class="api-section">
<h1 id="log-and-debug">Log &amp; Debug</h1>
<p>Whenever you want to log or debug something while developing your scripts, you can easily dump any value via Lua's <b>print</b> function. The print's output will be shown on the UI and also be sent to the host's log backend, e.g. to a log window or console.</p>