1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
<refentry id="seed-building" revision="04 Jul 2009">
<refmeta>
<refentrytitle>Compiling Seed</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SEED Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Compiling Seed</refname>
<refpurpose>
How to compile Seed itself
</refpurpose>
</refnamediv>
<refsect1 id="building">
<title>Building the Library on UNIX</title>
<para>
On UNIX, Seed uses the standard GNU build system,
using <application>autoconf</application> for package
configuration and resolving portability issues,
<application>automake</application> for building makefiles
that comply with the GNU Coding Standards, and
<application>libtool</application> for building shared
libraries on multiple platforms. The normal sequence for
compiling and installing Seed is thus:
<literallayout>
<userinput>./configure</userinput>
<userinput>make</userinput>
<userinput>make install</userinput>
</literallayout>
</para>
<para>
The standard options provided by <application>GNU
autoconf</application> may be passed to the
<command>configure</command> script. Please see the
<application>autoconf</application> documentation or run
<command>./configure --help</command> for information about
the standard options.
</para>
</refsect1>
<refsect1 id="dependencies">
<title>Dependencies</title>
<para>
Before you can compile Seed, you need to have
various external libraries installed on your system.
</para>
<itemizedlist>
<listitem>
<para>
The <ulink url="http://live.gnome.org/GObjectIntrospection">gobject-introspection library</ulink> is necessary to build Seed. It provides the bridge between Seed and many GObject-based libraries.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://webkit.org">WebKit</ulink> provides the JavaScriptCore interpreter, which is fundamental to Seed's ability to execute JavaScript. Seed requires a WebKit SVN revision newer than 35442. Keep in mind that some builds between this and HEAD still won't work with Seed, and performance has only improved, so try to keep an up-to-date version of WebKit if you're planning on working with Seed.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://tiswww.case.edu/php/chet/readline/rltop.html">readline</ulink> is used by the Seed REPL in order to communicate with the user.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://sourceware.org/libffi/">libffi</ulink> provides Seed with an interface to call into C libraries at runtime.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://ftp.gnome.org/pub/GNOME/sources/gnome-js-common/">gnome-js-common</ulink> includes a battery of tests against both Seed and GJS, and also provides numerous libraries of JavaScript functions, including JSON manipulation and various language extensions.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 id="moddependencies">
<title>Module Dependencies</title>
<para>
Seed ships with a number of native modules which provide access to libraries which help with development but are not able to be introspected. Some of these modules depend on external libraries, and Seed's configuration will fail if they are not installed; if you wish to build Seed without a module for which you do not have the underlying library installed, check the Extra Configuration Options section of this document.
</para>
<itemizedlist>
<listitem>
<para>
<ulink url="http://cairographics.org/">Cairo</ulink> provides access to fast 2D graphics and numerous different types of output, including drawing to the screen, to an image, to a PDF, etc.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.freedesktop.org/wiki/Software/dbus">DBus</ulink> enables Seed to manipulate the various message busses, and provides communication between applications.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.gnu.org/software/gettext/">gettext</ulink> is a common library used for internationalization support.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://xmlsoft.org/">libxml2</ulink> provides a powerful XML parsing interface.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.mpfr.org/">mpfr</ulink> provides multiple-precision arithmetic.
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.sqlite.org/">sqlite3</ulink> provides straightforward read-write access to on-disk SQL databases.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 id="optdependencies">
<title>Optional Dependencies</title>
<para>
Seed's library of examples utilizes many other GObject projects which Seed does not strictly depend on, and will not be enumerated here. Introspection data for these projects may either be found within the projects themselves, or in the <ulink url="http://live.gnome.org/GObjectIntrospection">gir-repository</ulink>.
</para>
</refsect1>
<refsect1 id="extra-configuration-options">
<title>Extra Configuration Options</title>
<para>
In addition to the normal options, the
<command>configure</command> script in the Seed
library supports these additional arguments:
</para>
<formalpara>
<title><systemitem>--disable-canvas-module</systemitem> and
<systemitem>--enable-canvas-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-canvas-module</systemitem>
as well, Seed attempts to build the Canvas native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-readline-module</systemitem> and
<systemitem>--enable-readline-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-readline-module</systemitem>
as well, Seed attempts to build the readline native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-multiprocessing-module</systemitem> and
<systemitem>--enable-multiprocessing-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-multiprocessing-module</systemitem>
as well, Seed attempts to build the multiprocessing native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-sqlite-module</systemitem> and
<systemitem>--enable-sqlite-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-sqlite-module</systemitem>
as well, Seed attempts to build the SQLite native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-example-module</systemitem> and
<systemitem>--enable-example-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-example-module</systemitem>
as well, Seed attempts to build the example native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-dbus-module</systemitem> and
<systemitem>--enable-dbus-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-dbus-module</systemitem>
as well, Seed attempts to build the DBus native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-os-module</systemitem> and
<systemitem>--enable-os-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-os-module</systemitem>
as well, Seed attempts to build the os native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-libxml-module</systemitem> and
<systemitem>--enable-libxml-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-libxml-module</systemitem>
as well, Seed attempts to build the libxml2 native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-gtkbuilder-module</systemitem> and
<systemitem>--enable-gtkbuilder-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-gtkbuilder-module</systemitem>
as well, Seed attempts to build the GtkBuilder native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-cairo-module</systemitem> and
<systemitem>--enable-cairo-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-cairo-module</systemitem>
as well, Seed attempts to build the Cairo native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-gettext-module</systemitem> and
<systemitem>--enable-gettext-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-gettext-module</systemitem>
as well, Seed attempts to build the gettext native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-mpfr-module</systemitem> and
<systemitem>--enable-mpfr-module</systemitem></title>
<para>
By default, and with <systemitem>--enable-mpfr-module</systemitem>
as well, Seed attempts to build the mpfr native module.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-turtle-example</systemitem> and
<systemitem>--enable-turtle-example</systemitem></title>
<para>
By default, and with <systemitem>--enable-turtle-example</systemitem>
as well, Seed attempts to build the Turtle example.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-examples</systemitem> and
<systemitem>--enable-examples</systemitem></title>
<para>
By default, and with <systemitem>--enable-examples</systemitem>
as well, a library of JavaScript examples are installed alongside Seed.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-profile</systemitem> and
<systemitem>--enable-profile</systemitem></title>
<para>
With <systemitem>--enable-profile</systemitem>, Seed is built with profiling and coverage instructions. One can use <command>make profile</command> or <command>make profile-gui</command> to profile the library.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-profile-modules</systemitem> and
<systemitem>--enable-profile-modules</systemitem></title>
<para>
With <systemitem>--enable-profile-modules</systemitem>, all Seed modules are built with profiling and coverage instructions. One can use <command>make profile</command> or <command>make profile-gui</command> to profile the modules.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-debug</systemitem> and
<systemitem>--enable-debug</systemitem></title>
<para>
With <systemitem>--enable-debug</systemitem>, Seed is built without optimizations and with extra debugging information included, and extra debug arguments to the <command>seed</command> interpreter are enabled; you can learn about these by calling <command>seed --help</command>.
</para>
</formalpara>
<formalpara>
<title><systemitem>--disable-shave</systemitem> and
<systemitem>--enable-shave</systemitem></title>
<para>
By default, and with <systemitem>--enable-shave</systemitem> as well, Seed is built with pretty-printed build output. Disable this to see the actual compiler and linker commands being executed.
</para>
</formalpara>
</refsect1>
</refentry>
|