summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorWilliam S Fulton <wsf@fultondesigns.co.uk>2011-08-22 19:27:56 +0000
committerWilliam S Fulton <wsf@fultondesigns.co.uk>2011-08-22 19:27:56 +0000
commit932f47a84540ddb103239f3e10c662988b396232 (patch)
tree21b3834293460076c6f2874b263df246bdbd192c /Doc
parent61124e61a75f08dad76c2283b0aa2fe68e790302 (diff)
downloadswig-932f47a84540ddb103239f3e10c662988b396232.tar.gz
SF patch #3394339 from Torsten Landschoff - new option -nomoduleglobal to disable installing the module table into the global namespace. Require call also returns the module table instead of a string
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12780 626c5289-ae23-0410-ae9c-e8d60b6d4f22
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Manual/Lua.html23
1 files changed, 23 insertions, 0 deletions
diff --git a/Doc/Manual/Lua.html b/Doc/Manual/Lua.html
index 04f96f2f3..218a9a498 100644
--- a/Doc/Manual/Lua.html
+++ b/Doc/Manual/Lua.html
@@ -105,6 +105,29 @@ This creates a C/C++ source file <tt>example_wrap.c</tt> or <tt>example_wrap.cxx
<p>
The name of the wrapper file is derived from the name of the input file. For example, if the input file is <tt>example.i</tt>, the name of the wrapper file is <tt>example_wrap.c</tt>. To change this, you can use the -o option. The wrappered module will export one function <tt>"int luaopen_example(lua_State* L)"</tt> which must be called to register the module with the Lua interpreter. The name "luaopen_example" depends upon the name of the module.
</p>
+
+<H3><a name="Lua_commandline"></a>25.2.1 Additional command line options</H3>
+
+<p>
+The following table list the additional commandline options available for the Lua module. They can also be seen by using:
+</p>
+
+<div class="code"><pre>
+swig -lua -help
+</pre></div>
+
+<table summary="Lua specific options">
+<tr>
+<th>Lua specific options</th>
+</tr>
+
+<tr>
+<td>-nomoduleglobal</td>
+<td>Do not register the module name as a global variable but return the module table from calls to require.</td>
+</tr>
+
+</table>
+
<H3><a name="Lua_nn4"></a>25.2.1 Compiling and Linking and Interpreter</H3>