[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc/C/usermanual installation/building.xm...
|
From: |
Rob Savoye |
|
Subject: |
[Gnash-commit] gnash/doc/C/usermanual installation/building.xm... |
|
Date: |
Tue, 26 Feb 2008 15:52:20 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Rob Savoye <rsavoye> 08/02/26 15:52:20
Removed files:
doc/C/usermanual/installation: building.xml
code_dependencies.xml
configuration.xml
cross_compiling.xml
custompath_configuration.xml
documentation_dependencies.xml
feature_configuration.xml
install.xml packagemanager.xml
sources.xml
testing_dependencies.xml
doc/C/usermanual/usage: gnashrc.xml
Log message:
Remove old unfinoshed versions.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/building.xml?cvsroot=gnash&r1=1.4&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/code_dependencies.xml?cvsroot=gnash&r1=1.6&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/configuration.xml?cvsroot=gnash&r1=1.7&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/cross_compiling.xml?cvsroot=gnash&r1=1.4&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/custompath_configuration.xml?cvsroot=gnash&r1=1.9&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/documentation_dependencies.xml?cvsroot=gnash&r1=1.4&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/feature_configuration.xml?cvsroot=gnash&r1=1.17&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/install.xml?cvsroot=gnash&r1=1.6&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/packagemanager.xml?cvsroot=gnash&r1=1.1&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/sources.xml?cvsroot=gnash&r1=1.5&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/testing_dependencies.xml?cvsroot=gnash&r1=1.3&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/usage/gnashrc.xml?cvsroot=gnash&r1=1.18&r2=0
Patches:
Index: installation/building.xml
===================================================================
RCS file: installation/building.xml
diff -N installation/building.xml
--- installation/building.xml 16 Aug 2007 14:27:35 -0000 1.4
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,201 +0,0 @@
-<title>Building from Source</title>
-
-<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>
-
-<sect2 id="compile">
- <title>Compiling the Code</title>
-
- <para>
- The most basic way to compile code is simply:
- <programlisting>
- make
- </programlisting>
- If the compilation ends with an error, check the output of
- <emphasis>configure</emphasis> and ensure that you are not missing
- any required prerequisites. The output of <command>make</command> can be
verbose; you may wish to pipe the output to a file.
- </para>
-
- <para>
- The variables used by <emphasis>make</emphasis> can be redefined when
- the program is invoked, if you desire it. The most interesting flags
- are <emphasis>CFLAGS</emphasis> and <emphasis>CXXFLAGS</emphasis>,
- which are often used to enable debugging or turn of optimization.
- 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>
- In the following example, debugging is enabled and optimization is
- disabled:
-</para>
-<programlisting>make CFLAGS=-g CXXFLAGS=-g</programlisting>
-</sect2>
-
-<sect2 id="processdoc">
- <title>Creating the Documentation</title>
-
- <para>
- By default, documentation is not built when you
- <link linkend="install">install</link> &app;. This is because
- there are a number of <link linkend="docdepend">dependencies
- for the documentation</link>. Documentation is built when it
- is specified with a specific target in the generated
- <command>Makefile</command> in the <filename>doc/C</filename>
- sub-directory. If you type <command>make install</command> in
- this directory, all documents will be built.
- </para>
-
- <para>
- You must specify a target output format when you wish to create
- documentation. The available output formats are: <command>html</command>,
- <command>pdf</command>, <command>info</command>,
- <command>man</command>, and <command>alldocs</command>.
- It is also possible to output <command>GNOME help</command> if
- the <link linkend="features">configure option</link>
- <option>--enable-ghelp</option> was used.
- The <command>alldocs</command> target will build all output formats
- except <emphasis>GNOME help</emphasis>.
- For example, to create HTML output, type:
- <programlisting>
- make html
- </programlisting>
- </para>
-
- <para>
- &app; also uses <ulink
url="http://www.stack.nl/~dimitri/doxygen/index.html";
- type="http">Doxygen</ulink> to produce <emphasis>HTML</emphasis>
- documentation of &app; internals. You must have Doxygen installed
- to produce this documentation, which is built from the
- <filename>doc</filename> directory with the command (documents
- will be placed in the subdirectory <filename>apidoc/html</filename>):
- <programlisting>
- make apidoc
- </programlisting>
- </para>
-</sect2>
-
-
-<sect2 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>.
- </para>
-
- <sect3 id="dejagnu">
- <title>Using DejaGnu</title>
-
- <para>
- <!--
- TODO: Add a section on running tests without DejaGnu.
- -->
- The easiest way to run &app;'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>
-
- <sect4 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.
- The <option>verbose</option> option prints more information about the
testing process, while
- the <option>all</option> option includes details on passing tests.
- <programlisting>
- make check RUNTESTFLAGS="-v -a"
- </programlisting>
- </para>
- </sect4>
-
- <sect4 id="running_some_tests">
- <title>Running Some Tests</title>
- <para>
- It is possible to run just a single test, or
- a 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 <command>make check</command> for
the entire
- testsuite, and can also be created on demand:
- <programlisting>
- make -C testsuite Dejagnu.swf
- </programlisting>
- </para>
- <para>
- In this example, the <command>clip_as_button2</command> test is
compiled and
- run:
- <programlisting>
- make -C testsuite/samples clip_as_button2-TestRunner
- cd testsuite/samples && ./clip_as_button2-TestRunner
- </programlisting>
- This creates and runs all the tests in the directory
- <filename>movies.all</filename>:
- <programlisting>
- make -C testsuite/movies.all check
- </programlisting>
- </para>
- </sect4>
-
- </sect3>
- <sect3 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 &app; are most useful for
- development.
- </para>
-
- <para>
- The first step is to compile the test case, which can be done
- with <filename>make XML-v#.swf</filename> 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>
-
- <sect4 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 &app;:
- <programlisting>
- gnash -v XML-v6.swf
- </programlisting>
- </para>
- </sect4>
-
- <sect4 id="manual_actionscript_tests">
- <title>ActionScript Unit Tests</title>
- <para>
- Unit tests for ActionScript classes in
<command>testsuite/actionscript.all</command>
- are run without a graphical display:
- <programlisting>
- gprocessor -v XML-v6.swf
- </programlisting>
- </para>
- </sect4>
- </sect3>
-
-
-
-</sect2>
Index: installation/code_dependencies.xml
===================================================================
RCS file: installation/code_dependencies.xml
diff -N installation/code_dependencies.xml
--- installation/code_dependencies.xml 20 Feb 2008 05:16:21 -0000 1.6
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,398 +0,0 @@
-<title>Code Dependencies</title>
-
-<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>
-
-<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.
- </para>
-</note>
-
-<table frame='all' id="codedeps">
- <title>Code Dependency Table</title>
- <tgroup cols='7' align='left' colsep='1' rowsep='1'>
- <colspec colname='name'/>
- <colspec colname='required'/>
- <colspec colname='version'/>
- <colspec colname='description'/>
- <colspec colname='explanation'/>
- <colspec colname='apt'/>
- <colspec colname='rpm'/>
-
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Level</entry>
- <entry>Version</entry>
- <entry>Description</entry>
- <entry>Explanation</entry>
- <entry>apt-get package</entry>
- <entry>RPM/Yum package</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>Boost</entry>
- <entry>Required</entry>
- <entry>1.32 or higher</entry>
- <entry>
- Boost is a library of portable C++ classes and
- templates.
- </entry>
- <entry>
- In &app;, Boost libraries are used extensively, primarily
- boost-gthread and boost-date-time.
- </entry>
- <entry>
- <filename>libboost-thread-dev, libboost-date-time-dev
- </filename>
- </entry>
- <entry>
- <filename>
- liboost-thread-dev, libboost-date-time
- </filename></entry>
- </row>
-
- <row>
- <entry>libxml2</entry>
- <entry>Required</entry>
- <entry></entry>
- <entry>
- Libxml2 is the GNOME XML parser library and
- is available at <ulink type="http"
- url="http://xmlsoft.org";>http://xmlsoft.org</ulink>.
- </entry>
- <entry>
- This library is used to parse messages in the
- XML or XMLSocket ActionScript classes.
- </entry>
- <entry><filename>libxml2-dev</filename></entry>
- <entry><filename>libxml2-devel</filename></entry>
- </row>
-
- <row>
- <entry>AGG</entry>
- <entry>Possibly Required</entry>
- <entry>2.4 or higher</entry>
- <entry>
- AGG is the AntiGrain low-level 2D graphics
- library.
- </entry>
- <entry>
- &app; requires the installation of at least one
- renderer. AGG is considered the <emphasis>best
- supported</emphasis> renderer for &app;.
- </entry>
- <entry><filename>libagg-dev</filename></entry>
- <entry><filename>agg-devel</filename></entry>
- </row>
-
- <row>
- <entry>OpenGL</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- OpenGL is a standard specification defining a
- cross-language cross-platform API for writing
- applications which produce 3D and 2D graphics.
- It supports hardware acceleration.
- You can download a free implementation from
- <ulink type="http"
- url="http://www.mesa3d.org";>http://www.mesa3d.org</ulink>.
- </entry>
- <entry>
- &app; requires the installation of at least one
- renderer.
- </entry>
- <entry><filename>libgl1-mesa-dev</filename></entry>
- <entry><filename>libmesa-devel</filename></entry>
- </row>
-
- <row>
- <entry>Cairo</entry>
- <entry>Possibly Required</entry>
- <entry />
- <entry>
- Cairo is a 2D graphics library with support for
- multiple output devices. It will automatically use
- graphic card acceleration when available, and has
- an experimental OpenGL backend.
- </entry>
- <entry>
- &app; requires the installation of at least one
- renderer. Cairo is considered
- the <emphasis>least supported</emphasis> renderer
- for &app;.
- </entry>
- <entry><filename>libcairo2-dev</filename></entry>
- <entry><filename>cairo-devel</filename></entry>
- </row>
-
- <row>
- <entry>GTK</entry>
- <entry>Possibly Required</entry>
- <entry>2.2 or higher</entry>
- <entry>
- GTK is the GIMP Toolkit GUI library.
- It uses Cairo internally.
- </entry>
- <entry>
- &app; requires the installation of at least one
- GUI library. GTK is considered to be the
- <emphasis>best supported</emphasis> GUI library
- option for &app;.
- </entry>
- <entry><filename>libgtk2.0-dev</filename></entry>
- <entry><filename>gtk-devel</filename></entry>
- </row>
-
- <row>
- <entry>GtkGlExt</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- GtkGlExt integrates OpenGL into GTK.
- </entry>
- <entry>
- This library is required in order to use
- the GTK GUI library in conjunction with the
- OpenGL renderer.
- </entry>
- <entry><filename>libgtkglext1-dev</filename></entry>
- <entry><filename>gtkglext-devel</filename></entry>
- </row>
-
- <row>
- <entry>SDL</entry>
- <entry>Possibly Required</entry>
- <entry />
- <entry>
- The Simple DirectMedia Layer is a cross-platform
- multimedia library which provides abstraction for
- audio, graphics, sound and input APIs.
- SDL is available from
- <ulink type="http" url="http://www.libsdl.org";>
- http://www.libsdl.org</ulink>.
- </entry>
- <entry>
- &app; requires the installation of at least one
- GUI library. SDL may also be used as a sound
- handler regardless of whether it is employed as
- a GUI library. The GUI
- library is <emphasis>poorly supported</emphasis>
- in &app;, but the sound handler is the
- <emphasis>best supported</emphasis> in &app;.
- </entry>
- <entry><filename>libsdl1.2-dev</filename></entry>
- <entry><filename>SDL-devel</filename></entry>
- </row>
-
- <row>
- <entry>FLTK</entry>
- <entry>Possibly Required</entry>
- <entry>2.0 or higher</entry>
- <entry>
- The Fast Light ToolKit is a portable GUI library
- which is intended as a replacement for the SDL GUI.
- </entry>
- <entry>
- &app; requires the installation of at least one
- GUI library. FLTK may be used in conjunction with
- the Cairo and AGG renderers.
- </entry>
- <entry>No distribution packages are available.</entry>
- <entry>No distribution packages are available.</entry>
- </row>
-
- <row>
- <entry>KDE</entry>
- <entry>Possibly Required</entry>
- <entry />
- <entry>
- Kdelibs is a collection of libraries needed to
- compile KDE applications.
- </entry>
- <entry>
- &app; requires the installation of at least one
- 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>
- </row>
-
- <row>
- <entry>Gstreamer</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- Gstreamer is a video handler.
- </entry>
- <entry>
- If you would like video playback, you must
- install one of the video handlers.
- </entry>
- <entry><filename>libgstreamer0.8-dev</filename></entry>
- <entry><filename>gstreamer-devel</filename></entry>
- </row>
-
- <row>
- <entry>gst-ffmpeg</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- gst-ffmpeg allows you to use the FFMPEG decoder
- with Gstreamer.
- </entry>
- <entry>
- This package is required if you would like to
- use Gstreamer as a video handler.
- </entry>
- <entry><filename>gstreamer0.8-ffmpeg-dev</filename></entry>
- <entry><filename>gstreamer-ffmpeg-devel</filename></entry>
- </row>
-
- <row>
- <entry>FFMPEG</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- FFMPEG is a video handler.
- </entry>
- <entry>
- If you would like video playback, you must
- install one of the video handlers. It is also
- a dependency of gst-ffmpeg.
- </entry>
- <entry><filename>ffmpeg-dev</filename></entry>
- <entry><filename>ffmpeg-devel</filename></entry>
- </row>
-
- <row>
- <entry>JPEG</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- <ulink type="http" url="http://www.ijg.org/";>JPEG</ulink>
- is a lossy image format which is heavily used for images.
- </entry>
- <entry>
- This library is used for rendering JPEGs.
- </entry>
- <entry><filename>libjpeg62-dev</filename></entry>
- <entry><filename>libjpeg</filename></entry>
- </row>
-
- <row>
- <entry>PNG</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- <ulink type="http"
- url="http://www.libpng.org/pub/png/";>PNG</ulink> is
- a patent-free image format which is comparable to
- <emphasis>GIF</emphasis>.
- </entry>
- <entry>
- This library is used for rendering PNGs.
- </entry>
- <entry><filename>libpng12-dev</filename></entry>
- <entry><filename>libpng</filename></entry>
- </row>
-
- <row>
- <entry>libcurl</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- libcurl is the multiprotocal file transfer library.
- </entry>
- <entry>
- This library is used for URL downloading.
- </entry>
- <entry><filename>libcurl4-gnutls</filename></entry>
- <entry><filename>libcurl</filename></entry>
-
- </row>
-
- <row>
- <entry>automake</entry>
- <entry>Possibly Required</entry>
- <entry>1.6.0</entry>
- <entry>
- Automake is a tool for generating
- <emphasis>Makefile.in</emphasis> files.
- </entry>
- <entry>
- This package is required to run
- <emphasis>autogen.sh</emphasis>, which is a requirement
- if you are using the development source from CVS.
- </entry>
- <entry><filename>automake</filename></entry>
- <entry><filename>automake</filename></entry>
- </row>
-
- <row>
- <entry>autoconf</entry>
- <entry>Possibly Required</entry>
- <entry>2.59</entry>
- <entry>
- Autoconf is a package for generating configure
- scripts.
- </entry>
- <entry>
- This package is required to run
- <emphasis>autogen.sh</emphasis>, which is a requirement
- if you are using the development source from CVS.
- </entry>
- <entry><filename>autoconf</filename></entry>
- <entry><filename>autoconf</filename></entry>
- </row>
-
- <row>
- <entry>gettext</entry>
- <entry>Possibly Required</entry>
- <entry>0.14.6</entry>
- <entry>
- Gettext is part of the GNU Translation Project.
- </entry>
- <entry>
- This package is required to run
- <emphasis>autogen.sh</emphasis>, which is a requirement
- if you are using the development source from CVS.
- </entry>
- <entry><filename>gettext</filename></entry>
- <entry><filename>gettext</filename></entry>
- </row>
-
- <row>
- <entry>libtool</entry>
- <entry>Possibly Required</entry>
- <entry>1.5.22</entry>
- <entry>
- This is a generic library support script.
- </entry>
- <entry>
- This package is required to run
- <emphasis>autogen.sh</emphasis>, which is a requirement
- if you are using the development source from CVS.
- </entry>
- <entry><filename>libltdl3-dev</filename></entry>
- <entry><filename>libtool</filename></entry>
- </row>
-
- </tbody>
- </tgroup>
-</table>
Index: installation/configuration.xml
===================================================================
RCS file: installation/configuration.xml
diff -N installation/configuration.xml
--- installation/configuration.xml 20 Feb 2008 11:33:54 -0000 1.7
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,61 +0,0 @@
-<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"
- url="http://www.gnu.org/software/autoconf/";>GNU Autoconf</ulink>
- for configuration.
-</para>
-<para>
- If you opted to download the
- <link linkend="sourcerepo">development checkout</link>
- of &app;, the <emphasis>configure</emphasis> script will
- not be included. It can be created by running
- <emphasis>autogen.sh</emphasis> from the source root directory:
- <programlisting>
- ./autogen.sh
- </programlisting>
- Note that there are some
- <link linkend="codedepend">dependencies</link> for
- autogen.
-</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
- features</link>, and
- those that <link linkend="custompath">specify custom paths for
- development packages</link>
- which are not found during the default search. A complete
- list of <emphasis>all</emphasis> configuration options, including
- standard ones, can be seen by typing:
- <programlisting>
- ./configure --help |less
- </programlisting>
- Read further for a more detailed explanation of &app;-specific
- options.
-</para>
-<para>
- The syntax for running <emphasis>configure</emphasis> is as follows:
- <programlisting>
- configure <replaceable><options></replaceable>
- </programlisting>
- The example below shows the <command>configure</command> options
- which create the smallest working standalone version of &app;. In
- this example, <command>configure</command> is being run from the
- source root directory:
-</para>
-
-<programlisting>
-./configure --disable-debugger --disable-cygnal --disable-docbook \
---disable-plugin --enable-media=mad --enable-gui=sdl
-</programlisting>
-
-<sect2 id="features">
- &featureoptions;
-</sect2>
-
-<sect2 id="custompath">
- &custompath;
-</sect2>
-
-<sect2 id="crosscompilingconfiguration">
- &crosscompiling;
-</sect2>
Index: installation/cross_compiling.xml
===================================================================
RCS file: installation/cross_compiling.xml
diff -N installation/cross_compiling.xml
--- installation/cross_compiling.xml 20 Feb 2008 05:16:21 -0000 1.4
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,104 +0,0 @@
-<title>Cross Compiling</title>
-
-<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
- <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>
-
-<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-nsapi
- --disable-kparts --enable-gui=fb --enable-renderer=agg --disable-shared
-</programlisting>
-
-<para>
- The important configuration options are the ones which specify the
- architecture for the build:
-</para>
-
-<variablelist>
-
- <varlistentry>
- <term>--target</term>
- <listitem>
- <para>
- The target architecture, where the final executables are expected
- to run.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--host</term>
- <listitem>
- <para>
- The host architecture, where the executables are expected
- to run. Usually this is the same as the <emphasis>--target</emphasis>,
- except when building a compiler as a Canadian Cross. In this
- case, you might build a cross compiler on a UNIX system which
- runs on a win32 machine, producing code for a third architecture,
- such as ARM. In this example, <emphasis>--target</emphasis> would
- be 'arm-unknown-linux-gnu', while <emphasis>--host</emphasis> would
- be 'win32'.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--build</term>
- <listitem>
- <para>
- This is the system the build is running on.
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
-
-<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
- </programlisting>
-</para>
Index: installation/custompath_configuration.xml
===================================================================
RCS file: installation/custompath_configuration.xml
diff -N installation/custompath_configuration.xml
--- installation/custompath_configuration.xml 11 Jan 2008 18:10:10 -0000
1.9
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,421 +0,0 @@
-<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>
- The following custom path options are available:
-</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>
- <entry>Option</entry>
- <entry>Function</entry>
-</row>
-</thead>
-<tbody>
-<row>
- <entry>
- <option>--x-includes=DIR</option>
- </entry>
- <entry>
- X include files are in DIR.
- </entry>
- </row><row>
- <entry>
- <option>--x-libraries=DIR</option>
- </entry>
- <entry>
- X library files are in DIR.
- </entry>
- </row><row>
- <entry>
- <option>--with-libxml=PFX</option>
- </entry>
- <entry>
- Prefix to where libxml is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-libxml-libraries=DIR</option>
- </entry>
- <entry>
- Directory where libxml library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-libxml-includes=DIR</option>
- </entry>
- <entry>
- Directory where libxml header files are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-docbook=DIR</option>
- </entry>
- <entry>
- Directory where the DocBook style-sheets are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-sdl-prefix=PFX</option>
- </entry>
- <entry>
- Prefix where SDL is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-zlib-incl</option>
- </entry>
- <entry>
- Directory where zlib header is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-zlib-lib</option>
- </entry>
- <entry>
- Directory where zlib library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-jpeg-incl</option>
- </entry>
- <entry>
- Directory where jpeg header is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-jpeg-lib</option>
- </entry>
- <entry>
- Directory where jpeg library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-png-incl</option>
- </entry>
- <entry>
- Directory where png header is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-png-lib</option>
- </entry>
- <entry>
- Directory where png library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-qt-dir</option>
- </entry>
- <entry>
- Directory where QT is installed. This is only used by
- the Klash plugin.
- </entry>
- </row><row>
- <entry>
- <option>--with-qt-includes</option>
- </entry>
- <entry>
- Directory where the QT header files are installed. This
- is only used by the Klash plugin.
- </entry>
- </row><row>
- <entry>
- <option>--with-qt-libraries</option>
- </entry>
- <entry>
- Directory where the QT libraries are installed. This is
- only used by the Klash plugin.
- </entry>
- </row><row>
- <entry>
- <option>--with-npapi-plugindir</option>
- </entry>
- <entry>
- This is the directory to install the NPAPI (Mozilla) plugin in.
- By default it goes to ~/.mozilla/plugins.
- </entry>
- </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.
- </entry>
- </row><row>
- <entry>
- <option>--with-kde-plugindir</option>
- </entry>
- <entry>
- This is the directory to install the KPARTS (kde) plugin in.
- 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>
- <entry>
- <option>--with-kde-servicesdir</option>
- </entry>
- <entry>
- This is the directory to install the KPARTS (kde) service in.
- 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>
- <entry>
- <option>--with-kde-configdir</option>
- </entry>
- <entry>
- This is the directory to install the KPARTS (kde) config files in.
- 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>
- <entry>
- <option>--with-kde-appsdatadir</option>
- </entry>
- <entry>
- This is the directory to install the KPARTS (kde) application data
files in.
- 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>
- <entry>
- <option>--with-ming</option>
- </entry>
- <entry>
- 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>
- <entry>
- <option>--with-ogg_incl</option>
- </entry>
- <entry>
- Directory where the libogg headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-ogg_lib</option>
- </entry>
- <entry>
- Directory where the libogg library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-gstreamer-incl</option>
- </entry>
- <entry>
- Directory where the Gstreamer headers are
- installed. Gstreamer version 0.10 or greater must be used.
- </entry>
- </row><row>
- <entry>
- <option>--with-gstreamer-lib</option>
- </entry>
- <entry>
- Directory where the Gstreamer library is
- installed. Gstreamer version 0.10 or greater must be used.
- </entry>
- </row><row>
- <entry>
- <option>--with-opengl-includes</option>
- </entry>
- <entry>
- Directory where OpenGL (libMesa) headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-opengl-lib</option>
- </entry>
- <entry>
- Directory where the OpenGL (libMesa) library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-glext-incl</option>
- </entry>
- <entry>
- Directory where GtkGlExt headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-glext-lib</option>
- </entry>
- <entry>
- Directory where the GtkGlExt library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-gtk2-incl</option>
- </entry>
- <entry>
- Directory where the Gtk2 headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-gtk2-lib</option>
- </entry>
- <entry>
- Directory where the Gtk2 library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-cairo_incl</option>
- </entry>
- <entry>
- Directory where the Cairo headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-cairo-lib</option>
- </entry>
- <entry>
- Directory where the Cairo library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-glib-incl</option>
- </entry>
- <entry>
- Directory where the Glib headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-glib-lib</option>
- </entry>
- <entry>
- Directory where the Glib library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-pango-incl</option>
- </entry>
- <entry>
- Directory where the Pango headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-pango-lib</option>
- </entry>
- <entry>
- Directory where the Pango library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-atk-incl</option>
- </entry>
- <entry>
- Directory where the ATK headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-atk-lib</option>
- </entry>
- <entry>
- Directory where the ATK library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-pthread-incl</option>
- </entry>
- <entry>
- Directory where the Pthread headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-pthread-lib</option>
- </entry>
- <entry>
- Directory where the Pthread library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-agg-incl</option>
- </entry>
- <entry>
- Directory where the AGG (Antigrain) headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-agg-lib</option>
- </entry>
- <entry>
- Directory where the AGG (Antigrain) library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-ffmpeg-incl</option>
- </entry>
- <entry>
- Directory where the FFMPEG headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-ffmpeg-lib</option>
- </entry>
- <entry>
- Directory where the FFMPEG library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-boost-incl</option>
- </entry>
- <entry>
- Directory where the Boost headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-boost-lib</option>
- </entry>
- <entry>
- Directory where the Boost library is installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-curl-incl</option>
- </entry>
- <entry>
- Directory where the libCurl headers are installed.
- </entry>
- </row><row>
- <entry>
- <option>--with-curl-lib</option>
- </entry>
- <entry>
- Directory where the libCurl library is installed.
- </entry>
-</row>
-</tbody>
-</tgroup>
-</table>
-
Index: installation/documentation_dependencies.xml
===================================================================
RCS file: installation/documentation_dependencies.xml
diff -N installation/documentation_dependencies.xml
--- installation/documentation_dependencies.xml 20 Feb 2008 05:16:21 -0000
1.4
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,165 +0,0 @@
-<title>Documentation Dependencies</title>
-
-<para>
- The following packages are used to build &app;'s documentation.
-</para>
-
-<table frame='all' id="docdeps">
- <title>Documentation Dependency Table</title>
- <tgroup cols='7' align='left' colsep='1' rowsep='1'>
- <colspec colname='name'/>
- <colspec colname='required'/>
- <colspec colname='version'/>
- <colspec colname='description'/>
- <colspec colname='explanation'/>
- <colspec colname='apt'/>
- <colspec colname='rpm'/>
-
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Level</entry>
- <entry>Version</entry>
- <entry>Description</entry>
- <entry>Explanation</entry>
- <entry>apt-get package</entry>
- <entry>RPM/Yum package</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>Docbook</entry>
- <entry>Required</entry>
- <entry></entry>
- <entry>
- <ulink type="http"
- url="http://http://docbook.sourceforge.net/";>Docbook</ulink> is
- is an industry-standard XML format for technical
- documentation. You can download it from
- <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>.
- </entry>
- <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>
- </row>
-
- <row>
- <entry>DocBook2X</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.
- It is available at <ulink type="http"
-
url="http://docbook2x.sourceforge.net/";>http://docbook2x.sourceforge.net/</ulink>.
- </entry>
- <entry>
- DocBook2X is required to produce HTML and Texinfo
- formats.
- </entry>
- <entry><filename>docbook2x</filename></entry>
- <entry><filename>docbook2x</filename></entry>
- </row>
-
- <row>
- <entry>Texinfo</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- Texinfo can be used to convert DocBook2X output
- into GNU info pages. You can download it from
- <ulink type="http"
-
url="http://ftp.gnu.org/gnu/texinfo/";>http://ftp.gnu.org/gnu/texinfo/</ulink>.
- </entry>
- <entry>
- Texinfo is required if you wish to product GNU info
- pages.
- </entry>
- <entry><filename>texinfo</filename></entry>
- <entry><filename>texinfo</filename></entry>
- </row>
-
- <row>
- <entry>FOP</entry>
- <entry>Optional</entry>
- <entry>0.20.5</entry>
- <entry>
- Formatting Objects Processor is a print formatter
- driven by XSL formatting objects. It is a Java
- application which can output PDF, PCL, PS, SVG, XML,
- Print, AWT, MIF, and Text. It is available at
- <ulink url="http://xmlgraphics.apache.org/fop/";
- type="http">http://xmlgraphics.apache.org/fop/</ulink>.
- </entry>
- <entry>
- FOP is required for PDF output.
- </entry>
- <entry><filename>fop</filename></entry>
- <entry><filename>fop</filename></entry>
- </row>
-
- <row>
- <entry>Java (j2re)</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- FOP requires Sun's Java runtime (GCJ does not work with
- FOP). You can download it from
- <ulink url="http://java.sun.com";
type="http">http://java.sun.com</ulink>.
- </entry>
- <entry>
- Sun's Java runtime (j2re) is required to use FOP.
- </entry>
- <entry>
- Download the package from <ulink type="http"
- url="http://java.sun.com";>Sun</ulink>.
- </entry>
- <entry>
- Download the package from <ulink type="http"
- url="http://java.sun.com";>Sun</ulink>.
- </entry>
- </row>
-
- <row>
- <entry>JAI</entry>
- <entry>Possibly Required</entry>
- <entry></entry>
- <entry>
- Sun's Java Advanced Imaging API can be downloaded from
- <ulink type="http"
url="http://java.sun.com/products/java-media/jai/iio.html";>http://java.sun.com/products/java-media/jai/iio.html</ulink>.
- </entry>
- <entry>
- JAI is required
- if you wish to include graphics in a PDF file being
- generated with FOP.
- </entry>
- <entry>
- Download the package from <ulink
- url="http://java.sun.com/products/java-media/jai/iio.html";
- type="http">Sun</ulink>.
- </entry>
- <entry>
- Download the package from <ulink
- url="http://java.sun.com/products/java-media/jai/iio.html";
- type="http">Sun</ulink>.
- </entry>
- </row>
-
- </tbody>
- </tgroup>
-</table>
-
-<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>
Index: installation/feature_configuration.xml
===================================================================
RCS file: installation/feature_configuration.xml
diff -N installation/feature_configuration.xml
--- installation/feature_configuration.xml 11 Jan 2008 18:10:10 -0000
1.17
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,265 +0,0 @@
-<title>Features</title>
-
-<para>
- Some switches can be used during configuration to enable or disable
- features of &app;. Some of the most important configuration options
- are:
-</para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
-<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.
- </para>
- </listitem>
- <listitem>
- <para>
-<option>--enable-media</option> permits a media handler to be
-selected. The default is FFMPEG with SDL sound.
- </para>
- </listitem>
- </itemizedlist>
-<para>
- A complete list of available features follows.
-</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>
- <entry>Option</entry>
- <entry>Function</entry>
-</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>
- <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><para>Select the Graphic User Interface to use (choose one).</para>
- <variablelist>
- <varlistentry>
- <term>GTK</term>
- <listitem>
-<para>
- The GTK+ toolkit, which is the default GUI.
- Said to interwork particularly well with firefox.
-</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>SDL</term>
- <listitem>
-<para>
- Simple DirectMedia Layer, a simple and portable GUI.
- Its sound facilities are used when --enable-media=ffmpeg|mad
- regardless of whether it is also in charge of the GUI.
-</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>KDE</term>
- <listitem>
-<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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>FLTK</term>
- <listitem>
-<para>
- Fast Light ToolKit, low on resource usage.
- Since all build using fltk are now broken, we declare it
- "for developers".
-</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>FB</term>
- <listitem>
-<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>
- </listitem>
- </varlistentry>
- </variablelist>
-</entry>
-</row>
-<row>
- <entry><option>--enable-i810-lod-bias</option>
-</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>
- <entry><option>--enable-media=ffmpeg|mad|gst</option>
-</entry>
- <entry> <para>
- Select the specified media decoder and sound engine.
- FFMPEG and MAD use the SDL sound engine; GST uses its own.
- MAD only decodes MP3 sounds and uses integer arithmetic while
- the others also decode video files and use floating point.
- <option>FFMPEG</option> is the default decoder.
- </para>
- <para>
- You should only select one media decoder.
- </para></entry>
-</row>
-<row>
- <entry>
- <option>--disable-nsapi</option>
- <option>--enable-nsapi</option>
- </entry>
- <entry>Force disable/enable building the NPAPI plugin.
- By default the Mozilla plugin is built if the GTK gui
- is selected. Specify the
- <option>--with-npapi-plugindir=</option> option to specify where the
- plugin should be installed.
- </entry>
-</row>
-<row>
- <entry>
- <option>--disable-kparts</option>
- <option>--enable-kparts</option>
- </entry>
- <entry>Force disable/enable building the KPARTS plugin. By default the
- KDE plugin is built if the kde gui is selected.
- Specify the <option>--with-kde-plugindir=</option> and
- <option>--with-kde-servicesdir=</option> options (or more generally
- the <option>--with-kde-pluginprefix=</option> one) to specify where the
- plugin should be installed. The default installation dir is extracted
- from kde-config.
- </entry>
-</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>
- <entry><option>--enable-renderer=opengl|cairo|agg</option>
-</entry>
- <entry>Enable support for the a graphics backend. Currently
- only <option>opengl</option> and
- <option>agg</option> work sufficiently. OpenGL is
- used when you have hardware accelerated graphics. AGG i
- used when you do not have hardware accelerated
- graphics. Typically most desktop machines have OpenGL
- 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>
- <entry><option>--enable-sdk-install</option>
-</entry>
- <entry>Enable installing the libraries and headers as an SDK.
-</entry>
-</row>
-<row>
- <entry><option>--disable-shared</option>
-</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>
- <entry><option>--enable-strict</option>
-</entry>
- <entry>Turn verbose GCC compiler warnings. By default only
- <option>-Wall</option> is used with GCC.</entry>
-</row>
-<row>
- <entry><option>--enable-fps-debug</option>
-</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>
- <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><option>--disable-mit-shm</option>
-</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>
Index: installation/install.xml
===================================================================
RCS file: installation/install.xml
diff -N installation/install.xml
--- installation/install.xml 29 Sep 2007 13:05:47 -0000 1.6
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,114 +0,0 @@
-<title>Installation</title>
-
-<para>
-Now that &app; has been compiled and tested, use the following command to
install it:
- <programlisting>
- make install
- </programlisting>
-The above command installs the standalone player. If the correct files were
found by <command>configure</command> and if the
<option>--disable-plugin</option> option was not specified, the &app; browser
plugin is also installed.
-</para>
-
-<para>
- &app; installs a number of <link linkend="libinstall">libraries</link>,
- namely: <emphasis>libbase</emphasis>,
- <emphasis>libgeometry</emphasis>, <emphasis>libbackend</emphasis>,
- <emphasis>libserver</emphasis>, and <emphasis>libmozsdk</emphasis>.
- <link linkend="appinstall">Executables</link>
- consist of the (optional) plugin, <filename>gprocessor</filename>,
- <filename>cygnal</filename>, and <filename>gnash</filename>.
- <link linkend="docinstall">Documentation</link> may also be installed.
- The installation location is controlled with the
- <emphasis>--prefix</emphasis> <link linkend="custompath">configure
- option</link>, except for plugins, which are explicitly set with
- <emphasis>--plugin-dir</emphasis>.
-</para>
-
-<para>
- Note that if you are using a single file-system <emphasis>NFS</emphasis>
- mounted to multiple platforms, the
- <link linkend="custompath">configuration option</link>
- <emphasis>--exec-prefix</emphasis> may be used to specify where
- platform-dependent executables and libraries are installed.
-</para>
-
-<sect2 id="libinstall">
- <title>Libraries</title>
-
- <para>
- Installed libraries are located in
- <filename>/usr/local/lib</filename> by default.
- If the <emphasis>--prefix</emphasis> option was used in
- <link linkend="pre-configuration">configuration</link>, the libraries will
- be installed in the directory <filename>lib</filename> inside the
- path you specified. If the libraries are stored in a non-standard
- location, you must identify the path in one of two ways.
- </para>
-
- <para>
- The traditional way to do this on UNIX
- platforms is to set the <emphasis>LD_LIBRARY_PATH</emphasis> variable
- to the path plus <filename>/lib</filename>. For example, if you
- installed in <filename>/home/gnash</filename>, the
- <emphasis>LD_LIBRARY_PATH</emphasis> path would be
- <filename>/home/gnash/lib</filename>. Multiple paths are delimited
- with a colon (':').
- </para>
-
- <para>
- GNU/Linux allows the custom path to be added to
- <filename>/etc/ld.so.conf</filename>. After adding the path,
- run <emphasis>ldconfig</emphasis> as root to update the runtime
- cache.
- </para>
-</sect2>
-
-<sect2 id="appinstall">
- <title>Executables</title>
-
- <para>
- The Mozilla plugin is built from headers (the Mozilla SDK) provided with
Gnash and
- does not need extra development packages to be installed. By default,
the
- plugin is installed to <filename>~/.mozilla/plugins/</filename>. To
enable
- the plugin for other users, copy the file
<filename>libgnashplugin.so</filename>
- to <filename>.mozilla/plugins/</filename> in their home directory.
- You may also specify the plugin installation directory by using the
- <option>--with-plugindir</option> <link linkend="custompath">option
- at configuration time</link>.
- </para>
- <para>
- These defaults are likely to change in future versions of Gnash.
- </para>
- <para>
- The remaining executables are installed in the <filename>bin</filename>
- subdirectory of the directory specified by during configuration.
- If no path was specified, the default is
- <filename>/usr/local/bin</filename>.
- </para>
-</sect2>
-
-<sect2 id="docinstall">
- <title>Documentation</title>
-
- <para>
- Documentation is not built by default; please refer to the
- <link linkend="processdoc">section on documentation</link> for
- more information on building documentation.
- </para>
-
- <para>
- <command>man</command> and <command>info</command>
- are installed in <filename>/usr/local/share/man</filename>
- and <filename>/usr/local/share/info</filename> respectively, unless
- the <option>--mandif</option> or <option>--infodir</option>
- <link linkend="custompath">configuration options</link> are used.
- </para>
-
- <para>
- <emphasis>GNOME help</emphasis> documentation uses the directory
- <filename>/usr/local/share/gnash/doc/gnash/C/</filename> by default.
- A configuration file in the &app; source tree,
- <filename>doc/C/gnash.omf</filename> is used to specify under
- which menu item &app; appears in the <emphasis>GNOME help</emphasis>
- system.
- </para>
-</sect2>
Index: installation/packagemanager.xml
===================================================================
RCS file: installation/packagemanager.xml
diff -N installation/packagemanager.xml
--- installation/packagemanager.xml 22 May 2007 13:48:09 -0000 1.1
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,16 +0,0 @@
-<title>Using a Package Manager</title>
-
-<para>
- &app; is available as a package for a number of Linux and BSD
- distributions, such as <ulink type="http"
- url="http://packages.ubuntu.com/feisty/utils/gnash";>Ubuntu</ulink>,
- <ulink type="http"
- url="http://packages.debian.org/unstable/utils/gnash";>Debian</ulink>,
- <ulink type="http"
- url="http://www.freshports.org/graphics/gnash/";>FreeBSD</ulink>,
- and <ulink type="http"
- url="http://ports.openbsd.nu/www/gnash";>OpenBSD</ulink>.
- There is also an unofficial Fedora RPM.
- This is not an extensive list, and you are advised to search
- if you wish to use a package manager on a different system.
-</para>
Index: installation/sources.xml
===================================================================
RCS file: installation/sources.xml
diff -N installation/sources.xml
--- installation/sources.xml 1 Aug 2007 05:05:36 -0000 1.5
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,33 +0,0 @@
-<title>Building from Source</title>
-
-<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>.
- The &app; installation process is fairly standard:
- <programlisting>
- ./autogen.sh
- ./configure <options>
- make
- make check
- make install
- </programlisting>
-</para>
-<para>
- Continue reading for detailed step-by-step instructions
- of the entire procedure.
-</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>
-
-
-
Index: installation/testing_dependencies.xml
===================================================================
RCS file: installation/testing_dependencies.xml
diff -N installation/testing_dependencies.xml
--- installation/testing_dependencies.xml 20 Feb 2008 05:16:21 -0000
1.3
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,91 +0,0 @@
-<title>Testing Dependencies</title>
-
-<para>
- &app; tries to run as many tests as possible, but will
- simply skip tests if the tools to run them are unavailable.
-</para>
-
-<table frame='all' id="testdeps">
- <title>Testing Dependency Table</title>
- <tgroup cols='7' align='left' colsep='1' rowsep='1'>
- <colspec colname='name'/>
- <colspec colname='required'/>
- <colspec colname='version'/>
- <colspec colname='description'/>
- <colspec colname='explanation'/>
- <colspec colname='apt'/>
- <colspec colname='rpm'/>
-
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Level</entry>
- <entry>Version</entry>
- <entry>Description</entry>
- <entry>Explanation</entry>
- <entry>apt-get package</entry>
- <entry>RPM/Yum package</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>Ming</entry>
- <entry>Optional</entry>
- <entry>0.4.0_beta4 or higher</entry>
- <entry>
- Ming is an ActionScript compiler.
- </entry>
- <entry>
- Ming is the primary compiler for ActionScript testcases.
- </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>
- Mtasc is an ActionScript compiler.
- </entry>
- <entry>
- Mtasc is used in some tests.
- </entry>
- <entry><filename>mtasc</filename></entry>
- <entry>No distribution packages are available.</entry>
- </row>
-
- <row>
- <entry>swfdec</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- Swfdec is a Flash player.
- </entry>
- <entry>
- Swfdec is used in some testcases.
- </entry>
- <entry>No distribution packages are available.</entry>
- <entry>Unofficial package <filename>swfdec</filename></entry>
- </row>
-
- <row>
- <entry>DejaGnu</entry>
- <entry>Optional</entry>
- <entry></entry>
- <entry>
- DejaGnu is a testing framework.
- </entry>
- <entry>
- DejaGnu is used to run multiple tests in an
- automated fashion.
- </entry>
- <entry><filename>dejagnu</filename></entry>
- <entry><filename>dejagnu</filename></entry>
- </row>
-
- </tbody>
- </tgroup>
-</table>
Index: usage/gnashrc.xml
===================================================================
RCS file: usage/gnashrc.xml
diff -N usage/gnashrc.xml
--- usage/gnashrc.xml 28 Dec 2007 19:37:00 -0000 1.18
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,307 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<sect1 id="gnashrc">
- <title>User Configuration File</title>
-
- <para>
-Individual user preferences may be set by editing variables with the
<filename>.gnashrc</filename> file:
-<programlisting>
-~/.gnashrc
-</programlisting>
-</para>
-
-<para>
-Each line must begin with an action: either <emphasis>set</emphasis> or, in
the case of lists, also
-<emphasis>append</emphasis>.
-</para>
-
-<para>
-The values in this configuration file apply only to an individual user, and
become the default settings of the standalone player and the plugin. Note that
any command line options take precedence over <filename>.gnashrc</filename>
settings.
-</para>
-
-<para>
-The variables in the <filename>.gnashrc</filename> file support three types of
arguments: on/off, numeric values, or in the case of the
- whitelist and blacklist, a list of hostnames as ASCII text.
- </para>
-
-
- <table id="tb-config-variables">
-<title>User Configuration Variables</title>
-<tgroup cols='3' align='left' colsep='1' rowsep='1'>
-<colspec colname='Variable' />
-<colspec colname='Value' />
-<colspec colname='Function' />
-<thead>
-<row>
-<entry>Variable</entry>
-<entry>Value</entry>
-<entry>Function</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry>localdomain</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls the loading of
- external Flash movies over a network. This option
- tells Gnash to only load Flash movies from the existing
domain.</entry>
-</row>
-<row>
-<entry>localhost</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls the loading of
- external Flash movies over a network. This is a stricter
- version of the <emphasis>localdomain</emphasis> setting as
- this allows the loading of Flash movies to the same host
- that is running &app;.</entry>
-</row>
-<row>
-<entry>whitelist</entry>
-<entry>hostnames</entry>
-<entry>This is a list of hostnames separated by spaces, or
<emphasis>off</emphasis>
- to disable the whitelist. The hostname must be given
- without a protocol (http://, https://). If this list is populated,
- &app; will only load external Flash movies from the specified
hosts. The
- whitelist takes precedence over the blacklist. Because several
files can
- be parsed in succession, each file can override or add to
- lists in other files. Use <emphasis>set</emphasis> to override
- all other lists or <emphasis>append</emphasis> to add your
blacklisted
- hosts to lists in previously parsed files.</entry>
-</row>
-<row>
-<entry>blacklist</entry>
-<entry>hostnames</entry>
-<entry>This is a list of hostnames separated by spaces, or
<emphasis>off</emphasis>
- to disable the blacklist. The hostname must be given
- without a protocol (http://, https://).
- External flash movies from these
- domains are never allowed to load. If whitelist is present
- and not empty, blacklist is not used. Because several files can
- be parsed in succession, each file can override or add to
- lists in other files. Use <emphasis>set</emphasis> to override
- all other lists or <emphasis>append</emphasis> to add your
blacklisted
- hosts to lists in previously parsed files.</entry>
-</row>
-<row>
-<entry>localSandboxPath</entry>
-<entry>dirs</entry>
-<entry>This is a list of directories separated by spaces.
- Only resources from these directories and from the directory
- portion of movie filename (if loaded from filesystem) are allowed
to load.
- Because several files can be parsed in succession, each file can
override
- or add to lists in other files. Use <emphasis>set</emphasis> to
override
- all other lists or <emphasis>append</emphasis> to add new sandboxes.
- Note that there's currently no way to *drop* the directory of base
dir
- from the list of allowed local sandboxes.
- </entry>
-</row>
-<row>
-<entry>delay</entry>
-<entry>Number</entry>
-<entry>&app; uses a timer-based event mechanism to advance frames
- at a steady rate. This option overrides the default
- setting in Gnash to play a movie slower or faster.</entry>
-</row>
-<row>
-<entry>verbosity</entry>
-<entry>Number</entry>
-<entry>This is a numeric value which defines the default level of
- verbosity from the player.</entry>
-</row>
-<row>
-<entry>MalformedSWFVerbosity</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls whether malformed SWF errors
should
- be printed. If set to true, verbosity level is automatically
incremented.
- Set <option>verbosity</option> to 0 afterwards to hush.</entry>
-</row>
-<row>
-<entry>ASCodingErrorsVerbosity</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls whether ActionScript coding
- errors should be printed. If set to true, verbosity level is
- automatically incremented. Set <option>verbosity</option> to 0
afterwards to hush.</entry>
-</row>
-<row>
-<entry>debuglog</entry>
-<entry>Absolute path</entry>
-<entry>This is the full path and name of debug logfile as
- produced by &app;. On systems with a UNIX-type shell,
- a tilde prefix (~) will be expanded as by Posix shell requirements
- (see
http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_01).</entry>
-</row>
-<row>
-<entry>writelog</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls whether a debug log
- is always written by &app;, or not at all.</entry>
-</row>
-<row>
-<entry>sound</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls the sound of the
- standalone player. By default &app; enables playing the
- sound in any Flash movie.</entry>
-</row>
-<row>
-<entry>pluginsound</entry>
-<entry>on/off</entry>
-<entry>This value can be set to either <emphasis>on</emphasis> or
- <emphasis>off</emphasis>, and controls the sound of the
- player when running as a browser plugin. By default, sound
- is enabled when using &app; as a browser plugin.</entry>
-</row>
-<row>
-<entry>EnableExtensions</entry>
-<entry>on/off</entry>
-<entry>Set to <emphasis>on</emphasis> to enable extensions. This option is
<emphasis>off</emphasis> by default</entry>
-</row>
-<row>
-<entry>StartStopped</entry>
-<entry>on/off</entry>
-<entry>Set to <emphasis>on</emphasis> to have the GUI start in "stop" mode.
This is useful in particular
- for the plugin, so you have to explicitly start any movie on a
webpage. This option is <emphasis>off</emphasis> by default.
- </entry>
-</row>
-<row>
-<entry>flashVersionString</entry>
-<entry>string</entry>
-<entry>Set the string returned by $version and System.capabilities.version.
- Useful to get around some flash version detection movies.
- Note that the version advertised by the plugin is NOT affected by this
setting,
- instead you need to set the GNASH_FLASH_VERSION environment variable for
- the latter (which doesn't affect $version and
System.capabilities.version).</entry>
-</row>
-
-<row>
-<entry>flashSystemOS</entry>
-<entry>string</entry>
-<entry>The string that Gnash should return for System.capabilities.OS</entry>
-</row>
-
-<row>
-<entry>flashSystemManufacturer</entry>
-<entry>string</entry>
-<entry>The string that Gnash should return for
System.capabilities.manufacturer</entry>
-</row>
-
-<row>
-<entry>StreamsTimeout</entry>
-<entry>double</entry>
-<entry>
-Set the number of seconds after which streams download time out. Note that
timeouts only occurs after the given number of seconds
-passed w/out anything was received.
-</entry>
-</row>
-
-<row>
-<entry>insecureSSL</entry>
-<entry>on/off</entry>
-<entry>If set to <emphasis>on</emphasis>, no verification of SSL connections
-is performed. This means that, although the connection is encrypted, the server
-certificate could be invalid, may not belong to the host, or both. Equivalent
-to curl --insecure. By default, this option is <emphasis>off</emphasis> and
-connections will fail when a host cannot be verified.</entry>
-</row>
-
-<row>
-<entry>SOLsafedir</entry>
-<entry>Absolute path</entry>
-<entry>The full path to a directory where &app; should store Shared Object
files ("flash cookies") if
-they are enabled.</entry>
-</row>
-
-<row>
-<entry>SOLreadonly</entry>
-<entry>on/off</entry>
-<entry>If set to <emphasis>on</emphasis>, &app; will not write Shared Object
files.</entry>
-</row>
-
-<row>
-<entry>URLOpenerFormat</entry>
-<entry>string</entry>
-<entry>
-Set the format of an url opener command. The %u label would be substituted by
the actual url to be opened.
-Examples:
-<programlisting>
- set urlOpenerFormat firefox -remote 'openurl(%u)'
- set urlOpenerFormat xdg-open %u
- set urlOpenerFormat open %u
- set urlOpenerFormat kfmclient exec %u
-</programlisting>
-</entry>
-</row>
-
-</tbody>
-</tgroup>
-</table>
-
-
- <para>
-The following example <filename>.gnashrc</filename> file allows a user to only
play Flash files saved locally to the machine on which &app; is running. It
also specifically forbids content from doubleclick.com and mochibot.com.
&app;'s error output is set to be fairly verbose, with the debug log placed in
a location convenient for the user. Finally, sound is turned on for both the
standalone player and the plugin.
-</para>
-
- <programlisting>
-
- #
- # Gnash client options
- #
-
- # Only access remote content from our local domain
- set localdomain on
-
- # Only access content from our local host
- set localhost on
-
- # These sites are OK
- # uncommenting the following line will allow load of external
- # movies *only* from the specified hosts.
- #set whitelist www.doonesbury.com www.cnn.com www.9news.com
-
- # Disable whitelists set in any other gnashrc files, because
- # these could override our blacklist.
- set whitelist off
-
- # Don't access content from these sites
- set blacklist www.doubleclick.com mochibot.com
-
- # The delay between timer interrupts
- set delay 50
-
- # The default verbosity level
- set verbosity 1
-
- # Be verbose about malformed SWF
- set MalformedSWFVerbosity true
-
- # Be verbose about AS coding errors
- set ASCodingErrorsVerbosity true
-
- # The full path to the debug log
- set debuglog ~/gnash-dbg.log
-
- # Write a debug log to disk
- set writelog on
-
- # Enable or Disable sound for the standalone player
- set sound on
-
- # Enable or Disable sound for the standalone player
- set pluginsound on
-
- # Make sure SSL connections are always verified
- set insecureSSL off
-
- # Use firefox to open urls
- set urlOpenerFormat firefox -remote 'openurl(%u)'
-
- </programlisting>
-
-
-</sect1>
-
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash/doc/C/usermanual installation/building.xm...,
Rob Savoye <=