SWIG: README | Fossies

"Fossies" - the Fresh Open Source Software Archive

Member "swig-4.1.1/README" (30 Nov 2022, 5292 Bytes) of package /linux/misc/swig-4.1.1.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README":

4.1.0_vs_4.1.1.

1 SWIG (Simplified Wrapper and Interface Generator) 2 3 Tagline: SWIG is a compiler that integrates C and C++ with languages 4 including Perl, Python, Tcl, Ruby, PHP, Java, C#, D, Go, Lua, 5 Octave, R, Scheme (Guile, MzScheme/Racket), Scilab, Ocaml. 6 SWIG can also export its parse tree into XML. 7 8 SWIG reads annotated C/C++ header files and creates wrapper code (glue 9 code) in order to make the corresponding C/C++ libraries available to 10 the listed languages, or to extend C/C++ programs with a scripting 11 language. 12 13 Up-to-date SWIG related information can be found at 14 15 https://www.swig.org 16 17 A SWIG FAQ and other hints can be found on the SWIG Wiki: 18 19 https://github.com/swig/swig/wiki 20 21 License 22 ======= 23 Please see the LICENSE file for details of the SWIG license. For 24 further insight into the license including the license of SWIG's 25 output code, please visit 26 27 https://www.swig.org/legal.html 28 29 Release Notes 30 ============= 31 Please see the CHANGES.current file for a detailed list of bug fixes and 32 new features for the current release. The CHANGES file contains bug fixes 33 and new features for older versions. A summary of changes in each release 34 can be found in the RELEASENOTES file. 35 36 Documentation 37 ============= 38 The Doc/Manual directory contains the most recent set of updated 39 documentation for this release. The documentation is available in 40 three different formats, each of which contains identical content. 41 These format are, pdf (Doc/Manual/SWIGDocumentation.pdf), single 42 page html (Doc/Manual/SWIGDocumentation.html) or multiple page html 43 (other files in Doc/Manual). Please select your chosen format and 44 copy/install to wherever takes your fancy. 45 46 There is some technical developer documentation available in the 47 Doc/Devel subdirectory. This is not necessarily up-to-date, but it 48 has some information on SWIG internals. 49 50 Documentation is also online at https://www.swig.org/doc.html. 51 52 Backwards Compatibility 53 ======================= 54 The developers strive their best to preserve backwards compatibility 55 between releases, but this is not always possible as the overriding 56 aim is to provide the best wrapping experience. Where backwards 57 compatibility is known to be broken, it is clearly marked as an 58 incompatibility in the CHANGES and CHANGES.current files. 59 60 See the documentation for details of the SWIG_VERSION preprocessor 61 symbol if you have backward compatibility issues and need to use more 62 than one version of SWIG. 63 64 Installation 65 ============ 66 Please read the Doc/Manual/Preface.html#Preface_installation for 67 full installation instructions for Windows, Unix and Mac OS X 68 using the release tarball/zip file. The INSTALL file has generic 69 build and installation instructions for Unix users. 70 Users wishing to build and install code from Github should 71 visit https://swig.org/svn.html to obtain the more detailed 72 instructions required for building code obtained from Github - extra 73 steps are required compared to building from the release tarball. 74 75 Testing 76 ======= 77 The typical 'make -k check' can be performed on Unix operating systems. 78 Please read Doc/Manual/Preface.html#Preface_testing for details. 79 80 Examples 81 ======== 82 The Examples directory contains a variety of examples of using SWIG 83 and it has some browsable documentation. Simply point your browser to 84 the file "Example/index.html". 85 86 The Examples directory also includes Visual C++ project 6 (.dsp) files for 87 building some of the examples on Windows. Later versions of Visual Studio 88 will convert these old style project files into a current solution file. 89 90 Known Issues 91 ============ 92 There are minor known bugs, details of which are in the bug tracker, see 93 https://www.swig.org/bugs.html. 94 95 Troubleshooting 96 =============== 97 In order to operate correctly, SWIG relies upon a set of library 98 files. If after building SWIG, you get error messages like this, 99 100 $ swig foo.i 101 :1. Unable to find 'swig.swg' 102 :3. Unable to find 'tcl8.swg' 103 104 it means that SWIG has either been incorrectly configured or 105 installed. To fix this: 106 107 1. Make sure you remembered to do a 'make install' and that 108 the installation actually worked. Make sure you have 109 write permission on the install directory. 110 111 2. If that doesn't work, type 'swig -swiglib' to find out 112 where SWIG thinks its library is located. 113 114 3. If the location is not where you expect, perhaps 115 you supplied a bad option to configure. Use 116 ./configure --prefix=pathname to set the SWIG install 117 location. Also, make sure you don't include a shell 118 escape character such as ~ when you specify the path. 119 120 4. The SWIG library can be changed by setting the SWIG_LIB 121 environment variable. However, you really shouldn't 122 have to do this. 123 124 If you are having other troubles, you might look at the SWIG Wiki at 125 https://github.com/swig/swig/wiki. 126 127 Participate! 128 ============ 129 Please report any errors and submit patches (if possible)! We only 130 have access to a limited variety of hardware (Linux, Solaris, OS-X, 131 and Windows). All contributions help. 132 133 If you would like to join the SWIG development team or contribute a 134 language module to the distribution, please contact the swig-devel 135 mailing list, details at https://www.swig.org/mail.html. 136 137 138 -- The SWIG Maintainers 139