[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: |
Melissa Goldin |
|
Subject: |
[Gnash-commit] gnash/doc/C/usermanual/installation building.xm... |
|
Date: |
Thu, 16 Aug 2007 14:27:35 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Melissa Goldin <mushi> 07/08/16 14:27:35
Modified files:
doc/C/usermanual/installation: building.xml
code_dependencies.xml
configuration.xml
cross_compiling.xml
custompath_configuration.xml
feature_configuration.xml
install.xml
Log message:
For most of these files, I've just added a bit more explanation, and
more informatin from the wiki when I could. Also, all <variablelist>s have
been converted to <table>s here, too - it makes the volume of information
easier to read.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/building.xml?cvsroot=gnash&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/code_dependencies.xml?cvsroot=gnash&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/configuration.xml?cvsroot=gnash&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/cross_compiling.xml?cvsroot=gnash&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/custompath_configuration.xml?cvsroot=gnash&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/feature_configuration.xml?cvsroot=gnash&r1=1.13&r2=1.14
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/install.xml?cvsroot=gnash&r1=1.4&r2=1.5
Patches:
Index: building.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/building.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- building.xml 1 Aug 2007 05:02:12 -0000 1.3
+++ building.xml 16 Aug 2007 14:27:35 -0000 1.4
@@ -16,7 +16,7 @@
</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.
+ any required prerequisites. The output of <command>make</command> can be
verbose; you may wish to pipe the output to a file.
</para>
<para>
@@ -28,37 +28,37 @@
<emphasis>-O2 -g</emphasis>. A list of influential
environment variables can be seen in the configuration help:
</para>
-<para><userinput>./configure --help</userinput></para>
+<programlisting>./configure --help</programlisting>
<para>
In the following example, debugging is enabled and optimization is
disabled:
</para>
-<para><userinput>make CFLAGS=-g CXXFLAGS=-g</userinput></para>
+<programlisting>make CFLAGS=-g CXXFLAGS=-g</programlisting>
</sect2>
<sect2 id="processdoc">
<title>Creating the Documentation</title>
<para>
- By default, documentation isn't built, even when you
+ 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
- <emphasis>Makefile</emphasis> in the <filename>doc/C</filename>
- sub-directory. If you type <emphasis>make install</emphasis> in
+ <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 need to specify a target output format when you wish to create
- documentation. The available output formats are:
<emphasis>html</emphasis>,
- <emphasis>pdf</emphasis>, <emphasis>info</emphasis>,
- <emphasis>man</emphasis>, and <emphasis>alldocs</emphasis>.
- It is also possible to output <emphasis>GNOME help</emphasis> if
+ 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>
- <emphasis>--enable-ghelp</emphasis> was used.
- The <emphasis>alldocs</emphasis> target will build all output formats
+ <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>
@@ -84,7 +84,7 @@
<title>Running the Tests</title>
<para>
- If a test fails, please report it by following the
+ 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>
@@ -112,8 +112,8 @@
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.
+ 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>
@@ -123,27 +123,27 @@
<sect4 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
+ 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 'make check' for the entire
+ 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 'clip_as_button2' test is compiled and
+ 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 would create and run all the tests in the directory
+ This creates and runs all the tests in the directory
<filename>movies.all</filename>:
<programlisting>
make -C testsuite/movies.all check
@@ -187,7 +187,7 @@
<sect4 id="manual_actionscript_tests">
<title>ActionScript Unit Tests</title>
<para>
- Unit tests for ActionScript classes in 'testsuite/actionscript.all'
+ Unit tests for ActionScript classes in
<command>testsuite/actionscript.all</command>
are run without a graphical display:
<programlisting>
gprocessor -v XML-v6.swf
Index: code_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/code_dependencies.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- code_dependencies.xml 7 Jun 2007 14:11:26 -0000 1.3
+++ code_dependencies.xml 16 Aug 2007 14:27:35 -0000 1.4
@@ -8,6 +8,13 @@
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'>
<title>Code Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
Index: configuration.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/configuration.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- configuration.xml 1 Aug 2007 05:02:47 -0000 1.5
+++ configuration.xml 16 Aug 2007 14:27:35 -0000 1.6
@@ -17,17 +17,17 @@
autogen.
</para>
<para>
- All the standard <emphasis>configure</emphasis> options
- are avaiable. In addition, &app; has two types of
- options: those which <link linkend="features">enable or disable
+ 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 which <link linkend="custompath">specify custom paths for
+ those that <link linkend="custompath">specify custom paths for
development packages</link>
- which aren't found during the default search. A complete
+ 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
+ ./configure --help |less
</programlisting>
Read further for a more detailed explanation of &app;-specific
options.
@@ -35,20 +35,18 @@
<para>
The syntax for running <emphasis>configure</emphasis> is as follows:
<programlisting>
- configure <options>
+ configure <replaceable><options></replaceable>
</programlisting>
- The example below shows the <emphasis>configure</emphasis> options
+ The example below shows the <command>configure</command> options
which create the smallest working standalone version of &app;. In
- this example, <emphasis>configure</emphasis> is being run from the
+ this example, <command>configure</command> is being run from the
source root directory:
</para>
-<screen>
-<userinput>
+<programlisting>
./configure --disable-debugger --disable-cygnal --disable-docbook \
--disable-plugin --enable-media=mad --enable-gui=sdl
-</userinput>
-</screen>
+</programlisting>
<sect2 id="features">
&featureoptions;
Index: cross_compiling.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/cross_compiling.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- cross_compiling.xml 26 May 2007 16:55:34 -0000 1.2
+++ cross_compiling.xml 16 Aug 2007 14:27:35 -0000 1.3
@@ -67,6 +67,7 @@
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>
Index: custompath_configuration.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/custompath_configuration.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- custompath_configuration.xml 7 Jun 2007 14:11:26 -0000 1.3
+++ custompath_configuration.xml 16 Aug 2007 14:27:35 -0000 1.4
@@ -9,448 +9,365 @@
</para>
<para>
The following custom path options are available:
-<!-- TODO - review this section -->
</para>
-<variablelist>
- <varlistentry>
- <term>--x-includes=DIR</term>
- <listitem>
- <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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--x-libraries=DIR</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--x-libraries=DIR</option>
+ </entry>
+ <entry>
X library files are in DIR.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml=PFX</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-libxml=PFX</option>
+ </entry>
+ <entry>
Prefix to where libxml is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-libraries=DIR</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-libxml-libraries=DIR</option>
+ </entry>
+ <entry>
Directory where libxml library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-includes=DIR</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-libxml-includes=DIR</option>
+ </entry>
+ <entry>
Directory where libxml header files are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-docbook=DIR</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-docbook=DIR</option>
+ </entry>
+ <entry>
Directory where the DocBook style-sheets are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-sdl-prefix=PFX</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-sdl-prefix=PFX</option>
+ </entry>
+ <entry>
Prefix where SDL is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-zlib-incl</option>
+ </entry>
+ <entry>
Directory where zlib header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-zlib-lib</option>
+ </entry>
+ <entry>
Directory where zlib library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-jpeg-incl</option>
+ </entry>
+ <entry>
Directory where jpeg header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-jpeg-lib</option>
+ </entry>
+ <entry>
Directory where jpeg library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-png-incl</option>
+ </entry>
+ <entry>
Directory where png header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-png-lib</option>
+ </entry>
+ <entry>
Directory where png library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-dir</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-qt-dir</option>
+ </entry>
+ <entry>
Directory where QT is installed. This is only used by
the Klash plugin.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-includes</term>
- <listitem>
- <para>
+ </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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-qt-libraries</term>
- <listitem>
- <para>
+ </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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-plugindir</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-plugindir</option>
+ </entry>
+ <entry>
This is the directory to install the Firefox plugin in.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ming</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-ming</option>
+ </entry>
+ <entry>
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>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-mad_incl</option>
+ </entry>
+ <entry>
Directory where libmad header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-mad_lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-mad_lib</option>
+ </entry>
+ <entry>
Directory where libmad library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ogg_incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-ogg_incl</option>
+ </entry>
+ <entry>
Directory where the libogg headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ogg_lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-ogg_lib</option>
+ </entry>
+ <entry>
Directory where the libogg library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gstreamer-incl</term>
- <listitem>
- <para>
+ </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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gstreamer-lib</term>
- <listitem>
- <para>
+ </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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-opengl-includes</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-opengl-includes</option>
+ </entry>
+ <entry>
Directory where OpenGL (libMesa) headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-opengl-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-opengl-lib</option>
+ </entry>
+ <entry>
Directory where the OpenGL (libMesa) library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glext-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-glext-incl</option>
+ </entry>
+ <entry>
Directory where GtkGlExt headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glext-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-glext-lib</option>
+ </entry>
+ <entry>
Directory where the GtkGlExt library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gtk2-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-gtk2-incl</option>
+ </entry>
+ <entry>
Directory where the Gtk2 headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-gtk2-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-gtk2-lib</option>
+ </entry>
+ <entry>
Directory where the Gtk2 library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-cairo_incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-cairo_incl</option>
+ </entry>
+ <entry>
Directory where the Cairo headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-cairo-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-cairo-lib</option>
+ </entry>
+ <entry>
Directory where the Cairo library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glib-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-glib-incl</option>
+ </entry>
+ <entry>
Directory where the Glib headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-glib-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-glib-lib</option>
+ </entry>
+ <entry>
Directory where the Glib library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pango-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-pango-incl</option>
+ </entry>
+ <entry>
Directory where the Pango headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pango-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-pango-lib</option>
+ </entry>
+ <entry>
Directory where the Pango library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-atk-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-atk-incl</option>
+ </entry>
+ <entry>
Directory where the ATK headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-atk-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-atk-lib</option>
+ </entry>
+ <entry>
Directory where the ATK library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pthread-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-pthread-incl</option>
+ </entry>
+ <entry>
Directory where the Pthread headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-pthread-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-pthread-lib</option>
+ </entry>
+ <entry>
Directory where the Pthread library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-agg-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-agg-incl</option>
+ </entry>
+ <entry>
Directory where the AGG (Antigrain) headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-agg-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-agg-lib</option>
+ </entry>
+ <entry>
Directory where the AGG (Antigrain) library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ffmpeg-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-ffmpeg-incl</option>
+ </entry>
+ <entry>
Directory where the FFMPEG headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-ffmpeg-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-ffmpeg-lib</option>
+ </entry>
+ <entry>
Directory where the FFMPEG library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-boost-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-boost-incl</option>
+ </entry>
+ <entry>
Directory where the Boost headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-boost-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-boost-lib</option>
+ </entry>
+ <entry>
Directory where the Boost library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-curl-incl</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-curl-incl</option>
+ </entry>
+ <entry>
Directory where the libCurl headers are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-curl-lib</term>
- <listitem>
- <para>
+ </entry>
+ </row><row>
+ <entry>
+ <option>--with-curl-lib</option>
+ </entry>
+ <entry>
Directory where the libCurl library is installed.
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
+ </entry>
+</row>
+</tbody>
+</tgroup>
+</table>
Index: feature_configuration.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/feature_configuration.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- feature_configuration.xml 1 Aug 2007 05:04:23 -0000 1.13
+++ feature_configuration.xml 16 Aug 2007 14:27:35 -0000 1.14
@@ -4,106 +4,84 @@
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>
-<emphasis>--enable-gui</emphasis> lets you specify your GUI of choice.
+<option>--enable-gui</option> lets you specify your GUI of choice.
The default option is GTK.
</para>
</listitem>
<listitem>
<para>
-<emphasis>--enable-renderer</emphasis> allows a renderer to be
+<option>--enable-renderer</option> allows a renderer to be
chosen. The default renderer is OpenGL.
</para>
</listitem>
<listitem>
<para>
-<emphasis>--enable-media</emphasis> permits a media handler to be
+<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>
-<variablelist>
- <varlistentry>
- <term>--enable-debugger</term>
- <listitem>
- <para>
- Enable 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-docbook</term>
- <listitem>
- <para>
- Enable the generation of html and pdf versions of the documentation
- from the XML. You will then be able to use "make html" and "make pdf".
- </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>
-
- <varlistentry>
- <term>--disable-fork</term>
- <listitem>
- <para>
- Disable the plugin forking the standalone player, and
+<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 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
+ 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 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>
+ 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>
@@ -120,7 +98,7 @@
<para>
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.
+ regardless of whether it is also in charge of the GUI.
</para>
</listitem>
</varlistentry>
@@ -156,168 +134,115 @@
</listitem>
</varlistentry>
</variablelist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-i810-lod-bias</term>
- <listitem>
- <para>
- Enable fix for Intel 810 LOD bias problem. Older versions
+</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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--disable-klash</term>
- <listitem>
- <para>
- Disable support for Konqueror plugin. If
- <emphasis>--disable-plugin</emphasis> is not specified
+ fixed in newer versions (summer 2005) of libMesa.</entry>
+</row>
+<row>
+ <entry><option>--disable-klash</option></entry>
+ <entry>Disable support for Konqueror plugin. If
+ <option>--disable-plugin</option> is not 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>
+ the Mozilla/Firefox one.</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.
- <emphasis>FFMPEG</emphasis> is the default decoder.
+ <option>FFMPEG</option> is the default decoder.
</para>
<para>
You should only select one media decoder.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--disable-plugin</term>
- <listitem>
- <para>
- Enable building the plugin. By default the
+ </para></entry>
+</row>
+<row>
+ <entry><option>--disable-plugin</option>
+</entry>
+ <entry>Enable building the plugin. By default the
Mozilla Firefox plugin is built 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
+ files are found by configure. Specify the
+ <option>--with-plugindir=</option> option to specify where the
+ plugin should be installed.</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 don't have hardware accelerated
+ used when you do not have hardware accelerated
graphics. Typically most desktop machines have OpenGL
- support, and most embedded systems don't. OpenGl is the
+ 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.
- </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.
+ 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.
- </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-fps-debug</term>
- <listitem>
- <para>
- Enable FPS debugging code. When this feature is compiled in you can use
the -f switch of gnash
- to have FPS printed at regular intervals.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-write</term>
- <listitem>
- <para>
- Makes the Mozilla plugin write the currently playing SWF movie to /tmp.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-mit-shm</term>
- <listitem>
- <para>
- Add support for using the MIT-SHM X extensions when available.
+ 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>--enable-mit-shm</option>
+</entry>
+ <entry>Add support for using the MIT-SHM X extensions when available.
Currently only available using GTK gui and AGG renderer, and known to be
- bogus in handling of expose events
(http://savannah.gnu.org/bugs/?20301).
- </para>
- </listitem>
- </varlistentry>
-
-</variablelist>
+ bogus in handling of expose events
(http://savannah.gnu.org/bugs/?20301).</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
Index: install.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/install.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- install.xml 1 Aug 2007 05:04:58 -0000 1.4
+++ install.xml 16 Aug 2007 14:27:35 -0000 1.5
@@ -1,10 +1,11 @@
<title>Installation</title>
<para>
- Installation is done with the command:
+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>
@@ -40,7 +41,7 @@
<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 need to identify the path in one of two ways.
+ location, you must identify the path in one of two ways.
</para>
<para>
@@ -65,18 +66,14 @@
<title>Executables</title>
<para>
- The Mozilla plugin is installed into the <filename>plugins</filename>
- directory of the system
- installed <emphasis>Firefox</emphasis> or <emphasis>Mozilla</emphasis>,
- if development packages are installed for either of them.
- Otherwise, the default is <filename>~/.firefox/plugins</filename>.
+ The Mozilla plugin is installed in the <filename>plugins/</filename>
subdirectory of the Mozilla or Firefox application location if development
packages are installed for either browser. For example, if Firefox is
installed in the
<filename>/usr/lib/firefox-<replaceable><version></replaceable></filename>
directory, the plugin will be installed in
<filename>/usr/lib/firefox-<replaceable><version></replaceable>/plugins/</filename>
directory. If development packages are not installed for either, the default
location is <filename>~/.firefox/plugins</filename>.
You may also specify the plugin installation directory by using the
- <emphasis>--with-plugindir</emphasis> <link linkend="custompath">option
- to configure</link>.
+ <option>--with-plugindir</option> <link linkend="custompath">option
+ at configuration time</link>.
</para>
<para>
- The remaining executables will be installed in the <filename>bin</filename>
+ 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>.
@@ -93,10 +90,10 @@
</para>
<para>
- <emphasis>man</emphasis> and <emphasis>info</emphasis>
- will be installed in <filename>/usr/local/share/man</filename>
+ <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 <emphasis>--mandif</emphasis> or <emphasis>--infodir</emphasis>
+ the <option>--mandif</option> or <option>--infodir</option>
<link linkend="custompath">configuration options</link> are used.
</para>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash/doc/C/usermanual/installation building.xm...,
Melissa Goldin <=