1SWIG(1) User Commands SWIG(1)
2
6 swig - Simplified Wrapper and Interface Generator
7
9 swig [ options ] " file"
10
12 The swig command is used to create wrapper code to connect C and C++
13 code to scripting languages like Perl, Python, Tcl etc. from the defi‐
14 nition of the interface. For detailed information on writing those
15 interface definitions please refer to /usr/share/doc/swig-doc/Doc/Man‐
16 ual/index.html from the swig-doc package.
17 This manpage concentrates on explaining the invocation of the swig com‐
19 mand.
20
22 Target Language Options
23 -allegrocl
25 Generate ALLEGROCL wrappers
26 -chicken
28 Generate CHICKEN wrappers
29 -clisp Generate CLISP wrappers
31 -cffi Generate CFFI wrappers
33 -csharp
35 Generate C# wrappers
36 -d Generate D wrappers
38 -go Generate Go wrappers
40 -guile Generate Guile wrappers
42 -java Generate Java wrappers
44 -javascript
46 Generate Javascript wrappers
47 -lua Generate Lua wrappers
49 -modula3
51 Generate Modula 3 wrappers
52 -mzscheme
54 Generate Mzscheme wrappers
55 -ocaml Generate Ocaml wrappers
57 -octave
59 Generate Octave wrappers
60 -perl Generate Perl wrappers
62 -php5 Generate PHP5 wrappers
64 -php7 Generate PHP7 wrappers
66 -pike Generate Pike wrappers
68 -python
70 Generate Python wrappers
71 -r Generate R (aka GNU S) wrappers
73 -ruby Generate Ruby wrappers
75 -scilab
77 Generate Scilab wrappers
78 -sexp Generate Lisp S-Expressions wrappers
80 -tcl Generate Tcl wrappers
82 -uffi Generate Common Lisp / UFFI wrappers
84 -xml Generate XML wrappers
86 General Options
88 -addextern
90 Add extra extern declarations
91 -c++ Enable C++ processing
93 -co <file>
95 Check <file> out of the SWIG library
96 -copyctor
98 Automatically generate copy constructors wherever possible
99 -cpperraswarn
101 Treat the preprocessor #error statement as #warning (default)
102 -cppext <ext>
104 Change file extension of generated C++ files to <ext> (default
105 is cxx, except for PHP5 which uses cpp)
106 -copyright
108 Display copyright notices
109 -debug-classes
111 Display information about the classes found in the interface
112 -debug-module <n> Display module parse tree at stages 1-4, <n> is a csv
114 list of stages
115 -debug-symtabs
117 Display symbol tables information
118 -debug-symbols
120 Display target language symbols in the symbol tables
121 -debug-csymbols
123 Display C symbols in the symbol tables
124 -debug-lsymbols
126 Display target language layer symbols
127 -debug-tags
129 Display information about the tags found in the interface
130 -debug-template
132 Display information for debugging templates
133 -debug-top <n>
135 Display entire parse tree at stages 1-4, <n> is a csv list of
136 stages
137 -debug-typedef
139 Display information about the types and typedefs in the inter‐
140 face
141 -debug-typemap
143 Display typemap debugging information
144 -debug-tmsearch
146 Display typemap search debugging information
147 -debug-tmused
149 Display typemaps used debugging information
150 -directors
152 Turn on director mode for all the classes, mainly for testing
153 -dirprot
155 Turn on wrapping of protected members for director classes
156 (default)
157 -D<symbol>
159 Define a symbol <symbol> (for conditional compilation)
160 -E Preprocess only, does not generate wrapper code
162 -external-runtime [file]
164 Export the SWIG runtime stack
165 -fakeversion <v> Make SWIG fake the program version number to <v>
167 -fcompact
169 Compile in compact mode
170 -features <list> Set global features, where <list> is a comma separated
172 list of
173 features, eg -features directors,autodoc=1 If no explicit value
174 is given to the feature, a default of 1 is used
175 -fastdispatch
177 Enable fast dispatch mode to produce faster overload dispatcher
178 code
179 -Fmicrosoft
181 Display error/warning messages in Microsoft format
182 -Fstandard
184 Display error/warning messages in commonly used format
185 -fvirtual
187 Compile in virtual elimination mode
188 -help This output
190 -I - Don't search the current directory
192 -I<dir>
194 Look for SWIG files in directory <dir>
195 -ignoremissing
197 Ignore missing include files
198 -importall
200 Follow all #include statements as imports
201 -includeall
203 Follow all #include statements
204 -l<ifile>
206 Include SWIG library file <ifile>
207 -macroerrors
209 Report errors inside macros
210 -makedefault
212 Create default constructors/destructors (the default)
213 -M List all dependencies
215 -MD Is equivalent to `-M -MF <file>', except `-E' is not implied
217 -MF <file>
219 Generate dependencies into <file> and continue generating wrap‐
220 pers
221 -MM List dependencies, but omit files in SWIG library
223 -MMD Like `-MD', but omit files in SWIG library
225 -module <name>
227 Set module name to <name>
228 -MP Generate phony targets for all dependencies
230 -MT <target>
232 Set the target of the rule emitted by dependency generation
233 -nocontract
235 Turn off contract checking
236 -nocpperraswarn
238 Do not treat the preprocessor #error statement as #warning
239 -nodefault
241 Do not generate default constructors nor default destructors
242 -nodefaultctor
244 Do not generate implicit default constructors
245 -nodefaultdtor
247 Do not generate implicit default destructors
248 -nodirprot
250 Do not wrap director protected members
251 -noexcept
253 Do not wrap exception specifiers
254 -nofastdispatch
256 Disable fast dispatch mode (default)
257 -nopreprocess
259 Skip the preprocessor step
260 -notemplatereduce
262 Disable reduction of the typedefs in templates
263 -O Enable the optimization options: -fastdispatch -fvirtual
265 -o <outfile>
267 Set name of C/C++ output file to <outfile>
268 -oh <headfile>
270 Set name of C++ output header file for directors to <headfile>
271 -outcurrentdir
273 Set default output dir to current dir instead of input file's
274 path
275 -outdir <dir>
277 Set language specific files output directory to <dir>
278 -pcreversion
280 Display PCRE version information
281 -small Compile in virtual elimination & compact mode
283 -swiglib
285 Report location of SWIG library and exit
286 -templatereduce
288 Reduce all the typedefs in templates
289 -v Run in verbose mode
291 -version
293 Display SWIG version number
294 -Wall Remove all warning suppression, also implies -Wextra
296 -Wallkw
298 Enable keyword warnings for all the supported languages
299 -Werror
301 Treat warnings as errors
302 -Wextra
304 Adds the following additional warnings: 202,309,403,512,321,322
305 -w<list>
307 Suppress/add warning messages, eg -w401,+321 - see Warnings.html
308 -xmlout <file>
310 Write XML version of the parse tree to <file> after normal pro‐
311 cessing
312 Options can also be defined using the SWIG_FEATURES environment vari‐
314 able, for example:
315 $ SWIG_FEATURES="-Wall"
317 $ export SWIG_FEATURES
318 $ swig -python interface.i
319 is equivalent to:
321 $ swig -Wall -python interface.i
323 Tcl 8 Options (available with -tcl)
325 -itcl Enable ITcl support
327 -nosafe
329 Leave out SafeInit module function.
330 -prefix <name>
332 Set a prefix <name> to be prepended to all names
333 -namespace
335 Build module into a Tcl 8 namespace
336 -pkgversion
338 Set package version
339 Note: 'swig -<lang> -help' displays options for a specific target lan‐
341 guage.
342
344 SWIG was originally created by David Beazley. For up-to-date informa‐
345 tion about authors and contributors please check
346 http://www.swig.org/guilty.html. This manual page was written by
347 Torsten Landschoff <torsten@debian.org> and updated by Jitka Plesnikova
348 <jplesnik@redhat.com> (but may be used by others).
349swig July 2018 SWIG(1)