man-pages/man1/swig4.0.1.html
2021-03-31 01:06:50 +01:00

280 lines
5.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SWIG</TITLE>
</HEAD><BODY>
<H1>SWIG</H1>
Section: User Commands (1)<BR>Updated: 2004-05-22<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<P>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
swig - Simplified Wrapper and Interface Generator
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>swig</B>
[<I>options</I>]<I> file</I>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
The swig command is used to create wrapper code to connect C and
C++ code to scripting languages like Perl, Python, etc. from the
definition of the interface. For detailed information on writing
those interface definitions please refer to
/usr/share/doc/swig-doc/Manual/index.html from the swig-doc package.
This manpage concentrates on explaining the invocation of the swig
command.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<A NAME="lbAF">&nbsp;</A>
<H3>Target Language Options:</H3>
<DL COMPACT>
<DT id="1"><B>-chicken</B>
<DD>
Generate CHICKEN wrappers
<DT id="2"><B>-csharp</B>
<DD>
Generate C# wrappers
<DT id="3"><B>-guile</B>
<DD>
Generate Guile wrappers
<DT id="4"><B>-java</B>
<DD>
Generate Java wrappers
<DT id="5"><B>-mzscheme</B>
<DD>
Generate Mzscheme wrappers
<DT id="6"><B>-ocaml</B>
<DD>
Generate Ocaml wrappers
<DT id="7"><B>-perl</B>
<DD>
Generate Perl wrappers.
<DT id="8"><B>-php</B>
<DD>
Generate PHP wrappers
<DT id="9"><B>-pike</B>
<DD>
Generate Pike wrappers
<DT id="10"><B>-python</B>
<DD>
Generate Python wrappers
<DT id="11"><B>-ruby</B>
<DD>
Generate Ruby wrappers
<DT id="12"><B>-sexp</B>
<DD>
Generate Lisp S-Expressions wrappers
<DT id="13"><B>-tcl</B>
<DD>
Generate Tcl wrappers
<DT id="14"><B>-xml</B>
<DD>
Generate XML wrappers.
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H3>General Options</H3>
<P>
<DL COMPACT>
<DT id="15"><B>-c++</B>
<DD>
Enable C++ processing
<DT id="16"><B>-co</B>
<DD>
Check a file out of the SWIG library
<DT id="17"><B>-dirprot</B>
<DD>
Turn on wrapping of protected members for director classes
<DT id="18"><B>-D</B><I>symbol</I>
<DD>
Define a symbol <I>symbol</I> (for conditional compilation)
<DT id="19"><B>-E</B>
<DD>
Preprocess only, does not generate wrapper code
<DT id="20"><B>-fcompact</B>
<DD>
Compile in compact mode
<DT id="21"><B>-fvirtual</B>
<DD>
Compile in virtual elimination mode
<DT id="22"><B>-Fstandard</B>
<DD>
Display error/warning messages in commonly used format
<DT id="23"><B>-Fmicrosoft</B>
<DD>
Display error/warning messages in Microsoft format
<DT id="24"><B>-help</B>
<DD>
Show a summary of supported options and especially of supported
options for the selected language.
<DT id="25"><B>-I</B><I>dir</I>
<DD>
Look for SWIG files in <I>dir</I>
<DT id="26"><B>-ignoremissing</B>
<DD>
Ignore missing include files
<DT id="27"><B>-importall</B>
<DD>
Follow all #include statements as imports
<DT id="28"><B>-includeall</B>
<DD>
Follow all #include statements
<DT id="29"><B>-l</B><I>ifile</I>
<DD>
Include SWIG library file <I>ifile</I>
<DT id="30"><B>-M</B>
<DD>
List all dependencies
<DT id="31"><B>-MM</B>
<DD>
List dependencies, but omit files in SWIG library
<DT id="32"><B>-makedefault</B>
<DD>
Create default constructors/destructors (the default)
<DT id="33"><B>-module </B><I>name</I>
<DD>
Set module name to <I>name</I>
<DT id="34"><B>-nocontract</B>
<DD>
Turn off contract checking
<DT id="35"><B>-nodefault</B>
<DD>
Do not generate constructors/destructors
<DT id="36"><B>-nodirprot</B>
<DD>
Do not wrap director protected members
<DT id="37"><B>-noexcept</B>
<DD>
Do not wrap exception specifiers
<DT id="38"><B>-noextern</B>
<DD>
Do not generate extern declarations
<DT id="39"><B>-noruntime</B>
<DD>
Do not include SWIG runtime code
<DT id="40"><B>-o </B><I>outfile</I>
<DD>
Set name of the output file to <I>outfile</I>
<DT id="41"><B>-outdir </B><I>dir</I>
<DD>
Set language specific files output directory
<DT id="42"><B>-runtime</B>
<DD>
Make the runtime support code globally visible.
<DT id="43"><B>-small</B>
<DD>
Compile in virtual elimination &amp; compact mode
<DT id="44"><B>-swiglib</B>
<DD>
Report location of SWIG library and exit
<DT id="45"><B>-v</B>
<DD>
Run in verbose mode
<DT id="46"><B>-version</B>
<DD>
Print SWIG version number
<DT id="47"><B>-Wall</B>
<DD>
Enable all warning messages
<DT id="48"><B>-Wallkw</B>
<DD>
Enable warning messages for all the languages keywords
<DT id="49"><B>-Werror</B>
<DD>
Force to treat the warnings as errors
<DT id="50"><B>-w </B><I>n</I>
<DD>
Suppress warning number <I>n</I>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
SWIG was originally created by David Beazley. For up-to-date information
about authors and contributors please check <A HREF="http://www.swig.org/guilty.html.">http://www.swig.org/guilty.html.</A>
This manual page was written by Torsten Landschoff &lt;<A HREF="mailto:torsten@debian.org">torsten@debian.org</A>&gt;
for the Debian project (but may be used by others).
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="51"><A HREF="#lbAB">NAME</A><DD>
<DT id="52"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="53"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="54"><A HREF="#lbAE">OPTIONS</A><DD>
<DL>
<DT id="55"><A HREF="#lbAF">Target Language Options:</A><DD>
<DT id="56"><A HREF="#lbAG">General Options</A><DD>
</DL>
<DT id="57"><A HREF="#lbAH">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:28 GMT, March 31, 2021
</BODY>
</HTML>