Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, March 14, 2019
 
 

swig (1)

Name

swig - swig <options> filename

Synopsis

/usr/bin/swig -help   [ For commandline help ]

Description

swig(1)                          User commands                         swig(1)



NAME
       swig <options> filename

SYNOPSIS
       /usr/bin/swig -help   [ For commandline help ]

DESCRIPTION
       swig - The Simplified Wrapper and Interface Generator (swig) is an open
       source code interface compiler that connects programs written in C  and
       C++  with  scripting  languages such as Perl, Python, Ruby, and Tcl. It
       works by taking the declarations found in C/C++ header files and  using
       them  to  generate  the  wrapper  code that scripting languages need to
       access the underlying C/C++ code. In addition, SWIG provides a  variety
       of  customization  features that let you tailor the wrapping process to
       suit your application.

       SWIG is used in a number of ways:

       Building more powerful C/C++ programs. Using SWIG, you can replace  the
       main()  function of a C program with a scripting interpreter from which
       you can control the application. This adds quite a lot  of  flexibility
       and  makes the program "programmable." That is, the scripting interface
       allows users and developers to easily modifiy the behavior of the  pro-
       gram  without  having  to  modify low-level C/C++ code. The benefits of
       this are numerous. In fact think of all of the large software  packages
       that  you  use  every  day---nearly all of them include special a macro
       language, configuration language,  or  even  a  scripting  engine  that
       allows users to make customizations.

       Rapid  prototyping  and  debugging.  SWIG  allows  C/C++ programs to be
       placed in a scripting environment that can  be  used  for  testing  and
       debugging.  For  example, you might test a library with a collection of
       scripts or use the scripting interpreter as  an  interactive  debugger.
       Since  SWIG  requires no modifications to the underlying C/C++ code, it
       can be used even if the final product does not rely upon scripting.

       Systems integration. Scripting languages work fairly well for  control-
       ling  and  gluing  loosely-coupled  software  components together. With
       SWIG, different C/C++ programs can be turned  into  scripting  language
       extension  modules. These modules can then be combined together to cre-
       ate new and interesting applications.

       Construction of scripting language extension modules. SWIG can be  used
       to  turn  common  C/C++  libraries  into  components for use in popular
       scripting languages. Of course, you will still want to make  sure  that
       no-one else has already created a module before doing this.

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | developer/swig   |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       Installed documentation: /usr/share/swig/3.0.12/doc

       Additional online documentation in HTML and PDF formats for swig:

       User Manual: http://www.swig.org/Doc3.0/Contents.html

       Developer Doc: http://www.swig.org/Doc3.0/index.html

       Quick start Tutorial: http://www.swig.org/tutorial.html

       SWIG WIKI: http://en.wikipedia.org/wiki/SWIG

       The Latest full source download: http://www.swig.org/download.html

AUTHOR
       swig  was originally written by Dave Beazley, and is now maintained and
       developed      by      an      team      of       developers       see:
       http://www.swig.org/guilty.html.   Further  details  are  available  at
       http://www.swig.org/index.html.   swig  is  released  under  the   swig
       License.

NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source      was     downloaded     from      http://prdownloads.source-
       forge.net/swig/swig-3.0.12.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.swig.org/.



swig 3.0.12                       30 May 2017                          swig(1)