Typo in README.txt file about Lua interface
[vlc.git] / share / lua / intf / README.txt
1 Instructions to code your own VLC Lua interface script.
2 $Id$
3
4 See lua/README.txt for generic documentation about Lua usage in VLC.
5
6 Examples: rc.lua, telnet.lua and http.lua
7
8 The "config" global variable is set to the value specified in the
9 --lua-config VLC option. For example:
10 --lua-config "rc={a='test',c=3},telnet={a='hello'}"
11 config will be set to {a='test',c=3} in the rc interface, to {a='hello'}
12 in the telnet interface and won't be set in other interfaces. 
13
14 User defined modules stored in the share/lua/intf/modules/ directory are
15 available. For example, to use the sandbox module, just use
16 'require "sandbox"' in your interface.
17
18 VLC defines a global vlc object with the following members:
19 All the VLC specific Lua modules are available.