diff options
author | Alex Parker <rockbox@aeparker.com> | 2009-06-02 20:17:21 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2009-06-02 20:17:21 +0000 |
commit | 9c1283c80dc23633ecdf84e1e6534137761594ae (patch) | |
tree | df4a0e074c6a60152a497b0984a5f20eab27b23b | |
parent | d3d66f172a5768be362793ec83826a652eb52d6f (diff) | |
download | rockbox-9c1283c80dc23633ecdf84e1e6534137761594ae.tar.gz 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
-rw-r--r-- | apps/features.txt | 4 | ||||
-rw-r--r-- | manual/plugins/lua.tex | 26 | ||||
-rw-r--r-- | manual/plugins/main.tex | 2 |
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 | |||
195 | #if defined(HAVE_TOUCHSCREEN) | 195 | #if defined(HAVE_TOUCHSCREEN) |
196 | touchscreen | 196 | touchscreen |
197 | #endif | 197 | #endif |
198 | |||
199 | #if (PLUGIN_BUFFER_SIZE >= 0x80000) | ||
200 | large_plugin_buffer | ||
201 | #endif | ||
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 @@ | |||
1 | \subsection{Lua scripting language} | ||
2 | |||
3 | To quote from the Lua website (\url{http://www.lua.org}), Lua is a ``powerful, | ||
4 | fast, lightweight, embeddable scripting language''. Select a \fname{.lua} file | ||
5 | in the \setting{File Browser} to run it. For more information on programming | ||
6 | in Lua, please see \url{http://www.lua.org/manual/5.1/} and | ||
7 | \url{http://www.lua.org/pil/}. | ||
8 | |||
9 | There are a few exceptions/additions to the Lua support in Rockbox: | ||
10 | \begin{description} | ||
11 | \item[No floating point support.] The number type in Lua is usually float, | ||
12 | however in the Rockbox implementation it is integer. | ||
13 | \item[Non-supported libraries.] The coroutine, debug, file, io, math | ||
14 | and package libraries are not supported. | ||
15 | \item[Partially-supported libraries.] The os library is only partially | ||
16 | supported. | ||
17 | \item[Additional libraries.] The bitlib library is integrated to support | ||
18 | bitwise operators. See \url{http://luaforge.net/projects/bitlib} and | ||
19 | \url{http://lua-users.org/wiki/BitwiseOperators}. | ||
20 | \end{description} | ||
21 | |||
22 | Documentation of the API is still a work in progress, and the API itself is | ||
23 | not finalised. For the latest information, see \wikilink{PluginLua}.\\ | ||
24 | |||
25 | \note{Please note that if a script does not provide a way to exit, then | ||
26 | 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 | |||
127 | 127 | ||
128 | \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}} | 128 | \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}} |
129 | 129 | ||
130 | \opt{large_plugin_buffer}{\input{plugins/lua.tex}} | ||
131 | |||
130 | \opt{swcodec}{\input{plugins/midiplay.tex}} | 132 | \opt{swcodec}{\input{plugins/midiplay.tex}} |
131 | 133 | ||
132 | \opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}} | 134 | \opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}} |