diff options
authorAlex Parker <>2009-06-02 20:17:21 +0000
committerAlex Parker <>2009-06-02 20:17:21 +0000
commit9c1283c80dc23633ecdf84e1e6534137761594ae (patch)
parentd3d66f172a5768be362793ec83826a652eb52d6f (diff)
Add the Lua scripting language plugin to the manual.
git-svn-id: svn:// a1c6a512-1295-4272-9138-f99709370657
3 files changed, 32 insertions, 0 deletions
diff --git a/apps/features.txt b/apps/features.txt
index af4b18648e..a9df26ba48 100644
--- a/apps/features.txt
+++ b/apps/features.txt
@@ -195,3 +195,7 @@ wheel_acceleration
+#if (PLUGIN_BUFFER_SIZE >= 0x80000)
diff --git a/manual/plugins/lua.tex b/manual/plugins/lua.tex
new file mode 100644
index 0000000000..ac7ff22a85
--- /dev/null
+++ b/manual/plugins/lua.tex
@@ -0,0 +1,26 @@
+\subsection{Lua scripting language}
+To quote from the Lua website (\url{}), Lua is a ``powerful,
+fast, lightweight, embeddable scripting language''. Select a \fname{.lua} file
+in the \setting{File Browser} to run it. For more information on programming
+in Lua, please see \url{} and
+There are a few exceptions/additions to the Lua support in Rockbox:
+ \item[No floating point support.] The number type in Lua is usually float,
+ however in the Rockbox implementation it is integer.
+ \item[Non-supported libraries.] The coroutine, debug, file, io, math
+ and package libraries are not supported.
+ \item[Partially-supported libraries.] The os library is only partially
+ supported.
+ \item[Additional libraries.] The bitlib library is integrated to support
+ bitwise operators. See \url{} and
+ \url{}.
+Documentation of the API is still a work in progress, and the API itself is
+not finalised. For the latest information, see \wikilink{PluginLua}.\\
+\note{Please note that if a script does not provide a way to exit, then
+the only way to exit will be to reset the \dap.} \ No newline at end of file
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index d371009a7e..70f5cbd527 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -127,6 +127,8 @@ the associated file. Viewers are stored in the