[47c4c7d] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY swig-download-http "&sourceforge-repo;/swig/swig-&swig-version;.tar.gz">
|
---|
| 8 | <!ENTITY swig-download-ftp " ">
|
---|
[926f9f4] | 9 | <!ENTITY swig-md5sum "62f9b0d010cef36a13a010dc530d0d41">
|
---|
| 10 | <!ENTITY swig-size "5.42 MB">
|
---|
| 11 | <!ENTITY swig-buildsize "77 MB (up to 1.1 GB for tests)">
|
---|
| 12 | <!ENTITY swig-time "0.4 SBU (24 SBU for tests of Guile, Go, Java, Lua, Perl, PHP, Python, Ruby, and tcl)">
|
---|
[47c4c7d] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <!-- Try to keep the indentation used in this file-->
|
---|
| 16 | <sect1 id="swig" xreflabel="SWIG-&swig-version;">
|
---|
| 17 | <?dbhtml filename="swig.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
| 23 |
|
---|
| 24 | <!-- No other tags inside any title.
|
---|
| 25 | Use Title Case in All Titles -->
|
---|
| 26 | <title>SWIG-&swig-version;</title>
|
---|
| 27 |
|
---|
| 28 | <indexterm zone="swig">
|
---|
| 29 | <primary sortas="a-swig">SWIG</primary>
|
---|
| 30 | </indexterm>
|
---|
| 31 |
|
---|
| 32 | <!--Required section-->
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to SWIG</title>
|
---|
| 35 |
|
---|
| 36 | <para>
|
---|
| 37 | <application>SWIG</application> (Simplified Wrapper and Interface
|
---|
| 38 | Generator) is a compiler that integrates <application>C</application>
|
---|
| 39 | and <application>C++</application> with languages including
|
---|
| 40 | <application>Perl</application>, <application>Python</application>,
|
---|
| 41 | <application>Tcl</application>, <application>Ruby</application>,
|
---|
| 42 | <application>PHP</application>, <application>Java</application>,
|
---|
| 43 | <application>C#</application>, <application>D</application>,
|
---|
| 44 | <application>Go</application>, <application>Lua</application>,
|
---|
| 45 | <application>Octave</application>, <application>R</application>,
|
---|
| 46 | <application>Scheme</application>, <application>Ocaml</application>,
|
---|
| 47 | <application>Modula-3</application>,
|
---|
| 48 | <application>Common Lisp</application>, and
|
---|
| 49 | <application>Pike</application>. <application>SWIG</application> can
|
---|
| 50 | also export its parse tree into <application>Lisp</application>
|
---|
| 51 | s-expressions and <application>XML</application>.
|
---|
| 52 | </para>
|
---|
| 53 | <para>
|
---|
| 54 | <application>SWIG</application> reads annotated
|
---|
| 55 | <application>C/C++</application> header files and creates wrapper
|
---|
| 56 | code (glue code) in order to make the corresponding
|
---|
| 57 | <application>C/C++</application> libraries available to the listed
|
---|
| 58 | languages, or to extend <application>C/C++</application> programs
|
---|
| 59 | with a scripting language.
|
---|
| 60 | </para>
|
---|
| 61 |
|
---|
[d08095a] | 62 | &lfs76_checked;
|
---|
[47c4c7d] | 63 |
|
---|
| 64 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 65 | <itemizedlist spacing="compact">
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Download (HTTP): <ulink url="&swig-download-http;"/>
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Download (FTP): <ulink url="&swig-download-ftp;"/>
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | <listitem>
|
---|
| 77 | <para>
|
---|
| 78 | Download MD5 sum: &swig-md5sum;
|
---|
| 79 | </para>
|
---|
| 80 | </listitem>
|
---|
| 81 | <listitem>
|
---|
| 82 | <para>
|
---|
| 83 | Download size: &swig-size;
|
---|
| 84 | </para>
|
---|
| 85 | </listitem>
|
---|
| 86 | <listitem>
|
---|
| 87 | <para>
|
---|
| 88 | Estimated disk space required: &swig-buildsize;
|
---|
| 89 | </para>
|
---|
| 90 | </listitem>
|
---|
| 91 | <listitem>
|
---|
| 92 | <para>
|
---|
| 93 | Estimated build time: &swig-time;
|
---|
| 94 | </para>
|
---|
| 95 | </listitem>
|
---|
| 96 | </itemizedlist>
|
---|
| 97 |
|
---|
| 98 | <bridgehead renderas="sect3">SWIG Dependencies</bridgehead>
|
---|
| 99 |
|
---|
| 100 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 101 | <para role="required">
|
---|
| 102 | <xref linkend="pcre"/>
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 106 | <para role="optional">
|
---|
| 107 | <xref linkend="boost"/> for tests, and any of the languages mentionned
|
---|
| 108 | in the introduction, as run-time dependencies
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <para condition="html" role="usernotes">
|
---|
| 112 | User Notes: <ulink url="&blfs-wiki;/swig"/>
|
---|
| 113 | </para>
|
---|
| 114 | </sect2>
|
---|
| 115 |
|
---|
| 116 | <sect2 role="installation">
|
---|
| 117 | <title>Installation of SWIG</title>
|
---|
| 118 |
|
---|
| 119 | <para>
|
---|
| 120 | Install <application>SWIG</application> by running the following
|
---|
| 121 | commands:
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <!-- Spaces are significant in <screen> sections -->
|
---|
| 125 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 126 | make</userinput></screen>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | To test the results, issue: <command>make -k check</command>. According to
|
---|
| 130 | <application>SWIG</application>'s documentation, the failure of some
|
---|
| 131 | tests should not be considered harmful.
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <para>
|
---|
| 135 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
| 138 | <screen role="root"><userinput>make install &&
|
---|
| 139 | install -v -m755 -d /usr/share/doc/swig-&swig-version; &&
|
---|
| 140 | cp -v -R Doc/* /usr/share/doc/swig-&swig-version;</userinput></screen>
|
---|
| 141 | </sect2>
|
---|
| 142 |
|
---|
| 143 | <!--Optional section-->
|
---|
| 144 | <sect2 role="commands">
|
---|
| 145 | <title>Command Explanations</title>
|
---|
| 146 |
|
---|
| 147 | <para>
|
---|
| 148 | <option>--without-<language></option>: allows disabling the
|
---|
| 149 | building of tests and examples for <language>, but all the
|
---|
| 150 | languages capabilities of <application>SWIG</application> are always
|
---|
| 151 | built.
|
---|
| 152 | </para>
|
---|
| 153 | </sect2>
|
---|
| 154 |
|
---|
| 155 | <sect2 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
| 159 | <segtitle>Installed Programs</segtitle>
|
---|
| 160 | <segtitle>Installed Library</segtitle>
|
---|
| 161 | <segtitle>Installed Directories</segtitle>
|
---|
| 162 |
|
---|
| 163 | <seglistitem>
|
---|
| 164 | <seg>
|
---|
| 165 | swig and ccache-swig
|
---|
| 166 | </seg>
|
---|
| 167 | <seg>
|
---|
| 168 | None
|
---|
| 169 | </seg>
|
---|
| 170 | <seg>
|
---|
| 171 | /usr/share/swig/&swig-version; and
|
---|
| 172 | /usr/share/doc/swig-&swig-version;
|
---|
| 173 | </seg>
|
---|
| 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
| 176 |
|
---|
| 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
| 181 |
|
---|
| 182 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 183 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 184 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="swig-prog">
|
---|
| 187 | <term><command>swig</command></term>
|
---|
| 188 | <listitem>
|
---|
| 189 | <para>
|
---|
| 190 | takes an interface file containing C/C++ declarations and
|
---|
| 191 | SWIG special instructions, and generates the corresponding
|
---|
| 192 | wrapper code needed to build extension modules.
|
---|
| 193 | </para>
|
---|
| 194 | <indexterm zone="swig swig-prog">
|
---|
| 195 | <primary sortas="b-swig">swig</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="ccache-swig">
|
---|
| 201 | <term><command>ccache-swig</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | is a compiler cache, which speeds up re-compilation of
|
---|
| 205 | C/C++/SWIG code.
|
---|
| 206 | </para>
|
---|
| 207 | <indexterm zone="swig ccache-swig">
|
---|
| 208 | <primary sortas="b-ccache-swig">ccache-swig</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | </variablelist>
|
---|
| 214 | </sect2>
|
---|
| 215 | </sect1>
|
---|