summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2009-06-02 20:17:21 +0000
committerAlex Parker <rockbox@aeparker.com>2009-06-02 20:17:21 +0000
commit9c1283c80dc23633ecdf84e1e6534137761594ae (patch)
treedf4a0e074c6a60152a497b0984a5f20eab27b23b /manual
parentd3d66f172a5768be362793ec83826a652eb52d6f (diff)
downloadrockbox-9c1283c80dc23633ecdf84e1e6534137761594ae.tar.gz
rockbox-9c1283c80dc23633ecdf84e1e6534137761594ae.tar.bz2
rockbox-9c1283c80dc23633ecdf84e1e6534137761594ae.zip
Add the Lua scripting language plugin to the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21168 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/lua.tex26
-rw-r--r--manual/plugins/main.tex2
2 files changed, 28 insertions, 0 deletions
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{http://www.lua.org}), 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{http://www.lua.org/manual/5.1/} and
+\url{http://www.lua.org/pil/}.
+
+There are a few exceptions/additions to the Lua support in Rockbox:
+\begin{description}
+ \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{http://luaforge.net/projects/bitlib} and
+ \url{http://lua-users.org/wiki/BitwiseOperators}.
+\end{description}
+
+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
\opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
+\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
+
\opt{swcodec}{\input{plugins/midiplay.tex}}
\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}