|
1 '\" t |
|
2 .\" |
|
3 .\" Modified for Solaris to to add the Solaris stability classification, |
|
4 .\" and to add a note about source availability. |
|
5 .\" |
|
6 .\" |
|
7 .\" |
|
8 .\" |
|
9 .\" generic swig man page for the swig Project |
|
10 .br |
|
11 .br |
|
12 .TH swig 1 "19 Jun 2008" "swig 1.3.35" "User commands" |
|
13 .SH NAME |
|
14 .P |
|
15 swig <options> filename |
|
16 .br |
|
17 .SH SYNOPSIS |
|
18 .P |
|
19 /usr/bin/swig -help [ For commandline help ] |
|
20 .br |
|
21 .SH DESCRIPTION |
|
22 .P |
|
23 \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. |
|
24 .br |
|
25 .P |
|
26 SWIG is used in a number of ways: |
|
27 .br |
|
28 .P |
|
29 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. |
|
30 .br |
|
31 .P |
|
32 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. |
|
33 .br |
|
34 .P |
|
35 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. |
|
36 .br |
|
37 .P |
|
38 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. |
|
39 .br |
|
40 .P |
|
41 .SH "SEE ALSO" |
|
42 .br |
|
43 Installed documentation: /usr/share/swig/1.3.35/doc |
|
44 .br |
|
45 .P |
|
46 Additional online documentation in HTML and PDF formats for swig: |
|
47 .br |
|
48 .P |
|
49 User Manual: http://www.swig.org/Doc1.1/HTML/Contents.html |
|
50 .br |
|
51 .P |
|
52 Developer Doc: http://www.swig.org/Doc1.3/index.html |
|
53 .br |
|
54 .P |
|
55 Quick start Tutorial: http://www.swig.org/tutorial.html |
|
56 .br |
|
57 .P |
|
58 SWIG WIKI: http://en.wikipedia.org/wiki/SWIG |
|
59 .br |
|
60 .P |
|
61 The Latest full source download: http://www.swig.org/download.html |
|
62 .br |
|
63 .P |
|
64 |
|
65 .SH AUTHOR |
|
66 .br |
|
67 \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. |
|
68 .LP |
|
69 |
|
70 .\" Begin Oracle update |
|
71 .SH ATTRIBUTES |
|
72 See |
|
73 .BR attributes (5) |
|
74 for descriptions of the following attributes: |
|
75 .sp |
|
76 .TS |
|
77 box; |
|
78 cbp-1 | cbp-1 |
|
79 l | l . |
|
80 ATTRIBUTE TYPE ATTRIBUTE VALUE |
|
81 = |
|
82 Availability developer/swig |
|
83 = |
|
84 Interface Stability Volatile |
|
85 .TE |
|
86 .PP |
|
87 .SH NOTES |
|
88 Source for swig is available on http://opensolaris.org. |
|
89 .\" End Oracle update |