components/developer/swig/files/swig.1

   1 .\"
   2 .\" generic swig man page for the swig Project
   3 .br
   4 .br
   5 .TH swig 1 "07 Jun 2016" "swig 3.0.10" "User commands"
   6 .SH NAME
   7 .P
   8 swig <options> filename
   9 .br
  10 .SH SYNOPSIS
  11 .P
  12 /usr/bin/swig -help   [ For commandline help ]
  13 .br
  14 .SH DESCRIPTION
  15 .P
  16 \fBswig\fR - 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.
  17 .br
  18 .P
  19 SWIG is used in a number of ways:
  20 .br
  21 .P
  22 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 program 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.
  23 .br
  24 .P
  25 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.
  26 .br
  27 .P
  28 Systems integration. Scripting languages work fairly well for controlling 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 create new and interesting applications.
  29 .br
  30 .P
  31 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.
  32 .br
  33 .P
  34 .SH "SEE ALSO"
  35 .br
  36 Installed documentation: /usr/share/swig/3.0.10/doc
  37 .br
  38 .P
  39 Additional online documentation in HTML and PDF formats for swig:
  40 .br
  41 .P
  42 User Manual: http://www.swig.org/Doc3.0/Contents.html
  43 .br
  44 .P
  45 Developer Doc: http://www.swig.org/Doc3.0/index.html
  46 .br
  47 .P
  48 Quick start Tutorial: http://www.swig.org/tutorial.html
  49 .br
  50 .P
  51 SWIG WIKI: http://en.wikipedia.org/wiki/SWIG
  52 .br
  53 .P
  54 The Latest full source download: http://www.swig.org/download.html
  55 .br
  56 .P
  57
  58 .SH AUTHOR
  59 .br
  60 \fBswig\fR 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 \fIhttp://www.swig.org/index.html\fR.  swig is released under the \fIswig License\fR.
  61 .LP
  62