[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc/C/refmanual building.xml code_depende...
|
From: |
Rob Savoye |
|
Subject: |
[Gnash-commit] gnash/doc/C/refmanual building.xml code_depende... |
|
Date: |
Sat, 01 Mar 2008 19:47:10 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Rob Savoye <rsavoye> 08/03/01 19:47:10
Modified files:
doc/C/refmanual: building.xml code_dependencies.xml
configuration.xml cross_compiling.xml
custompath_configuration.xml
documentation_dependencies.xml
feature_configuration.xml memory.xml
sources.xml testing_dependencies.xml
Log message:
* doc/C/refmanual/building.xml, code_dependencies.xml,
configuration.xml, cross_compiling.xml,
custompath_configuration.xml, documentation_dependencies.xml,
feature_configuration.xml, testing_dependencies.xml: Updated to
match reality.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/building.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/code_dependencies.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/configuration.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/cross_compiling.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/custompath_configuration.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/documentation_dependencies.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/feature_configuration.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/memory.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/sources.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/refmanual/testing_dependencies.xml?cvsroot=gnash&r1=1.1&r2=1.2
Patches:
Index: building.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/building.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- building.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ building.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,12 +1,102 @@
-<title>Building from Source</title>
+<chapter id="build">
+ <title>Building from Source</title>
-<para>
+ <sect1 id="building_overview">
+ <title>Overview</title>
+ <para>
+ The typical process of building from source will involve
+ <link linkend="gettingsource">getting the source</link>,
+ <link linkend="dependencies">build dependencies</link>,
+ <link linkend="configure">configuration</link>,
+ <link linkend="compile">compilation</link>,
+ <link linkend="runtests">testing</link>, and
+ <link linkend="install">installation</link>.
+ A simplified overview of the process would be:
+ <programlisting>
+ ./autogen.sh
+ ./configure
+ make
+ make check
+ make install
+ </programlisting>
+ </para>
+
+ <para>
+ If you are compiling with GCC you will probably need to use a machine
+ with at least 128 megabytes of physical RAM; 64MB is not enough for a
+ couple of the files, even with swap enabled and optimisation turned off.
+ </para>
+ <para>
+ At present the Gnash source is about 30 MB to extracted and configured
+ and requires a total of about 125 megabytes to compile it.
+ </para>
+ <para>
+ Continue reading for detailed step-by-step instructions
+ of the entire procedure.
+ </para>
+
+ </sect1>
+
+ <sect1 id="gettingsource">
+ <title>Getting The Source</title>
+
+ <sect2 id="sourcereleases">
+ <title>Releases</title>
+ <para>
+ Tarballs of official releases can be found in the download area
+ of the project's GNU Savannah page at
+ <ulink type="http"
+ url="http://savannah.gnu.org/projects/gnash";>
+ http://savannah.gnu.org/projects/gnash
+ </ulink>
+ or under
+ <ulink type="http"
+ url="http://ftp.gnu.org/gnu/gnash";>
+ http://ftp.gnu.org/gnu/gnash
+ </ulink>
+ </para>
+ </sect2>
+
+ <sect2 id="sourcecvs">
+ <title>CVS Access</title>
+ <para>
+ The latest Gnash development sources are available via anonymous CVS.
+ Use the following commands to check them out
+ (just hit return when you are prompted for the password):
+ <programlisting>
+ export CVS_RSH=ssh
+ cvs -z3 -d:pserver:address@hidden:/sources/gnash co gnash
+ </programlisting>
+ you will then be able to update your copy from the repository using
+ <programlisting>
+ cd gnash
+ cvs update -d
+ </programlisting>
+ </para>
+ <para>
+ If you only have access to the internet via a web proxy,
+ you will find daily source snapshots of the latest CVS tree in
+ <ulink type="http"
+ url="http://www.gnashdev.org/dev_snapshots/";>
+ http://www.gnashdev.org/dev_snapshots
+ </ulink>
+ </para>
+ </sect2>
+ </sect1>
+
+ &codedependencies;
+ &testdependencies;
+ &docdependencies;
+
+ &configuration;
+
+ <para>
Once you have <link linkend="pre-configuration">configured</link> &app;,
you are ready to build the code. &app; is built using
<emphasis>GNU make</emphasis>.
-</para>
+ </para>
-<sect2 id="compile">
+ <sect1 id="compile">
<title>Compiling the Code</title>
<para>
@@ -27,16 +117,16 @@
The default value for both of these variables is
<emphasis>-O2 -g</emphasis>. A list of influential
environment variables can be seen in the configuration help:
-</para>
-<programlisting>./configure --help</programlisting>
-<para>
+ </para>
+ <programlisting>./configure --help</programlisting>
+ <para>
In the following example, debugging is enabled and optimization is
disabled:
-</para>
-<programlisting>make CFLAGS=-g CXXFLAGS=-g</programlisting>
-</sect2>
+ </para>
+ <programlisting>make CFLAGS=-g CXXFLAGS=-g</programlisting>
+ </sect1>
-<sect2 id="processdoc">
+ <sect1 id="processdoc">
<title>Creating the Documentation</title>
<para>
@@ -77,18 +167,19 @@
make apidoc
</programlisting>
</para>
-</sect2>
-
+ </sect1>
-<sect2 id="runtests">
+ <sect1 id="runtests">
<title>Running the Tests</title>
<para>
- Before beginning the potentially lengthy install, it is wise to test the
installation. If a test fails, please report it by following the
- <link linkend="bugreport">instructions for reporting a bug</link>.
+ Before beginning the potentially lengthy install, it is wise to
+ test the installation. If a test fails, please report it by
+ following the <link linkend="bugreport">instructions for
+ reporting a bug</link>.
</para>
- <sect3 id="dejagnu">
+ <sect2 id="dejagnu">
<title>Using DejaGnu</title>
<para>
@@ -151,8 +242,8 @@
</para>
</sect4>
- </sect3>
- <sect3 id="manually">
+ </sect2>
+ <sect2 id="manually">
<title>Running The Tests Manually</title>
<para>
@@ -194,8 +285,11 @@
</programlisting>
</para>
</sect4>
- </sect3>
+ </sect2>
+ &install;
+ &crosscompiling;
-</sect2>
+ </sect1>
+</chapter>
\ No newline at end of file
Index: code_dependencies.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/code_dependencies.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- code_dependencies.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ code_dependencies.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,25 +1,23 @@
-<title>Code Dependencies</title>
+<sect1 id="codedep">
+ <title>Code Dependencies</title>
-<para>
+ <para>
&app; has a number of dependencies on other packages.
If you install the dependencies using a package
manager, be certain to install the development versions
of the packages. The normal versions are often missing
the headers &app; needs to compile.
-</para>
+ </para>
-<note>
- <title>Note</title>
<para>
- If you want to install the &app; plugin for one of the browsers
- listed in the <xref linkend="intro" />, be sure to install the
- development package for that browser before configuring. The
- &app; <command>configure</command> script searches for the devel
- packages before building the plugin.
+ Some dependencies have other dependencies, like GTk also needs
+ glib2, atk, and pango to produce a fully linked
+ executable. Different distributions also use differing
+ dependencies, sometimes a package will depend on libxml2 on one
+ system, but libexpat on another.
</para>
-</note>
-<table frame='all' id="codedeps">
+ <table frame='all' id="codedeps">
<title>Code Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
@@ -29,6 +27,7 @@
<colspec colname='explanation'/>
<colspec colname='apt'/>
<colspec colname='rpm'/>
+ <colspec colname='pkg'/>
<thead>
<row>
@@ -39,6 +38,7 @@
<entry>Explanation</entry>
<entry>apt-get package</entry>
<entry>RPM/Yum package</entry>
+ <entry>BSD package</entry>
</row>
</thead>
@@ -53,15 +53,21 @@
</entry>
<entry>
In &app;, Boost libraries are used extensively, primarily
- boost-gthread and boost-date-time.
+ boost-gthread and boost-date-time. Boost is used for thread and
mutext
+ handling.
+ </entry>
+ <entry>
+ <filename>libboost-thread-dev, libboost-date-time-dev libboost-dev
+ </filename>
</entry>
<entry>
- <filename>libboost-thread-dev, libboost-date-time-dev
+ <filename>
+ libboost-thread-devel, libboost-date-time-devel
</filename>
</entry>
<entry>
<filename>
- liboost-thread-dev, libboost-date-time
+ boost-headers, boost-libs, or just boost
</filename></entry>
</row>
@@ -75,11 +81,12 @@
url="http://xmlsoft.org";>http://xmlsoft.org</ulink>.
</entry>
<entry>
- This library is used to parse messages in the
- XML or XMLSocket ActionScript classes.
+ This library is used to parse messages for the
+ XML XMLNode, or XMLSocket ActionScript classes.
</entry>
<entry><filename>libxml2-dev</filename></entry>
<entry><filename>libxml2-devel</filename></entry>
+ <entry><filename>libxml2</filename></entry>
</row>
<row>
@@ -97,6 +104,7 @@
</entry>
<entry><filename>libagg-dev</filename></entry>
<entry><filename>agg-devel</filename></entry>
+ <entry><filename>agg</filename></entry>
</row>
<row>
@@ -110,14 +118,17 @@
It supports hardware acceleration.
You can download a free implementation from
<ulink type="http"
- url="http://www.mesa3d.org";>http://www.mesa3d.org</ulink>.
+ url="http://www.mesa3d.org";>http://www.mesa3d.org</ulink>,
+ although it doesn't support hardware acceleration.
</entry>
<entry>
&app; requires the installation of at least one
- renderer.
+ renderer. If you don't have a hardware accelerated driver,
+ you're better off using AGG for the renderer.
</entry>
<entry><filename>libgl1-mesa-dev</filename></entry>
<entry><filename>libmesa-devel</filename></entry>
+ <entry><filename>mesa</filename></entry>
</row>
<row>
@@ -138,6 +149,7 @@
</entry>
<entry><filename>libcairo2-dev</filename></entry>
<entry><filename>cairo-devel</filename></entry>
+ <entry><filename>cairo</filename></entry>
</row>
<row>
@@ -145,8 +157,11 @@
<entry>Possibly Required</entry>
<entry>2.2 or higher</entry>
<entry>
- GTK is the GIMP Toolkit GUI library.
- It uses Cairo internally.
+ GTK is the GIMP Toolkit GUI library used by the GNOME
+ desktop. It uses Cairo internally. Gtk enables better
+ integration with Firefox, as well as better event handling
+ and higher level GUI constructs like menus and dialog
+ boxes.
</entry>
<entry>
&app; requires the installation of at least one
@@ -156,6 +171,7 @@
</entry>
<entry><filename>libgtk2.0-dev</filename></entry>
<entry><filename>gtk-devel</filename></entry>
+ <entry><filename>gtk+2</filename></entry>
</row>
<row>
@@ -172,6 +188,7 @@
</entry>
<entry><filename>libgtkglext1-dev</filename></entry>
<entry><filename>gtkglext-devel</filename></entry>
+ <entry><filename>gtkglext</filename></entry>
</row>
<row>
@@ -197,6 +214,7 @@
</entry>
<entry><filename>libsdl1.2-dev</filename></entry>
<entry><filename>SDL-devel</filename></entry>
+ <entry><filename>SDL-1.2</filename></entry>
</row>
<row>
@@ -214,6 +232,7 @@
</entry>
<entry>No distribution packages are available.</entry>
<entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
@@ -229,8 +248,9 @@
GUI library. Kdelibs is also required for the
Kpart plugin for Konqueror.
</entry>
- <entry><filename>kdelibs4-dev</filename></entry>
- <entry><filename>kdelibs-devel</filename></entry>
+ <entry><filename>kdelibs3-dev, kdebase-dev</filename></entry>
+ <entry><filename>kdelibs-devel, kdebase-devel</filename></entry>
+ <entry><filename>kdelibs, kdebase</filename></entry>
</row>
<row>
@@ -246,6 +266,7 @@
</entry>
<entry><filename>libgstreamer0.8-dev</filename></entry>
<entry><filename>gstreamer-devel</filename></entry>
+ <entry><filename>gstreamer-0.10</filename></entry>
</row>
<row>
@@ -262,6 +283,7 @@
</entry>
<entry><filename>gstreamer0.8-ffmpeg-dev</filename></entry>
<entry><filename>gstreamer-ffmpeg-devel</filename></entry>
+ <entry><filename>gstreamer-ffmpeg</filename></entry>
</row>
<row>
@@ -273,11 +295,14 @@
</entry>
<entry>
If you would like video playback, you must
- install one of the video handlers. It is also
- a dependency of gst-ffmpeg.
+ install one of the video handlers. When using the
+ gstreamer-ffmpeg plugin, ffmpeg doesn't need to be
+ installed, as it's part of the plugin. For systems
+ without Gstreamer support, ffmpeg can be used directly.
</entry>
<entry><filename>ffmpeg-dev</filename></entry>
<entry><filename>ffmpeg-devel</filename></entry>
+ <entry><filename>ffmpeg</filename></entry>
</row>
<row>
@@ -293,6 +318,7 @@
</entry>
<entry><filename>libjpeg62-dev</filename></entry>
<entry><filename>libjpeg</filename></entry>
+ <entry><filename>jpeg</filename></entry>
</row>
<row>
@@ -310,6 +336,7 @@
</entry>
<entry><filename>libpng12-dev</filename></entry>
<entry><filename>libpng</filename></entry>
+ <entry><filename>png</filename></entry>
</row>
<row>
@@ -324,7 +351,54 @@
</entry>
<entry><filename>libcurl4-gnutls</filename></entry>
<entry><filename>libcurl</filename></entry>
+ <entry><filename>curl</filename></entry>
+ </row>
+ <row>
+ <entry>Glib2</entry>
+ <entry>Optional</entry>
+ <entry></entry>
+ <entry>
+ Glib2 is a dependency of Gtk, and is a collection of
+ commonly used functions.
+ </entry>
+ <entry>
+ This library is used for convenience.
+ </entry>
+ <entry><filename>glib2-dev</filename></entry>
+ <entry><filename>glib2-devel</filename></entry>
+ <entry><filename>glib2</filename></entry>
+ </row>
+
+ <row>
+ <entry>Atk</entry>
+ <entry>Optional</entry>
+ <entry></entry>
+ <entry>
+ Atk is a dependency of Gtk, and is used for accessibility
+ support.
+ </entry>
+ <entry>
+ This library is used for accessiblity..
+ </entry>
+ <entry><filename>atk-dev</filename></entry>
+ <entry><filename>atk-devel</filename></entry>
+ <entry><filename>atk</filename></entry>
+ </row>
+
+ <row>
+ <entry>Pango</entry>
+ <entry>Optional</entry>
+ <entry></entry>
+ <entry>
+ Pango is a dependency of Gtk, and is used for font handling.
+ </entry>
+ <entry>
+ This library is used for font handling.
+ </entry>
+ <entry><filename>pango-dev</filename></entry>
+ <entry><filename>pango-devel</filename></entry>
+ <entry><filename>pango</filename></entry>
</row>
<row>
@@ -342,6 +416,7 @@
</entry>
<entry><filename>automake</filename></entry>
<entry><filename>automake</filename></entry>
+ <entry><filename>automake</filename></entry>
</row>
<row>
@@ -359,6 +434,7 @@
</entry>
<entry><filename>autoconf</filename></entry>
<entry><filename>autoconf</filename></entry>
+ <entry><filename>autoconf</filename></entry>
</row>
<row>
@@ -375,6 +451,7 @@
</entry>
<entry><filename>gettext</filename></entry>
<entry><filename>gettext</filename></entry>
+ <entry><filename>gettext</filename></entry>
</row>
<row>
@@ -391,8 +468,10 @@
</entry>
<entry><filename>libltdl3-dev</filename></entry>
<entry><filename>libtool</filename></entry>
+ <entry><filename>libtool</filename></entry>
</row>
</tbody>
</tgroup>
-</table>
+ </table>
+</sect1>
\ No newline at end of file
Index: configuration.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/configuration.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- configuration.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ configuration.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,9 +1,15 @@
-<para>
-&app;, like most GNU projects, allows a user to select various options before
compiling its source code. These options include selecting from the available
features, specifying custom paths for installation, and cross compiling. &app;
uses <ulink type="http"
+<sect1 id="configure">
+ <title>Configuring Gnash</title>
+
+ <para>
+ &app;, like most GNU projects, allows a user to select various
+ options before compiling its source code. These options include
+ selecting from the available features, specifying custom paths for
+ installation, and cross compiling support uses <ulink type="http"
url="http://www.gnu.org/software/autoconf/";>GNU Autoconf</ulink>
for configuration.
-</para>
-<para>
+ </para>
+ <para>
If you opted to download the
<link linkend="sourcerepo">development checkout</link>
of &app;, the <emphasis>configure</emphasis> script will
@@ -13,10 +19,10 @@
./autogen.sh
</programlisting>
Note that there are some
- <link linkend="codedepend">dependencies</link> for
+ <link linkend="dependencies">dependencies</link> for
autogen.
-</para>
-<para>
+ </para>
+ <para>
All the standard <command>configure</command> options
are available. In addition, &app; has two types of
options: those that <link linkend="features">enable or disable
@@ -31,8 +37,8 @@
</programlisting>
Read further for a more detailed explanation of &app;-specific
options.
-</para>
-<para>
+ </para>
+ <para>
The syntax for running <emphasis>configure</emphasis> is as follows:
<programlisting>
configure <replaceable><options></replaceable>
@@ -41,21 +47,35 @@
which create the smallest working standalone version of &app;. In
this example, <command>configure</command> is being run from the
source root directory:
-</para>
+ </para>
+
+ <programlisting>
+ ./configure --disable-debugger --disable-cygnal \
+ --disable-plugin --enable-media=ffmpeg --enable-gui=sdl
+ </programlisting>
+
+ <para>
+ By default, you shouldn't need to supply any options to
+ configure. The configure script will attempt to determine what to
+ build based on the development libraries you have installed. The
+ default configuration for Gnash is both GTK and KDE GUIs, the AGG
+ renderer, and Gstreamer for mltimedia support, with no extensions
+ built.
+ </para>
-<programlisting>
-./configure --disable-debugger --disable-cygnal --disable-docbook \
---disable-plugin --enable-media=ffmpeg --enable-gui=sdl
-</programlisting>
+ <para>
+ Being higher portable, &app; has many configuration options
+ available, and not all are supposed to work together. A common
+ mistake when configuring &app; is to supply too many options,
+ overdriving &app;'s ability to do the right thing.
+ </para>
-<sect2 id="features">
+ <sect2 id="features">
&featureoptions;
-</sect2>
+ </sect2>
-<sect2 id="custompath">
+ <sect2 id="custompath">
&custompath;
-</sect2>
+ </sect2>
-<sect2 id="crosscompilingconfiguration">
- &crosscompiling;
-</sect2>
+</sect1>
Index: cross_compiling.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/cross_compiling.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- cross_compiling.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ cross_compiling.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,59 +1,67 @@
-<title>Cross Compiling</title>
+<sect1 id="cross">
+ <title>Cross Configuring</title>
-<para>
+ <para>
To cross configure and compile &app;, begin by building a target system
on your workstation. This includes cross compilers for the target
architecture, and some system headers.
- You will also need the following packages to be built for the target
- system: <emphasis>libxml2</emphasis>, <emphasis>libpng</emphasis>
- (if used), <emphasis>libjpeg</emphasis>,oost <emphasis>b</emphasis>, your
- GUI library, your renderer, and your video handler (if used). The page
+ You will also need to cross compile all the <link
linkend="docdepend">dependencies
+ </link> normally needed to build Gnash. This can on occasion be a
+ daunting process, as not libraries will cross configure and cross
+ compile. There is more information about cross compiling all the
+ dependant packages on the <ulink type="http"
+ url="http://www.gnashdev.org";>http://www.gnashdev.org</ulink> web
+ site.
+ </para>
+
+ <para>
+ If you need to build your own tool chain, that is beyond the scope
+ of this manual. There are various resources on the web for howto's
+ on building GCC based cross toolchains. Two popular sites are
<ulink url="http://frank.harvard.edu/~coldwell/toolchain/";
type="http">http://frank.harvard.edu/~coldwell/toolchain/</ulink>
- has instructions on building a target system from scratch and
- offers a shell script to make the process easier.
-</para>
-
-<para>
- If you need to build up a target system from scratch, there is
- a good document and shell script at this web site: <ulink
- type="http"
- url="http://frank.harvard.edu/~coldwell/toolchain/";>
- http://frank.harvard.edu/~coldwell/toolchain/</ulink>.
-</para>
-
-<para>
- There is also up to date information on the Gnash Developers
- web site at: <ulink type="http" url="http://www.gnashdev.org";>
- http://www.gnashdev.org</ulink>. This is the best place for
- detailed informatin on various systems.
-</para>
-
-<para>
- After I built up an ARM system in /usr/arm using the shell
- script from this web site, I then cross compiled all the
- other libraries I needed. The fun part is trying to get
- libMesa and boost to cross compile, because they're not really set
- up for it.
-</para>
+ and <ulink url="http://www.kegel.com/crosstool/";
+ type="http">http://www.kegel.com/crosstool/</ulink>. This
+ can also be a very time consuming and frustrating process, even
+ for experienced developers.
+ </para>
-<para>
- So to build for an ARM based system on an x86 based systems,
+ <para>
+ Because the process of building your own cross tool chain can be
+ harder than one may wish, there are several other cross
+ development environments that simulate a native environment to
+ make it easier to develop. These also let you develop for both
+ native and cross builds. Several popular ones are
+ <ulink url="http://www.access-company.com/products/linux/alp.html";
type="http">
+ Access Linux Platform</ulink>,
+ <ulink url="http://www.scratchbox.org/"; type="http">
+ Scratchbox</ulink>,
+ <ulink url="http://www.openembedded.org/"; type="http">
+ Open Embedded</ulink>,
+ <ulink url="http://maemo.org/"; type="http">
+ Maemo</ulink>.
+ </para>
+
+ <para>
+ To build for an ARM based system on an x86 based systems,
+ configure like this using the traditional style cross toolchain,
configure like this:
-</para>
+ </para>
-<programlisting>
+ <programlisting>
../../gnash/configure --build=i686-pc-linux-gnu
--host=arm-linux --prefix=/usr/local/arm/oe --disable-nsapi
- --disable-kparts --enable-gui=fb --enable-renderer=agg --disable-shared
-</programlisting>
+ --disable-kparts --enable-gui=fb --enable-renderer=agg
+ --disable-shared --disable-menus
+
+ </programlisting>
-<para>
+ <para>
The important configuration options are the ones which specify the
architecture for the build:
-</para>
+ </para>
-<variablelist>
+ <variablelist>
<varlistentry>
<term>--target</term>
@@ -90,15 +98,16 @@
</listitem>
</varlistentry>
-</variablelist>
+ </variablelist>
-<para>
+ <para>
The following example of <emphasis>configure</emphasis> builds for an
ARM system on an x86 system. It was run after an ARM system was built
in <filename>/usr/arm</filename> and other required libraries were
cross compiled.
<programlisting>
-./configure -target=arm-unknown-linux-gnu --prefix=/usr/arm \
---host=arm-unknown-linux-gnu --build=i686-pc-linux-gnu --disable-plugin
+ ./configure -target=arm-unknown-linux-gnu --prefix=/usr/arm \
+ --host=arm-unknown-linux-gnu --build=i686-pc-linux-gnu --disable-plugin
</programlisting>
-</para>
+ </para>
+</sect1>
Index: custompath_configuration.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/custompath_configuration.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- custompath_configuration.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ custompath_configuration.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,121 +1,136 @@
-<title>Specifying Custom Paths</title>
-<para>
+<sect1 id="custompath">
+ <title>Specifying Custom Paths</title>
+
+ <para>
By default, none of these options should be required
unless you want &app; to use a specific version of a
development package, or if the configure test fails to
find a component. Please <link
linkend="bugreport">report the problem</link> if a
configure test fails.
-</para>
-<para>
+ </para>
+ <para>
The following custom path options are available:
-</para>
+ </para>
-<table id="tb-configure-paths">
-<title>Custom Path Options</title>
-<tgroup cols='2' align='left' colsep='1' rowsep='1'>
-<colspec colname='Option' />
-<colspec colname='Function' />
-<thead>
-<row>
+ <table id="tb-configure-paths">
+ <title>Custom Path Options</title>
+ <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ <colspec colname='Option' />
+ <colspec colname='Function' />
+ <thead>
+ <row>
<entry>Option</entry>
<entry>Function</entry>
-</row>
-</thead>
-<tbody>
-<row>
+ </row>
+ </thead>
+ <tbody>
+ <row>
<entry>
<option>--x-includes=DIR</option>
</entry>
<entry>
X include files are in DIR.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--x-libraries=DIR</option>
</entry>
<entry>
X library files are in DIR.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-libxml=PFX</option>
</entry>
<entry>
Prefix to where libxml is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-libxml-libraries=DIR</option>
</entry>
<entry>
Directory where libxml library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-libxml-includes=DIR</option>
</entry>
<entry>
Directory where libxml header files are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-docbook=DIR</option>
</entry>
<entry>
Directory where the DocBook style-sheets are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-sdl-prefix=PFX</option>
</entry>
<entry>
Prefix where SDL is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-zlib-incl</option>
</entry>
<entry>
Directory where zlib header is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-zlib-lib</option>
</entry>
<entry>
Directory where zlib library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-jpeg-incl</option>
</entry>
<entry>
Directory where jpeg header is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-jpeg-lib</option>
</entry>
<entry>
Directory where jpeg library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-png-incl</option>
</entry>
<entry>
Directory where png header is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-png-lib</option>
</entry>
<entry>
Directory where png library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-qt-dir</option>
</entry>
@@ -123,7 +138,8 @@
Directory where QT is installed. This is only used by
the Klash plugin.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-qt-includes</option>
</entry>
@@ -131,7 +147,8 @@
Directory where the QT header files are installed. This
is only used by the Klash plugin.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-qt-libraries</option>
</entry>
@@ -139,7 +156,8 @@
Directory where the QT libraries are installed. This is
only used by the Klash plugin.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-npapi-plugindir</option>
</entry>
@@ -147,18 +165,23 @@
This is the directory to install the NPAPI (Mozilla) plugin in.
By default it goes to ~/.mozilla/plugins.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-kde-pluginprefix</option>
</entry>
<entry>
This option sets the default install dir for all KPARTS (kde) files.
- The plugin will be installed in PREFIX/lib/kde3, use
<option>-with-kde-plugindir</option> to override.
- The service file in PREFIX/share/services, use
<option>--with-kde-servicesdir</option> to override.
- The config file in PREFIX/share/config, use
<option>--with-kde-configdir</option> to override.
- The appdata file in PREFIX/share/apps/klash, use
<option>--with-kde-appsdatadir</option> to override.
+ The plugin will be installed in PREFIX/lib/kde3, use
+ <option>-with-kde-plugindir</option> to override. The service file
in
+ PREFIX/share/services, use <option>--with-kde-servicesdir</option>
to
+ override. The config file in PREFIX/share/config, use
+ <option>--with-kde-configdir</option> to override. The
+ appdata file in PREFIX/share/apps/klash, use
+ <option>--with-kde-appsdatadir</option> to override.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-kde-plugindir</option>
</entry>
@@ -167,7 +190,8 @@
By default it is what's set by --with-kde-pluginprefix or what's
returned by kde-config --install module --expandvars,
or $(prefix)/share/services if kde-config is not found.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-kde-servicesdir</option>
</entry>
@@ -176,7 +200,8 @@
By default it is what's set by --with-kde-pluginprefix or what's
returned by kde-config --install services --expandvars,
or $(libdir)/kde3 if kde-config is not found.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-kde-configdir</option>
</entry>
@@ -185,7 +210,8 @@
By default it is what's set by --with-kde-pluginprefix or what's
returned by kde-config --install config --expandvars,
or $(prefix)/share/config if kde-config is not found.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-kde-appsdatadir</option>
</entry>
@@ -194,7 +220,8 @@
By default it is what's set by --with-kde-pluginprefix or what's
returned by kde-config --install data --expandvars,
or $(prefix)/share/apps if kde-config is not found.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-ming</option>
</entry>
@@ -202,35 +229,24 @@
Ming is used to build test cases, but not by the Gnash
player itself.
</entry>
- </row><row>
- <entry>
- <option>--with-mad_incl</option>
- </entry>
- <entry>
- Directory where libmad header is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-mad_lib</option>
- </entry>
- <entry>
- Directory where libmad library is installed.
- </entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-ogg_incl</option>
</entry>
<entry>
Directory where the libogg headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-ogg_lib</option>
</entry>
<entry>
Directory where the libogg library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-gstreamer-incl</option>
</entry>
@@ -238,7 +254,8 @@
Directory where the Gstreamer headers are
installed. Gstreamer version 0.10 or greater must be used.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-gstreamer-lib</option>
</entry>
@@ -246,176 +263,200 @@
Directory where the Gstreamer library is
installed. Gstreamer version 0.10 or greater must be used.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-opengl-includes</option>
</entry>
<entry>
Directory where OpenGL (libMesa) headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-opengl-lib</option>
</entry>
<entry>
Directory where the OpenGL (libMesa) library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-glext-incl</option>
</entry>
<entry>
Directory where GtkGlExt headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-glext-lib</option>
</entry>
<entry>
Directory where the GtkGlExt library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-gtk2-incl</option>
</entry>
<entry>
Directory where the Gtk2 headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-gtk2-lib</option>
</entry>
<entry>
Directory where the Gtk2 library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-cairo_incl</option>
</entry>
<entry>
Directory where the Cairo headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-cairo-lib</option>
</entry>
<entry>
Directory where the Cairo library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-glib-incl</option>
</entry>
<entry>
Directory where the Glib headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-glib-lib</option>
</entry>
<entry>
Directory where the Glib library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-pango-incl</option>
</entry>
<entry>
Directory where the Pango headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-pango-lib</option>
</entry>
<entry>
Directory where the Pango library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-atk-incl</option>
</entry>
<entry>
Directory where the ATK headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-atk-lib</option>
</entry>
<entry>
Directory where the ATK library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-pthread-incl</option>
</entry>
<entry>
Directory where the Pthread headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-pthread-lib</option>
</entry>
<entry>
Directory where the Pthread library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-agg-incl</option>
</entry>
<entry>
Directory where the AGG (Antigrain) headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-agg-lib</option>
</entry>
<entry>
Directory where the AGG (Antigrain) library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-ffmpeg-incl</option>
</entry>
<entry>
Directory where the FFMPEG headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-ffmpeg-lib</option>
</entry>
<entry>
Directory where the FFMPEG library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-boost-incl</option>
</entry>
<entry>
Directory where the Boost headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-boost-lib</option>
</entry>
<entry>
Directory where the Boost library is installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-curl-incl</option>
</entry>
<entry>
Directory where the libCurl headers are installed.
</entry>
- </row><row>
+ </row>
+ <row>
<entry>
<option>--with-curl-lib</option>
</entry>
<entry>
Directory where the libCurl library is installed.
</entry>
-</row>
-</tbody>
-</tgroup>
-</table>
-
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+</sect1>
Index: documentation_dependencies.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/documentation_dependencies.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- documentation_dependencies.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ documentation_dependencies.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,10 +1,11 @@
-<title>Documentation Dependencies</title>
+<sect1 id="docdep">
+ <title>Documentation Dependencies</title>
-<para>
+ <para>
The following packages are used to build &app;'s documentation.
-</para>
+ </para>
-<table frame='all' id="docdeps">
+ <table frame='all' id="docdeps">
<title>Documentation Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
@@ -14,6 +15,7 @@
<colspec colname='explanation'/>
<colspec colname='apt'/>
<colspec colname='rpm'/>
+ <colspec colname='pkg'/>
<thead>
<row>
@@ -24,6 +26,7 @@
<entry>Explanation</entry>
<entry>apt-get package</entry>
<entry>RPM/Yum package</entry>
+ <entry>BSD package</entry>
</row>
</thead>
@@ -43,10 +46,13 @@
<entry>
&app; documentation is written in Docbook.
</entry>
- <entry><filename>docbook-utils</filename> and
- <filename>docbook-dsssl</filename></entry>
- <entry><filename>docbook-dtd41-sgml</filename> and
- <filename>docbook-style-dsssl</filename></entry>
+ <entry>
+ <filename>docbook-utils</filename> and
<filename>docbook-dsssl</filename>
+ </entry>
+ <entry>
+ <filename>docbook-dtd41-sgml</filename> and
<filename>docbook-style-dsssl</filename>
+ </entry>
+ <entry>docbook</entry>
</row>
<row>
@@ -66,6 +72,25 @@
</entry>
<entry><filename>docbook2x</filename></entry>
<entry><filename>docbook2x</filename></entry>
+ <entry><filename>docbook2x</filename></entry>
+ </row>
+
+ <row>
+ <entry>DocBook-utils</entry>
+ <entry>Optional</entry>
+ <entry></entry>
+ <entry>
+ This software package converts Docbook documents to
+ the traditional man page format, GNU Texinfo
+ format, and HTML (via Texinfo) format.
+ </entry>
+ <entry>
+ DocBook-utils is required to produce HTML and Texinfo
+ formats.
+ </entry>
+ <entry><filename>docbook-utils</filename></entry>
+ <entry><filename>docbook-utils</filename></entry>
+ <entry><filename>docbook-utils</filename></entry>
</row>
<row>
@@ -84,6 +109,7 @@
</entry>
<entry><filename>texinfo</filename></entry>
<entry><filename>texinfo</filename></entry>
+ <entry><filename>texinfo</filename></entry>
</row>
<row>
@@ -103,6 +129,7 @@
</entry>
<entry><filename>fop</filename></entry>
<entry><filename>fop</filename></entry>
+ <entry><filename>fop</filename></entry>
</row>
<row>
@@ -125,6 +152,7 @@
Download the package from <ulink type="http"
url="http://java.sun.com";>Sun</ulink>.
</entry>
+ <entry></entry>
</row>
<row>
@@ -150,16 +178,18 @@
url="http://java.sun.com/products/java-media/jai/iio.html";
type="http">Sun</ulink>.
</entry>
+ <entry></entry>
</row>
</tbody>
</tgroup>
-</table>
+ </table>
-<para>
+ <para>
If you install j2re, set the <emphasis>JAVA_HOME</emphasis>
environment variable to the top directory of the j2re
installation. If you encounter problems with the Java
installation, you may also need to add this path to the
<emphasis>CLASSPATH</emphasis> environment variable.
-</para>
+ </para>
+</sect1>
\ No newline at end of file
Index: feature_configuration.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/feature_configuration.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- feature_configuration.xml 1 Mar 2008 16:59:30 -0000 1.1
+++ feature_configuration.xml 1 Mar 2008 19:47:09 -0000 1.2
@@ -1,164 +1,170 @@
-<title>Features</title>
+<sect1 id="configfeatures">
+ <title>Features</title>
-<para>
+ <para>
Some switches can be used during configuration to enable or disable
features of &app;. Some of the most important configuration options
are:
-</para>
+ </para>
<itemizedlist mark="opencircle">
<listitem>
<para>
-<option>--enable-gui</option> lets you specify your GUI of choice.
-The default option is GTK.
+ <option>--enable-gui</option> lets you specify your GUI of choice.
+ The default option is GTK.
</para>
</listitem>
<listitem>
<para>
-<option>--enable-renderer</option> allows a renderer to be
-chosen. The default renderer is OpenGL.
+ <option>--enable-renderer</option> allows a renderer to be
+ chosen. The default renderer is AGG.
</para>
</listitem>
<listitem>
<para>
-<option>--enable-media</option> permits a media handler to be
-selected. The default is Gstreamer.
+ <option>--enable-media</option> permits a media handler to be
+ selected. The default is Gstreamer.
</para>
</listitem>
</itemizedlist>
-<para>
+ <para>
A complete list of available features follows.
-</para>
+ </para>
-<table id="tb-config-features">
-<title>Configuration Options - Features</title>
-<tgroup cols='2' align='left' colsep='1' rowsep='1'>
-<colspec colname='Option' />
-<colspec colname='Function' />
-<thead>
-<row>
+ <table id="tb-config-features">
+ <title>Configuration Options - Features</title>
+ <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ <colspec colname='Option' />
+ <colspec colname='Function' />
+ <thead>
+ <row>
<entry>Option</entry>
<entry>Function</entry>
-</row>
-</thead>
-<tbody>
-<row>
+ </row>
+ </thead>
+ <tbody>
+ <row>
<entry><option>--enable-debugger</option></entry>
<entry>Enable support for the Flash debugger. The debugger is
- mainly of interest to Flash developers.</entry>
-</row>
-<row>
- <entry><option>--enable-dmalloc</option></entry>
- <entry>Enable support for the DMalloc memory debugging tool.</entry>
-</row>
-<row>
+ mainly of interest to Flash developers, and is still under
development.</entry>
+ </row>
+ <row>
+ <entry><option>--enable-lirc</option></entry>
+ <entry>
+ Enable support for the LIRC remote control protocol.
+ </entry>
+ </row>
+
+ <row>
+ <entry><option>--enable-cygnal</option></entry>
+ <entry>
+ Build the Cygnal streaming media server.
+ </entry>
+ </row>
+
+ <row>
+ <entry><option>--disable-menus</option></entry>
+ <entry>
+ Disable building all the menus for the GUI. THis is used
+ by mobile devices without as much screen space.
+ </entry>
+ </row>
+
+ <row>
<entry> <option>--enable-docbook</option></entry>
- <entry> Enable the generation of HTML and PDF versions of the documentation
- from the XML. You will then be able to use <command>make html</command>
and <command>make pdf</command>.</entry>
-</row>
-<row>
- <entry> <option>--enable-embedded</option></entry>
- <entry> Link to Qt-embedded, do not use X. This is only used by
- Klash</entry>
-</row>
-<row>
- <entry> <option>--disable-fork</option></entry>
- <entry>Disable the plugin from forking the standalone player, and
- using a thread for the player instead. Currently forking
- the standalone player gives you the best results.</entry>
-</row>
-<row>
- <entry><option>--enable-ghelp</option>
-</entry>
- <entry>Enable support for the GNOME help system.</entry>
-</row>
-<row>
- <entry><option>--disable-glext</option>
-</entry>
- <entry>Disable using GtkGlExt, which forces the use of SDL
- instead. By default if the GtkGL extension for Gtk is found
- by the configure script, the GTK-enabled GUI is built.</entry>
-</row>
-<row>
- <entry><option>--enable-gui=gtk|sdl|kde|fltk|fb</option></entry>
+ <entry> Enable the generation of HTML, INFO, and MAN
+ versions of the documentation from the Docbook XML. You will
+ then be able to use <command>make html</command>,
+ <command>make info</command>, and <command>make
+ man</command> commands. By default, man,info and html pages
+ are generated.</entry>
+ </row>
+
+ <row>
+
<entry><option>--enable-gui=gtk|sdl|kde|fltk|fb|hildon|alp</option></entry>
<entry><para>Select the Graphic User Interface to use (choose one).</para>
<variablelist>
<varlistentry>
<term>GTK</term>
<listitem>
-<para>
+ <para>
The GTK+ toolkit, which is the default GUI.
Said to interwork particularly well with firefox.
-</para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Hildon</term>
+ <listitem>
+ <para>
+ The Hildon toolkist is based on GTK+, and is use by
+ some mobile devices.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ALP</term>
+ <listitem>
+ <para>
+ The ALP "Hiker" GUI is used for the Access Linux platform.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>SDL</term>
<listitem>
-<para>
+ <para>
Simple DirectMedia Layer, a simple and portable GUI.
Its sound facilities are used when --enable-media=ffmpeg
regardless of whether it is also in charge of the GUI.
-</para>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>KDE</term>
<listitem>
-<para>
+ <para>
An interface adapted to the KDE Desktop Environment.
This must be selected when building the Konqueror plugin
"klash". Furthermore, the only renderer that currently
works with KDE is opengl.
-</para>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>FLTK</term>
<listitem>
-<para>
+ <para>
Fast Light ToolKit, low on resource usage.
Since all build using fltk are now broken, we declare it
"for developers".
-</para>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>FB</term>
<listitem>
-<para>
+ <para>
The Linux Frame Buffer, also known as /dev/fb0.
AGG is the only renderer that can currently be used
with the framebuffer GUI.
-</para>
+ </para>
</listitem>
</varlistentry>
</variablelist>
-</entry>
-</row>
-<row>
+ </entry>
+ </row>
+ <row>
<entry><option>--enable-i810-lod-bias</option>
-</entry>
+ </entry>
<entry>Enable fix for Intel 810 LOD bias problem. Older versions
of libMesa on the Intel i810 or i815 graphics processor
need this flag or Gnash will core dump. This has been
fixed in newer versions (summer 2005) of libMesa.</entry>
-</row>
-<row>
- <entry><option>--enable-libsuffix</option>
-</entry>
- <entry><filename>/lib</filename> directory suffix (64,32,none=default). This
is only
- used by Klash.</entry>
-</row>
-<row>
- <entry><option>--enable-mac</option>
-</entry>
- <entry>Link to Qt/Mac (don't use X). This is only used by
- Klash.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-media=ffmpeg|gst|none</option>
-</entry>
+ </entry>
<entry> <para>
Select the specified media decoder and sound engine.
FFMPEG uses the SDL sound engine; GST uses its own.
@@ -167,8 +173,8 @@
<para>
You should only select one media decoder.
</para></entry>
-</row>
-<row>
+ </row>
+ <row>
<entry>
<option>--disable-nsapi</option>
<option>--enable-nsapi</option>
@@ -179,8 +185,8 @@
<option>--with-npapi-plugindir=</option> option to specify where the
plugin should be installed.
</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry>
<option>--disable-kparts</option>
<option>--enable-kparts</option>
@@ -193,22 +199,16 @@
plugin should be installed. The default installation dir is extracted
from kde-config.
</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry>
<option>--disable-plugins</option>
</entry>
<entry>Disable build of both kparts and npapi plugins</entry>
-</row>
-<row>
- <entry> <option>--enable-qtopia</option>
-</entry>
- <entry> Link to Qt-embedded, link to the Qtopia
- Environment. This is only used by Klash.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-renderer=opengl|cairo|agg</option>
-</entry>
+ </entry>
<entry>Enable support for the a graphics backend. Currently
only <option>opengl</option> and
<option>agg</option> work sufficiently. OpenGL is
@@ -218,46 +218,47 @@
support, and most embedded systems do not. OpenGl is the
default when building Gnash, although the quality of AGG's
rendering is currently superior to OpenGL.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-sdk-install</option>
-</entry>
+ </entry>
<entry>Enable installing the libraries and headers as an SDK.
-</entry>
-</row>
-<row>
+ </entry>
+ </row>
+ <row>
<entry><option>--disable-shared</option>
-</entry>
+ </entry>
<entry>Enable installing the shared libraries and headers.
Note that the extensions mechanism may not work if shared
libraries are disabled.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-strict</option>
-</entry>
+ </entry>
<entry>Turn verbose GCC compiler warnings. By default only
<option>-Wall</option> is used with GCC.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-fps-debug</option>
-</entry>
+ </entry>
<entry>Enable FPS debugging code. When this feature is compiled in you can
use the -f switch of &app;
to have FPS printed at regular intervals.</entry>
-</row>
-<row>
+ </row>
+ <row>
<entry><option>--enable-write</option></entry>
<entry>Makes the Mozilla plugin write the currently playing SWF movie to
<filename>/tmp</filename>.
-</entry>
-</row>
-<row>
+ </entry>
+ </row>
+ <row>
<entry><option>--disable-mit-shm</option>
-</entry>
+ </entry>
<entry>Disable support for the MIT-SHM X extensions.
Currently support is only available using GTK gui and AGG renderer.
Keeping it enabled is not a problem as it will not be used if not
available in the current X session.
</entry>
-</row>
-</tbody>
-</tgroup>
-</table>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+</sect1>
\ No newline at end of file
Index: memory.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/memory.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- memory.xml 1 Mar 2008 15:15:30 -0000 1.1
+++ memory.xml 1 Mar 2008 19:47:10 -0000 1.2
@@ -1,4 +1,4 @@
- <sect1 id="spec-memory">
+<sect1 id="spec-memory">
<title>Memory Management</title>
<para>
@@ -47,5 +47,4 @@
runtime memory footprint:
</para>
- </sect1>
-
+</sect1>
Index: sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/sources.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- sources.xml 1 Mar 2008 16:59:31 -0000 1.1
+++ sources.xml 1 Mar 2008 19:47:10 -0000 1.2
@@ -1,1714 +1,33 @@
-<sect1 id="build">
- <title>Building From Source</title>
+<title>Building from Source</title>
- <sect2 id="building_overview">
- <title>Overview</title>
- <para>
- The typical process of building from source will involve
+<para>
+ Installing from source will involve the following steps:
<link linkend="gettingsource">getting the source</link>,
<link linkend="codedepend">resolving dependencies</link>,
<link linkend="configure">configuration</link>,
<link linkend="compile">compilation</link>,
<link linkend="runtests">testing</link>, and
<link linkend="install">installation</link>.
- A simplified overview of the process would be:
+ The &app; installation process is fairly standard:
<programlisting>
./autogen.sh
- ./configure
+ ./configure <options>
make
make check
make install
</programlisting>
- </para>
-
- <para>
- If you are compiling with GCC you will probably need to use a machine
- with at least 128 megabytes of physical RAM; 64MB is not enough for a
- couple of the files, even with swap enabled and optimisation turned off.
- </para>
- <para>
- At present the Gnash source is about 16 MB to extracted and configured
- and requires a total of about 100 megabytes to compile it.
- </para>
- <para>
+</para>
+<para>
Continue reading for detailed step-by-step instructions
of the entire procedure.
- </para>
- </sect2>
-
- <sect2 id="gettingsource">
- <title>Getting The Source</title>
-
- <sect3 id="sourcereleases">
- <title>Releases</title>
- <para>
- Tarballs of official releases can be found in the download area
- of the project's GNU Savannah page at
- <ulink type="http"
- url="http://savannah.gnu.org/projects/gnash";>
- http://savannah.gnu.org/projects/gnash
- </ulink>
- or under
- <ulink type="http"
- url="http://ftp.gnu.org/gnu/gnash";>
- http://ftp.gnu.org/gnu/gnash
- </ulink>
- </para>
- </sect3>
-
- <sect3 id="sourcecvs">
- <title>CVS Access</title>
- <para>
- The latest Gnash development sources are available via anonymous CVS.
- Use the following commands to check them out
- (just hit return when you are prompted for the password):
- <programlisting>
- export CVS_RSH=ssh
- cvs -z3 -d:pserver:address@hidden:/sources/gnash co gnash
- </programlisting>
- you will then be able to update your copy from the repository using
- <programlisting>
- cd gnash
- cvs update -d
- </programlisting>
- </para>
- <para>
- If you only have access to the internet via a web proxy,
- you will find daily snapshots of the latest CVS tree in
- <ulink type="http"
- url="http://www.gnashdev.org/dev_snapshots/";>
- http://www.gnashdev.org/dev_snapshots
- </ulink>
- </para>
- </sect3>
- </sect2>
-
- <sect2 id="codedepend">
- <title>Code Dependencies</title>
-
- <para>
- Gnash has dependencies on other packages. When installing
- from a packaged release file (rpm, deb, etc.), you'll need
- to install the development versions to get the tools used to
- compile Gnash. The normal runtime packages installed are usually
- missing the headers needed to compile Gnash.
- </para>
-
- <sect3 id="opengl">
- <title>OpenGL</title>
- <para>
- Gnash can use OpenGL for rendering the images. OpenGL is a 3D
- graphics package which supports hardware acceleration. You can
- get the free version of OpenGL at this link:
- <ulink type="http"
- url="http://www.mesa3d.org";>http://www.mesa3d.org</ulink>
- </para>
-
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libgl1-mesa-dev. For RPM or Yum based
- systems, install the libmesa-devel package.
- </para>
-
- </sect3>
-
- <sect3 id="agg">
- <title>AGG</title>
- <para>
- AGG is the AntiGrain low-level 2D graphics library that can be used
- instead of OpenGL. Unlike OpenGL, AGG does all rendering in software
- without requiring that much floating point calculation.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libagg-dev. For RPM or Yum based
- systems, install the agg-devel package.
- </para>
- </sect3>
-
- <sect3 id="gtkglext">
- <title>GtkGlExt</title>
- <para>
- GtkGlExt is an optional package used to link the gtk GUI to the
- opengl renderer.
- Gtk enables better integration with Firefox, as well as better
- event handling and higher level GUI constructs like menus and
- dialog boxes.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libgtkglext1-dev. For RPM or Yum based
- systems, install the gtkglext-devel package.
- </para>
- </sect3>
-
- <sect3 id="pango">
- <title>Pango</title>
- <para>
- Pango is a dependency of GtkGlExt, and is used for font handling.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libpango1.0-dev. For RPM or Yum based
- systems, install the pango-devel package.
- </para>
- </sect3>
-
- <sect3 id="atk">
- <title>Atk</title>
- <para>
- Atk is a dependency of GtkGlExt, and is used for accessibility
- support.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install atk-dev. For RPM or Yum based
- systems, install the atk-devel package.
- </para>
- </sect3>
-
- <sect3 id="cairo">
- <title>Cairo</title>
- <para>
- Cairo is a dependency of GtkGlExt, and is used for 2D rendering.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libcairo2-dev. For RPM or Yum based
- systems, install the cairo-devel package.
- </para>
- </sect3>
-
- <sect3 id="boost">
- <title>Boost</title>
- <para>
- Boost is a library of portable C++ classes and templates which
- layer on top of STL. Boost is used for thread and mutext
- handling.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libboost-thread-dev. For RPM or Yum based
- systems, install the libboost-devel package.
- </para>
- </sect3>
-
- <sect3 id="glib">
- <title>Glib</title>
- <para>
- Glib is a dependency of GtkGlExt, and is a collection of
- commonly used functions.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install glib-dev. For RPM or Yum based
- systems, install the glib-devel package.
- </para>
- </sect3>
-
- <sect3 id="gstreamer-dep">
- <title>Gstreamer</title>
- <para>
- Gstreamer is used for sound and video support. It is not
- needed to build this release. Currently only Gstreamer version
- 0.10 or higher can be used.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libgstreamer0.10-dev. For RPM or Yum based
- systems, install the gstreamer-devel package. Version 0.10 or
- greater will be required.
- </para>
- </sect3>
-
- <sect3 id="ffmpeg-dep">
- <title>FFMPEG</title>
- <para>
- FFMPEG can also be used for sound and video support. It is not
- needed to build this release, but is recommended if you want
- working sound.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libavformat-dev. For RPM or Yum based
- systems, install the libffmpeg-devel package. Version 0.10 or
- greater will be required.
- </para>
- </sect3>
-
- <sect3 id="sdl">
- <title>SDL</title>
- <para>
- The Simple DirectMedia Layer is a cross-platform multimedia
- library designed to provide low level access to audio,
- keyboard, mouse, joystick, 3D hardware via OpenGL, and 2D
- video framebuffer. You can get SDL from this link:
- <ulink type="http" url="http://www.libsdl.org";>
- http://www.libsdl.org</ulink>
- </para>
-
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libsdl1.2-dev. For RPM or Yum based
- systems, install the SDL-devel package.
- </para>
-
- </sect3>
-
- <sect3 id="png">
- <title>PNG</title>
- <para>
- <ulink type="http"
- url="http://www.libpng.org/pub/png/";>PNG</ulink> is a
- patent-free image format that is comparable to
- <emphasis>GIF</emphasis>.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libpng12-dev. For RPM or Yum based
- systems, install the libpng package.
- </para>
-
- </sect3>
-
- <sect3 id="jpeg">
- <title>JPEG</title>
- <para>
- <ulink type="http"
- url="http://www.ijg.org/";>JPEG</ulink> is a lossy image
- format, heavily used for images because of the smaller size of
- the file.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libjpeg62-dev. For RPM or Yum based
- systems, install the libjpeg package.
- </para>
-
- </sect3>
-
- <sect3 id="libxml2">
- <title>libxml2</title>
- <para>
- Libxml2 is the GNOME XML parser library. This is used when
- Gnash is configured with XML support. Libxml2 is used to
- parse any incoming messages when using the XML or XMLSocket
- ActionScript classes. You can get libxml2 from this link:
- <ulink type="http" url="http://xmlsoft.org";>http://xmlsoft.org</ulink>
- </para>
-
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libxml2-dev. For RPM or Yum based
- systems, install the libxml2-devel package.
- </para>
- </sect3>
-
- <sect3 id="ogg">
- <title>Ogg Vorbis</title>
- <para>
- <ulink type="http" url="http://www.vorbis.com/";>Ogg
- Vorbis</ulink> is a patent free audio format that is
- comparable (many people say better) to MP3. This is used by
- SDL to play Ogg files. You can get Ogg Vorbis from this
- link: <ulink type="http" url="http://www.vorbis.com/";>
- http://www.vorbis.com/</ulink>.
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libogg-dev. For RPM or Yum based
- systems, install the libogg package.
- </para>
-
- </sect3>
-
- <sect3 id="libmad">
- <title>libMAD</title>
-
- <para>
- libMad is a high-quality MPG decoder for audio files. All
- variations of the MP3 format are supported.
- <ulink type="http"
- url="http://www.underbit.com/products/mad/";>
- http://www.underbit.com/products/mad/</ulink>. You can get
- libMAD from this link: <ulink type="http"
- url="http://xmlsoft.org";>http://xmlsoft.org</ulink>
- </para>
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install libmad0-dev. For RPM or Yum based
- systems, install the libmad package.
- </para>
-
- </sect3>
-
- <sect3 id="mozilla">
- <title>Mozilla/Firefox</title>
-
- <para>
- The Mozilla development package is no longer needed to build
- the plugin. The required header files are now included in
- Gnash, so it builds without Mozilla or Firefox installed at
- all.
- </para>
-
- <para>
- To install a binary package using apt-get (on Debian based
- systems), install mozilla-dev or firefox-dev. For RPM or Yum
- based systems, install the mozilla-devel or firefox-devel
- package.
- </para>
- </sect3>
- </sect2>
-
- <sect2 id="docdepend">
- <title>Documentation Dependencies</title>
-
- <sect3 id="docbook">
- <title>Docbook</title>
-
- <para>
- <ulink type="http" url="http://docbook.sourceforge.net/";>
- Docbook</ulink> is an industry standard XML format for technical
- documentation. It is used by many projects, as there are free
- software implementations of the Docbook style-sheets and
- tools. It is used by both the <ulink type="http"
- url="http://www.gnome.org";>GNOME</ulink> project, and the
- <ulink type="http" url="http://www.tldp.org/";>Linux
- Documentation Project</ulink>. It is customizable by using
- style-sheets for each output device. Default style-sheets are
- included for a variety of print formats, like <emphasis>PDF</emphasis>
- and <emphasis>HTML</emphasis>.
- </para>
- <para>
- You can get Docbook from this link:
- <ulink type="http"
-
url="http://sourceforge.net/project/showfiles.php?group_id=21935#files";>
-
http://sourceforge.net/project/showfiles.php?group_id=21935#files</ulink>.
- </para>
- <para>
- To install a binary packages using apt-get (on Debian based
- systems), install the docbook, docbook-xsl, docbook-xml,
- docbook-dsssl,and docbook-utils packages. For RPM or Yum based
- systems, install the docbook, docbook-style-xsl,
- docbook-style-dsssl, and docbook-utils packages.
- </para>
- </sect3>
-
- <sect3 id="docbook2x">
- <title>DocBook2X</title>
-
- <para>
- DocBook2X is a software package that converts DocBook
- documents into the traditional Unix man page format and the
- GNU Texinfo format. It supports tables for man pages,
- internationalization, and easy customization of the
- output using XSLT. This package is used to convert the Gnash
- documentation into HTML and <ulink type="http"
- url="http://www.gnu.org/software/texinfo/";>
- Texinfo</ulink> formats. Texinfo can later be converted to
- standard GNU <emphasis>info</emphasis> pages.
- </para>
- <para>
- You can get DocBook2X from this link:
- <ulink type="http" url="http://docbook2x.sourceforge.net/";>
- http://docbook2x.sourceforge.net/</ulink>. Texinfo is
- available at this link:
- <ulink type="http" url="http://ftp.gnu.org/gnu/texinfo/";>
- http://ftp.gnu.org/gnu/texinfo/</ulink>.
- </para>
- <para>
- To install a binary package of DocBook2X using apt-get (on
- Debian based systems), install docbook2x. For RPM or Yum based
- systems, install the docbook2x package.
- To install a binary package of DocBook2X using apt-get (on
- Debian based systems), install texinfo. For RPM or Yum based
- systems, install the texinfo package.
- </para>
- </sect3>
-
- <sect3 id="fop">
- <title>FOP</title>
-
- <para>
- FOP (Formatting Objects Processor) is the world's first print
- formatter driven by XSL formatting objects (XSL-FO) and the
- world's first output independent formatter. It is a
- <emphasis>Java</emphasis> application that reads a formatting object
- (FO) tree and renders the resulting pages to a specified
- output. Output formats currently supported include PDF, PCL,
- PS, SVG, XML, Print, AWT, MIF and Text. The default output
- target is PDF.
- </para>
-
- <para>
- You can get <emphasis>fop</emphasis> from this link:
- <ulink type="http" url="http://xmlgraphics.apache.org/fop/";>
- http://xmlgraphics.apache.org/fop/</ulink>. Presently only
- <emphasis>fop version 0.20.5</emphasis> works with current DocBook
- tools.
- </para>
- </sect3>
-
- <sect3 id="java">
- <title>Java</title>
-
- <para>
- The <emphasis>fop</emphasis> processor is a <emphasis>Java</emphasis>
- application, so it needs a Java runtime to work. This is
- installed on many platforms by default, but unfortunately
- <emphasis>fop</emphasis> doesn't work with the <ulink type="http"
- url="http://gcc.gnu.org/java/";>GCJ</ulink> runtime. There is
- apparently work being done on FOP to make it usable, but for
- now, this means installing <ulink type="http"
- url="http://java.sun.com/";>Sun Java</ulink>.
- </para>
-
- <para>
- In addition to the default <emphasis>j2re</emphasis> package, you also
- need to install <emphasis>JAI</emphasis>, the Java Advanced Imaging
- library. You can get <emphasis>JAI</emphasis> from <ulink type="http"
- url="http://java.sun.com/products/java-media/jai/iio.html";>
- this link</ulink>. <emphasis>JAI</emphasis> is not required, and the
- <emphasis>PDF</emphasis> file will be generated. It will just be
- missing all the graphics.
- </para>
- <para>
- <emphasis>Fop</emphasis> also requires an environment variable to be
- set. This is JAVA_HOME. This needs to point to the top
- directory where your <emphasis>Sun j2re</emphasis> is installed. If
- you have any other problems with your Java installation, you
- can also try adding the <emphasis>Sun j2re</emphasis> path to the
- <emphasis>CLASSPATH</emphasis> environment variable.
- </para>
- </sect3>
-
- </sect2>
-
- <sect2 id="configure">
- <title>Configuring The Code</title>
-
- <para>
- Gnash uses GNU Autoconf (<ulink type="http"
- url="http://www.gnu.org/software/autoconf/";>
- http://www.gnu.org/software/autoconf</ulink>) for
- configuration. All the standard configure options apply.
- </para>
-
- <para>
- The <emphasis>configure</emphasis> script is not included in the CVS
- sources. It must be produced by running the
- <emphasis>./autogen.sh</emphasis> script in the top level source
- directory. This script requires you have <emphasis>autoconf</emphasis>,
- <emphasis>automake</emphasis>, and <emphasis>libtool</emphasis>
installed.
- After building this script, you can configure Gnash by running it from
- the source directory like this: <emphasis>./configure</emphasis>, or from
- another directory by specifying the full path to configure.
- </para>
-
- <para>
- By default, `make install' will install all the files in
- `/usr/local/bin', `/usr/local/lib' etc. You can specify
- an installation prefix other than `/usr/local' using `--prefix',
- for instance `--prefix=$HOME'.
- </para>
-
- <para>
- Occasionally the default paths for a development package
- aren't correct. There are several options which can be used
- to adjust these paths to your own setup. By default, Gnash
- will look in all the standard places for these tools.
- </para>
-
- <para>
- A configure script can support many options, but they fall
- into two main types. The first type are options to enable or
- disable features. The second type is used to specify custom
- paths for development packages which can't be found by the
- default searching and testing.
- </para>
-
- <sect3 id="confoptions">
- <title>Configure Options</title>
-
- <para>
- Some switches can be used at configuration time to enable or disable
- various features of Gnash. The major configuration options are:
- </para>
- <para>
- GUI: see --enable-gui (default is GTK)
- </para>
- <para>
- Renderer: see --enable-renderer (default is AGG)
- </para>
- <para>
- Media handler: see --enable-media (default is FFMPEG thru SDL sound)
- </para>
-
- <para>
- The smallest working standalone version is obtained with:
- <programlisting>
- ./configure --disable-debugger --disable-cygnal --disable-docbook \
- --disable-plugin --enable-media=mad --enable-gui=sdl
- </programlisting>
- </para>
-
-
- <varlistentry>
- <term>--disable-debugger</term>
- <listitem>
- <para>
- Disable support for the Flash debugger. The debugger is
- mainly of interest to Flash developers.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-dmalloc</term>
- <listitem>
- <para>
- Enable support for the DMalloc memory debugging tool.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-dom</term>
- <listitem>
- <para>
- When using the XML library, parse the messages using a
- DOM based parser. This is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-embedded</term>
- <listitem>
- <para>
- Link to Qt-embedded, don't use X. This is only used by
- Klash.
- </para>
- </listitem>
- </varlistentry>
-
- <variablelist>
- <varlistentry>
- <term>--disable-fork</term>
- <listitem>
- <para>
- Disable the plugin forking the standalone player, and
- using a thread for the player instead. Currently forking
- the standalone player will give you the best results.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-ghelp</term>
- <listitem>
- <para>
- Enable support for the GNOME help system.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--disable-glext</term>
- <listitem>
- <para>
- Disable using GtkGlExt, which forces the use of SDL
- instead. By default if the GtkGL extension for Gtk is found
- by configure, the GTK enabled GUI is built.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-gui=gtk|sdl|kde|fltk|fb</term>
- <listitem>
- <para>
- Select the Graphic User Interface to use (just one at a time
please).
- </para>
- <varlistentry>
- <term>GTK</term>
- <listitem>
- The GTK+ toolkit, which is the default GUI.
- Said to interwork particularly well with firefox.
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SDL</term>
- <listitem>
- Simple DirectMedia Layer, a simple and portable GUI.
- Its sound facilities are used when --enable-media=ffmpeg|mad
- regoardless of whether it is also in charge of the GUI.
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>KDE</term>
- <listitem>
- An interface adapted to the KDE Desktop Environment.
- This must be selected when building the Konqueror plugin
- "klash". Furthermore, the only renderer that currently
- works with KDE is opengl.
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>FLTK</term>
- <listitem>
- Fast Light ToolKit, low on resource usage.
- Since all build using fltk are now broken, we declare it
- "for developers".
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>FB</term>
- <listitem>
- The Linux Frame Buffer, also known as /dev/fb0.
- AGG is the only renderer that can currently be used
- with the framebuffer GUI.
- </listitem>
- </varlistentry>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-i810-lod-bias</term>
- <listitem>
- <para>
- Enable fix for Intel 810 LOD bias problem. Older versions
- of libMesa on the Intel i810 or i815 graphics processor
- need this flag or Gnash will core dump. This has been
- fixed in newer versions (summer 2005) of libMesa.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--disable-klash</term>
- <listitem>
- <para>
- Disable support for Konqueror plugin. If
- <emphasis>--enable--plugin</emphasis> is specified, and
- support for building KDE programs is found, Klash is
- built by default. This option limits the plugin to only
- the Mozilla/Firefox one.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-libsuffix</term>
- <listitem>
- <para>
- /lib directory suffix (64,32,none=default). This is only
- used by Klash.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-mac</term>
- <listitem>
- <para>
- Link to Qt/Mac (don't use X). This is only used by
- Klash.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-media=ffmpeg|mad|gst</term>
- <listitem>
- <para>
- Select the specified media decoder and sound engine.
- FFMPEG and MAD use the SDL sound engine; GST uses its own.
- Mixing this with --enable-sound=gst is invalid. Using
- <emphasis>ffmpeg</emphasis> is the default decoder.
- </para>
- <para>
- You should only select one media decoder.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-plugin</term>
- <listitem>
- <para>
- Enable building the plugin. By default the
- Mozilla Firefox plugin won't be built, even if all the required
- files are found by configure. Configure
- <emphasis>--with-plugindir=</emphasis> to specify where the
- plugin should be installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-qtopia</term>
- <listitem>
- <para>
- Link to Qt-embedded, link to the Qtopia
- Environment. This is only used by Klash.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-renderer=opengl|cairo|agg</term>
- <listitem>
- <para>
- Enable support for the a graphics backend. Currently
- only <emphasis>opengl</emphasis> and
- <emphasis>agg</emphasis> work sufficiently. OpenGL is
- used when you have hardware accelerated graphics. AGG is
- used when you don't have hardware accelerated
- graphics. Typically most desktop machines have OpenGL
- support, and most embedded systems don't. OpenGL is the
- default when building Gnash, though the quality of AGG's
- rendering is currently superior to OpenGL.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-sdk-install</term>
- <listitem>
- <para>
- Enable installing the libraries and headers as an SDK.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--disable-shared</term>
- <listitem>
- <para>
- Enable installing the shared libraries and headers.
- Note that the extensions mechanism may not work if shared
- libraries are disabled.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-strict</term>
- <listitem>
- <para>
- Turn on tons of GCC compiler warnings. By default only
- <emphasis>-Wall</emphasis> is used with GCC.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-testing</term>
- <listitem>
- <para>
- Enable testing-specific methods.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-xmlreader</term>
- <listitem>
- <para>
- When using the XML library, parse the messages using a
- SAX based parser.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </sect3>
-
- <sect3 id="confpath">
- <title>Specifying A Custom Path</title>
-
- <para>
- This set of options typically use a <emphasis>--with-[name]</emphasis>
- naming convention. A Prefix can often be supplied, which is
- the top level directory which can be used to look for the other
- sub directories. Most options of this type have two
- variations, one to specify a path to the header files, and
- another to specify a path to the libraries. This lets you
- override the default paths <emphasis>configure</emphasis> finds, or
- specify your own paths.
- </para>
-
- <para>
- By default, none of the options should be required unless you
- want Gnash to use a specific version of a development package,
- or the configure test for Gnash fails to find the
- component. There are a lot of options, but Gnash has a lot of
- dependencies. If you find a configure test is failing on your
- machine, please <ulink type="http"
- url="https://savannah.gnu.org/bugs/?group=gnash";>submit a patch</ulink>
- or <ulink type="http"
- url="https://savannah.gnu.org/bugs/?group=gnash";>file a bug
- report</ulink>.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>--x-includes=DIR</term>
- <listitem>
- <para>
- X include files are in DIR.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--x-libraries=DIR</term>
- <listitem>
- <para>
- X library files are in DIR.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml=PFX</term>
- <listitem>
- <para>
- Prefix to where libxml is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-libraries=DIR</term>
- <listitem>
- <para>
- Directory where libxml library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-includes=DIR</term>
- <listitem>
- <para>
- Directory where libxml header files are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-docbook=DIR</term>
- <listitem>
- <para>
- Directory where the DocBook style-sheets are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-sdl-prefix=PFX</term>
- <listitem>
- <para>
- Prefix where SDL is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-incl</term>
- <listitem>
- <para>
- Directory where zlib header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-lib</term>
- <listitem>
- <para>
- Directory where zlib library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-incl</term>
- <listitem>
- <para>
- Directory where jpeg header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-lib</term>
- <listitem>
- <para>
- Directory where jpeg library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-incl</term>
- <listitem>
- <para>
- Directory where png header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-lib</term>
- <listitem>
- <para>
- Directory where png library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-dir</term>
- <listitem>
- <para>
- Directory where QT is installed. This is only used by
- the Klash plugin.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-includes</term>
- <listitem>
- <para>
- Directory where the QT header files are installed. This
- is only used by the Klash plugin.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-libraries</term>
- <listitem>
- <para>
- Directory where the QT libraries are installed. This is
- only used by the Klash plugin.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-plugindir</term>
- <listitem>
- <para>
- This is the directory to install the Firefox plugin in.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ming</term>
- <listitem>
- <para>
- Ming is used to build test cases, but not by the Gnash
- player itself.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-mad_incl</term>
- <listitem>
- <para>
- Directory where libmad header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-mad_lib</term>
- <listitem>
- <para>
- Directory where libmad library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ogg_incl</term>
- <listitem>
- <para>
- Directory where the libogg headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ogg_lib</term>
- <listitem>
- <para>
- Directory where the libogg library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gstreamer-incl</term>
- <listitem>
- <para>
- Directory where the Gstreamer headers are
- installed. Gstreamer version 0.10 or greater must be used.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gstreamer-lib</term>
- <listitem>
- <para>
- Directory where the Gstreamer library is
- installed. Gstreamer version 0.10 or greater must be used.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-opengl-includes</term>
- <listitem>
- <para>
- Directory where OpenGL (libMesa) headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-opengl-lib</term>
- <listitem>
- <para>
- Directory where the OpenGL (libMesa) library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glext-incl</term>
- <listitem>
- <para>
- Directory where GtkGlExt headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glext-lib</term>
- <listitem>
- <para>
- Directory where the GtkGlExt library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gtk2-incl</term>
- <listitem>
- <para>
- Directory where the Gtk2 headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gtk2-lib</term>
- <listitem>
- <para>
- Directory where the Gtk2 library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-cairo_incl</term>
- <listitem>
- <para>
- Directory where the Cairo headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-cairo-lib</term>
- <listitem>
- <para>
- Directory where the Cairo library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glib-incl</term>
- <listitem>
- <para>
- Directory where the Glib headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glib-lib</term>
- <listitem>
- <para>
- Directory where the Glib library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pango-incl</term>
- <listitem>
- <para>
- Directory where the Pango headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pango-lib</term>
- <listitem>
- <para>
- Directory where the Pango library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-atk-incl</term>
- <listitem>
- <para>
- Directory where the ATK headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-atk-lib</term>
- <listitem>
- <para>
- Directory where the ATK library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pthread-incl</term>
- <listitem>
- <para>
- Directory where the Pthread headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pthread-lib</term>
- <listitem>
- <para>
- Directory where the Pthread library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-agg-incl</term>
- <listitem>
- <para>
- Directory where the AGG (Antigrain) headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-agg-lib</term>
- <listitem>
- <para>
- Directory where the AGG (Antigrain) library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ffmpeg-incl</term>
- <listitem>
- <para>
- Directory where the FFMPEG headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ffmpeg-lib</term>
- <listitem>
- <para>
- Directory where the FFMPEG library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-boost-incl</term>
- <listitem>
- <para>
- Directory where the Boost headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-boost-lib</term>
- <listitem>
- <para>
- Directory where the Boost library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-curl-incl</term>
- <listitem>
- <para>
- Directory where the libCurl headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-curl-lib</term>
- <listitem>
- <para>
- Directory where the libCurl library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </sect3>
-
- <sect3 id="envvars">
- <title>Influential environment variables</title>
-
- <para>
- You can control other flags used for compiling using
- environment variables. Set these variables before configuring,
- and they will be used by the configure process instead of the
- default values.
- </para>
-
- <variablelist>
-
- <varlistentry>
- <term>CPPFLAGS</term>
- <listitem>
- <para>
- C/C++ preprocessor flags, e.g. -I[headers directory] if you have
- headers in a nonstandard directory.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CXX</term>
- <listitem>
- <para>
- C++ compiler command.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CXXFLAGS</term>
- <listitem>
- <para>
- C++ compiler flags.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>LDFLAGS</term>
- <listitem>
- <para>
- linker flags, e.g. -L[library directory] if you have libraries in
- a non-standard directory.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
-
- <sect3 id="crossconf">
- <title>Cross Compiling And Configuration</title>
-
- <para>
- To cross configure and compile Gnash, you first need to build
- a target system on your workstation. This includes cross
- compilers for the target architecture, and typically some
- system headers. You will also need <emphasis>libxml2</emphasis>,
- <emphasis>libpng</emphasis>, <emphasis>libjpeg</emphasis>,
- <emphasis>sdl</emphasis>, <emphasis>opengl</emphasis>, and
- <emphasis>ogg</emphasis> development packages built for the target
- system.
- </para>
-
- <para>
- If you need to build up a target system from scratch, there is
- a good document and shell script at this web site: <ulink
- type="http"
- url="http://frank.harvard.edu/~coldwell/toolchain/";>
- http://frank.harvard.edu/~coldwell/toolchain/</ulink>.
- </para>
-
- <para>
- After I built up an ARM system in /usr/arm using the shell
- script from this web site, I then cross compiled all the
- other libraries I needed. The fun part is trying to get
- libMesa to cross compile, because it's not really set up for
- that.
- </para>
-
- <para>
- So to build for an ARM based system on an x86 based systems,
- configure like this:
- </para>
-
- <programlisting>
- ../../gnash/configure --build=i686-pc-linux-gnu --host=arm-linux
--prefix=/usr/local/arm/oe --disable-plugin --enable-renderer=agg
--disable-shared
- </programlisting>
-
- <para>
- The important options here are the ones that specify the
- architectures for the build.
-
- <variablelist>
- <varlistentry>
- <term>--target</term>
- <listitem>
- <para>
- The target architecture. This is the architecture the
- final executables are supposed to run on.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>--host</term>
- <listitem>
- <para>
- The host architecture. This is the architecture the
- executables are supposed to run on. This is usually the
- same as <emphasis>--target</emphasis> except when building a
- compiler as a
- Canadian Cross. This is when you build a cross
- compiler on a Unix machine, that runs on a
- <emphasis>win32</emphasis> machine, producing code for yet
- a third architecture, like the <emphasis>ARM</emphasis>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>--build</term>
- <listitem>
- <para>
- This is the system this build is running on.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
-
- </sect3>
-
- </sect2>
-
- <sect2 id="building">
- <title>Building Gnash</title>
-
- <para>
- After managing to configure Gnash, building the code is
- simple. Gnash is built using <emphasis>GNU make</emphasis>.
- </para>
-
- <sect3 id="compile">
- <title>Compiling The Code</title>
-
- <para>
- After configuring, typing <emphasis>make</emphasis> will compile the
- code. No options are necessary. If desired, you can redefine
- the variables used by <emphasis>make</emphasis> on the command line
- when invoking the program. The few flags of interest are
- <emphasis>CFLAGS</emphasis> and <emphasis>CXXFLAGS</emphasis>, often
used to
- turn on debugging or turn off optimizing. Invoking make as in
- this example would build all the code with debugging turned
- on, and optimizing turned off. The default values for both of
- these variables is <emphasis>-O2 -g</emphasis>.
-
- <programlisting>
- make CFLAGS=-g CXXFLAGS=-g
- </programlisting>
- </para>
-
- <para>
- If the compilation ends with an error, check the output of
- configure and make sure nothing required to build Gnash is
- missing.
- </para>
- </sect3>
-
- <sect3 id="processdoc">
- <title>Processing The Documentation</title>
-
- <para>
- By default, the documentation isn't built at all. It isn't
- even built when typing <emphasis>make install</emphasis> from the top
- level build directory. It's only built when specified with a
- specific target in the generated <emphasis>Makefile</emphasis> in the
- <emphasis>doc/C/</emphasis> sub-directory. All the documents are built
in
- this directory when executing a <emphasis>make install</emphasis>.
- </para>
-
- <para>
- There is a target for each output format, <emphasis>make
- html</emphasis>, <emphasis>make pdf</emphasis>, <emphasis>make
info</emphasis>,
- and <emphasis>make man</emphasis>. A higher level target, <emphasis>make
- alldocs</emphasis>, builds the four main formats for the
- documentation.
- </para>
-
- <para>
- Gnash also has support to use <ulink type="http"
- url="http://www.stack.nl/~dimitri/doxygen/index.html";>
- Doxygen</ulink> to produce <emphasis>HTML</emphasis> pages documenting
- the internals of Gnash. While this is not necessarily
- internals documentation, it does give very useful information
- about all the files, the classes, a cross reference, and other
- data.
- </para>
- <para>
- You need to have Doxygen installed to produce these documents. If
- you do have it installed, typing <emphasis>make apidoc</emphasis> in
- the <emphasis>doc</emphasis> directory will make these documents under a
- sub directory of <emphasis>apidoc/html</emphasis>
- </para>
- </sect3>
-
- <sect3 id="runtests">
- <title>Running the Tests</title>
-
-<!--
- <para>
- If a test fails, please report it by following the
- <link linkend="bugreport">instructions for reporting a bug</link>.
- </para>
--->
-
- <sect4 id="dejagnu">
- <title>Using DejaGnu</title>
- <para>
- FIXME: Add a section on running tests without DejaGnu.
- The easiest way to run Gnash's test suite is to install
- <emphasis><ulink type="http"
- url="http://www.gnu.org/software/dejagnu";>DejaGnu</ulink></emphasis>.
- After installing DejaGnu, run:
- <programlisting>
- make check
- </programlisting>
- </para>
-
- <sect5 id="testing_verbosity">
- <title>Increasing Verbosity</title>
- <para>
- If you encounter a problem with a test, increasing the
- verbosity may make the issue easier to spot.
- Additional details are visible when
- <emphasis>RUNTESTFLAGS</emphasis> are used to add the
- <emphasis>verbose</emphasis> and <emphasis>all</emphasis> options.
- Verbose prints more information about the testing process, while
- all includes details on passing tests.
- <programlisting>
- make check RUNTESTFLAGS="-v -a"
- </programlisting>
- </para>
- </sect5>
-
- <sect5 id="running_some_tests">
- <title>Running Some Tests</title>
- <para>
- It is possible to run just a particular test, or
- subdirectory of tests, by specifying the directory or
- compiled test file.
- </para>
- <para>
- Some tests rely on <emphasis>testsuite/Dejagnu.swf</emphasis>,
- which in turn relies on <emphasis>Ming</emphasis>.
- This file is created when you run 'make check' for the entire
- testsuite, and can also be created on demand:
- <programlisting>
- make -C testsuite Dejagnu.swf
- </programlisting>
- </para>
- <para>
- In this example, the 'clip_as_button2' test is compiled and
- run:
- <programlisting>
- make -C testsuite/samples clip_as_button2-TestRunner
- cd testsuite/samples && ./clip_as_button2-TestRunner
- </programlisting>
- This would create and run all the tests in the directory
- 'movies.all':
- <programlisting>
- make -C testsuite/movies.all check
- </programlisting>
- </para>
- </sect5>
-
- </sect4>
- <sect4 id="manually">
- <title>Running The Tests Manually</title>
-
- <para>
- You may also run test cases by hand, which can be useful if you
- want to see all the debugging output from the test case. Often
- the messages which come from deep within Gnash are most useful for
- development.
- </para>
-
- <para>
- The first step is to compile the test case, which can be done
- with 'make XML-v#.swf' where the '#' is replaced with the
- <emphasis>target</emphasis> SWF version or versions.
- For example:
- <programlisting>
- make XML-v{5,6,7,8}.swf
- </programlisting>
- </para>
-
- <sect5 id="manual_compiled_tests">
- <title>Movie tests</title>
- <para>
- This creates a Flash movie version of the test case, which
- can be run with a standalone Flash player. For instance,
- the target for SWF version 6 could be run with Gnash:
- <programlisting>
- gnash -v XML-v6.swf
- </programlisting>
- </para>
- </sect5>
-
- <sect5 id="manual_actionscript_tests">
- <title>ActionScript Unit Tests</title>
- <para>
- Unit tests for ActionScript classes in 'testsuite/actionscript.all'
- are run without a graphical display:
- <programlisting>
- gprocessor -v XML-v6.swf
- </programlisting>
- </para>
- </sect5>
- </sect4>
- </sect3>
- </sect2>
-
- <sect2 id="install">
- <title>Installation</title>
-
- <para>
- Gnash installs its libraries so they can be found in the
- runtime path for the Gnash executable. Unless the --prefix
- option is used at configuration time, the libraries get
- installed in /usr/local/lib. If you install Gnash in a
- non-standard location, you have to specify this runtime path
- by one of two means.
- </para>
-
-
- <para>
- The traditional way that works on all Unix platforms is to set
- the LD_LIBRARY_PATH environment variable to $prefix/lib. You
- can have multiple paths in this variable as long as they are
- seperated by a colon ":" character.
- </para>
-
- <para>
- For GNU/Linux systems, the custom path to the libraries can be
- added to the /etc/ld.so.conf file. After adding the custom
- path, then run (as root) the <emphasis>ldconfig</emphasis> command to
- update the runtime cache.
- </para>
-
- <sect3 id="codeinstall">
- <title>What Code Gets Installed and Where</title>
-
- <para>
- Several libraries get installed, as well as the three
- executables. All the libraries, <emphasis>libbase, libgeometry,
- libgbackend, libserver, and libmozsdk</emphasis> get installed in the
- directory pointed to by <emphasis>$prefix</emphasis>. This variable is
- set by the <emphasis>--prefix</emphasis> option at configure time, and
- if not specified, it defaults to <emphasis>/usr/local</emphasis>. All
- the libraries get installed in <emphasis>$prefix/lib</emphasis> where
- most packages also install their libraries.
- </para>
- <para>
- The plugin gets installed in the plugins directory of the
- version of the<emphasis>Firefox</emphasis> or
<emphasis>Mozilla</emphasis> you
- have the development packaged installed for. For builds from
- Mozilla CVS, the default installation directory is
- <emphasis>/usr/local/lib/firefox-[version
- number]/plugins/</emphasis>. The default system directory used
- when installing packages is
- <emphasis>/usr/lib/mozilla/plugins</emphasis>. Note that you have to be
- <emphasis>root</emphasis> to install files in a system directory. For
- some reason when the plugin is installed in the users
- <emphasis>$HOME/.mozilla/plugins</emphasis> or
- <emphasis>$HOME/.firefox/plugins</emphasis> directory, unresolved
- symbols from deep within Firefox appear.
- </para>
-
- <para>
- The executables get installed in a <emphasis>bin</emphasis> directory of
- the directory specified by <emphasis>$prefix</emphasis>. Once again,
- this path defaults to <emphasis>/usr/local/bin</emphasis> if a special
- prefix wasn't configured in.
- </para>
-
- <para>
- If using a single file-system <emphasis>NFS</emphasis>mounted to
- multiple platforms, you can specify an additional option,
- <emphasis>--exec-prefix</emphasis>. This is where all the platform
- dependent executables and libraries can get installed.
- </para>
- </sect3>
-
- <sect3 id="docinstall">
- <title>What Documentation Gets Installed and Where</title>
-
- <para>
- The documentation only installs when GNOME Help support is
- enabled by using <emphasis>--enable-ghelp</emphasis>. Because GNOME
- help files get installed in a system directory when building
- from source, you need to either change the permissions on the
- destination directory, or do the install as <emphasis>root</emphasis>.
- The default directory for GNOME Help files is:
- <emphasis>/usr/local/share/gnash/doc/gnash/C/</emphasis>.
- </para>
- <para>
- A configuration file in the Gnash source tree,
- <emphasis>doc/C/gnash.omf</emphasis> is used to specify under which
- menu item Gnash is listed in the GNOME Help system.
- </para>
+</para>
+<para>
+ Presently, &app; source is about 16 MB when extracted and
+ <link linkend="configure">configured</link>. <link
+ linkend="compile">Compilation</link> requires about 100 MB of
+ harddrive space.
+ A minimum of 128 MB of physical RAM is recommended for compiling.
+</para>
- </sect3>
- </sect2>
-</sect1>
Index: testing_dependencies.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/refmanual/testing_dependencies.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- testing_dependencies.xml 1 Mar 2008 16:59:31 -0000 1.1
+++ testing_dependencies.xml 1 Mar 2008 19:47:10 -0000 1.2
@@ -1,11 +1,12 @@
-<title>Testing Dependencies</title>
+<sect1 id="testdep">
+ <title>Testing Dependencies</title>
-<para>
+ <para>
&app; tries to run as many tests as possible, but will
simply skip tests if the tools to run them are unavailable.
-</para>
+ </para>
-<table frame='all' id="testdeps">
+ <table frame='all' id="testdeps">
<title>Testing Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
@@ -15,6 +16,7 @@
<colspec colname='explanation'/>
<colspec colname='apt'/>
<colspec colname='rpm'/>
+ <colspec colname='pkg'/>
<thead>
<row>
@@ -25,6 +27,7 @@
<entry>Explanation</entry>
<entry>apt-get package</entry>
<entry>RPM/Yum package</entry>
+ <entry>BSD package</entry>
</row>
</thead>
@@ -41,12 +44,13 @@
</entry>
<entry>No distribution packages are available.</entry>
<entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
<entry>Mtasc</entry>
<entry>Optional</entry>
- <entry></entry>
+ <entry>1.12 or higher</entry>
<entry>
Mtasc is an ActionScript compiler.
</entry>
@@ -55,26 +59,58 @@
</entry>
<entry><filename>mtasc</filename></entry>
<entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
+ </row>
+
+ <row>
+ <entry>swfc</entry>
+ <entry>Optional</entry>
+ <entry>part of swftools 0.8.1</entry>
+ <entry>
+ Swfc a swf decompiler.
+ </entry>
+ <entry>
+ Swfc is used in some testcases.
+ </entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
- <entry>swfdec</entry>
+ <entry>swfmill</entry>
<entry>Optional</entry>
- <entry></entry>
+ <entry> 0.2.12</entry>
<entry>
- Swfdec is a Flash player.
+ Swfmill is an XML-based SWF (Shockwave Flash) processing tool.
</entry>
<entry>
- Swfdec is used in some testcases.
+ Swfmill is used in some testcases.
</entry>
<entry>No distribution packages are available.</entry>
- <entry>Unofficial package <filename>swfdec</filename></entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
+ </row>
+
+ <row>
+ <entry>Python</entry>
+ <entry>Optional</entry>
+ <entry>2.4 or higher</entry>
+ <entry>
+ Python is a scripting language.
+ </entry>
+ <entry>
+ Python is used by part of the testing framework.
+ </entry>
+ <entry><filename>python</filename></entry>
+ <entry><filename>python</filename></entry>
+ <entry><filename>python</filename></entry>
</row>
<row>
<entry>DejaGnu</entry>
<entry>Optional</entry>
- <entry></entry>
+ <entry>1.4 or higher</entry>
<entry>
DejaGnu is a testing framework.
</entry>
@@ -84,8 +120,10 @@
</entry>
<entry><filename>dejagnu</filename></entry>
<entry><filename>dejagnu</filename></entry>
+ <entry><filename>dejagnu</filename></entry>
</row>
</tbody>
</tgroup>
-</table>
+ </table>
+</sect1>
\ No newline at end of file