diff --git a/SWIG/Doc/Manual/SWIG.html b/SWIG/Doc/Manual/SWIG.html index ca6a9d907..f13a2e2e5 100644 --- a/SWIG/Doc/Manual/SWIG.html +++ b/SWIG/Doc/Manual/SWIG.html @@ -92,19 +92,26 @@ following options and a filename like this:

swig [ options ] filename
 
--tcl                  Generate Tcl wrappers
--perl                 Generate Perl5 wrappers
--python               Generate Python wrappers
+-chicken              Generate CHICKEN wrappers
+-csharp               Generate C# wrappers
 -guile                Generate Guile wrappers
--ruby                 Generate Ruby wrappers
 -java                 Generate Java wrappers
--mzscheme             Generate mzscheme wrappers
+-mzscheme             Generate Mzscheme wrappers
+-ocaml                Generate Ocaml wrappers
+-perl                 Generate Perl wrappers
 -php                  Generate PHP wrappers
+-pike                 Generate Pike wrappers
+-python               Generate Python wrappers
+-ruby                 Generate Ruby wrappers
+-sexp                 Generate Lisp S-Expressions wrappers
+-tcl                  Generate Tcl wrappers
+-xml                  Generate XML wrappers
 -c++                  Enable C++ parsing
 -Idir                 Add a directory to the file include path
 -lfile                Include a SWIG library file.
 -c                    Generate raw wrapper code (omit supporting code)
 -o outfile            Name of output file
+-outdir dir           Set language specific files output directory
 -module name          Set the name of the SWIG module
 -Dsymbol              Define a preprocessor symbol
 -version              Show SWIG version number
@@ -113,7 +120,8 @@ following options and a filename like this:
 
 
-Additional options are often defined for each target language. A full list +This is a subset of commandline options. +Additional options are also defined for each target language. A full list can be obtained by typing swig -help or swig -lang -help. @@ -164,11 +172,13 @@ parsed or interpreted by SWIG. The %{...%} syntax and semantics in SWIG is analogous to that of the declarations section used in input files to parser generation tools such as yacc or bison. +

4.1.2 SWIG Output

The output of SWIG is a C/C++ file that contains all of the wrapper -code needed to build an extension module. By default, an input file +code needed to build an extension module. SWIG may generate some +additional files depending on the target language. By default, an input file with the name file.i is transformed into a file file_wrap.c or file_wrap.cxx (depending on whether or not the -c++ option has been used). The name of the @@ -182,14 +192,31 @@ file if you want something different than the default. For example: $ swig -c++ -python -o example_wrap.cpp example.i

-The output file created by SWIG normally +The C/C++ output file created by SWIG often contains everything that is needed to construct a extension module -for the target scripting language. SWIG is not a stub compiler nor is +for the target scripting language. SWIG is not a stub compiler nor is it usually necessary to edit the output file (and if you look at the output, you probably won't want to). To build the final extension module, the SWIG output file is compiled and linked with the rest of your C/C++ program to create a shared library. +

+Many target languages will also generate proxy class files in the +target language. The default output directory for these language +specific files is the same directory as the generated C/C++ file. This can +can be modified using the -outdir option. For example: + +

+$ swig -c++ -python -outdir pyfiles -o cppfiles/example_wrap.cpp example.i
+
+ +If the directories cppfiles and pyfiles exist, the following +will be generated: +
+cppfiles/example_wrap.cpp
+pyfiles/example.py
+
+

4.1.3 Comments

@@ -2626,6 +2653,6 @@ The bottom line: don't do this.


-
SWIG 1.3 - Last Modified : May 25, 2002
+
SWIG 1.3 - Last Modified : August 7, 2003
- \ No newline at end of file +