gnash-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Gnash-commit] gnash ChangeLog doc/C/usermanual/installation/f...


From: Ann Barcomb
Subject: [Gnash-commit] gnash ChangeLog doc/C/usermanual/installation/f...
Date: Wed, 23 May 2007 19:36:36 +0000

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Ann Barcomb <ann>       07/05/23 19:36:36

Modified files:
        .              : ChangeLog 
        doc/C/usermanual/installation: feature_configuration.xml 
                                       configuration.xml 

Log message:
        doc/C/usermanual/installation/feature_configuration.xml :
           - Switched the order of 'feature' configuration options to match the
             one Martin introduced in commit 1.38 of doc/C/sources.xml.
           - Added some text about important configuration options from the same
             revision + document as above.
        
        doc/C/usermanual/installation/configuration.xml :
           - Replaces the example configuration with the 'smallest standalone 
example'
             from r1.38 of doc/C/sources.xml.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.3323&r2=1.3324
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/feature_configuration.xml?cvsroot=gnash&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/configuration.xml?cvsroot=gnash&r1=1.2&r2=1.3

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.3323
retrieving revision 1.3324
diff -u -b -r1.3323 -r1.3324
--- ChangeLog   23 May 2007 18:59:43 -0000      1.3323
+++ ChangeLog   23 May 2007 19:36:35 -0000      1.3324
@@ -1,3 +1,9 @@
+2007-05-23 Ann Barcomb <address@hidden>
+
+       * doc/C/usermanual/installation/feature_configuration.xml,
+         doc/C/usermanual/installation/configuration.xml: Incorporated
+         some changes from r1.38 of doc/C/sources.xml.
+
 2007-05-23 Sandro Santilli <address@hidden>
 
        * testsuite/misc-ming.all/: Makefile.am, loop_test6.c:

Index: doc/C/usermanual/installation/feature_configuration.xml
===================================================================
RCS file: 
/sources/gnash/gnash/doc/C/usermanual/installation/feature_configuration.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation/feature_configuration.xml     22 May 2007 
16:30:53 -0000      1.2
+++ doc/C/usermanual/installation/feature_configuration.xml     23 May 2007 
19:36:36 -0000      1.3
@@ -1,70 +1,59 @@
-  <title>Features</title>
-<para>TODO - review this section</para>
-      <variablelist>
-       <varlistentry>
-         <term>--disable-fork</term>
+<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:
+  <itemizedlist mark="opencircle">
          <listitem>
            <para>
-             Disable the plugin forking the standalone player, and
-             using a thread for the player instead. Currently forking
-             the standalone player will give you the best results.
+      <emphasis>--enable-gui</emphasis> lets you specify your GUI of choice.
+      The default option is GTK.
            </para>
          </listitem>
-       </varlistentry>
-       
-       <varlistentry>
-         <term>--enable-plugin</term>
          <listitem>
            <para>
-             Enable building the plugin. By default the
-             Mozilla Firefox plugin won't be built, even if all the required
-             files are found by configure. Configure
-             <emphasis>--with-plugindir=</emphasis> to specify where the
-             plugin should be installed. 
+      <emphasis>--enable-renderer</emphasis> allows a renderer to be
+      chosen.  The default renderer is AGG.
            </para>
          </listitem>
-       </varlistentry>
-
-       <varlistentry>
-         <term>--disable-glext</term>
          <listitem>
            <para>
-             Disable using GtkGlExt, which forces the use of SDL
-             instead. By default if the GtkGL extension for Gtk is found
-             by configure, the GTK enabled GUI is built.
+      <emphasis>--enable-media</emphasis> permits a media handler to be
+      selected.  The default is FFMPEG with SDL sound.
            </para>
          </listitem>
-       </varlistentry>
+  </itemizedlist>
+  A complete list of available features follows.
+</para>
 
+<para>TODO - review this section</para>
+      <variablelist>
        <varlistentry>
-         <term>--disable-klash</term>
+         <term>--disable-debugger</term>
          <listitem>
            <para>
-             Disable support for Konqueror plugin. If
-             <emphasis>--enable--plugin</emphasis> is  specified, and
-             support for building KDE programs is found, Klash is
-             built by default. This option limits the plugin to only
-             the Mozilla/Firefox one.
+             Disable support for the Flash debugger. The debugger is
+             mainly of interest to Flash developers.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--disable-debugger</term>
+         <term>--enable-dmalloc</term>
          <listitem>
            <para>
-             Disable support for the Flash debugger. The debugger is
-             mainly of interest to Flash developers.
+             Enable support for the DMalloc memory debugging tool.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-libsuffix</term>
+         <term>--enable-dom</term>
          <listitem>
            <para>
-             /lib directory suffix (64,32,none=default). This is only
-             used by Klash.
+             When using the XML library, parse the messages using a
+             DOM based parser. This is the default.
            </para>
          </listitem>
        </varlistentry>
@@ -80,121 +69,164 @@
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-qtopia</term>
+         <term>--disable-fork</term>
          <listitem>
            <para>
-             Link to Qt-embedded, link to the Qtopia
-             Environment. This is only used by Klash.
+             Disable the plugin forking the standalone player, and
+             using a thread for the player instead. Currently forking
+             the standalone player will give you the best results.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-mac</term>
+         <term>--enable-ghelp</term>
          <listitem>
            <para>
-             Link to Qt/Mac (don't use X). This is only used by
-             Klash. 
+             Enable support for the GNOME help system.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-sdk-install</term>
+         <term>--disable-glext</term>
          <listitem>
            <para>
-             Enable installing the libraries and headers as an SDK.
+             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-testing</term>
+         <term>--enable-gui=gtk|sdl|kde|fltk|fb</term>
          <listitem>
            <para>
-             Enable testing-specific methods.
+             Select the Graphic User Interface to use (just one at a time 
please).
            </para>
+           <varlistentry>
+             <term>GTK</term>
+             <listitem>
+               The GTK+ toolkit, which is the default GUI.
+               Said to interwork particularly well with firefox.
          </listitem>
        </varlistentry>
-
        <varlistentry>
-         <term>--enable-strict</term>
+             <term>SDL</term>
          <listitem>
-           <para>
-             Turn on tons of GCC compiler warnings. By default only
-             <emphasis>-Wall</emphasis> is used with GCC.
-           </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.
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term>KDE</term>
+             <listitem>
+               An interface adapted to the KDE Desktop Environment.
+               This must be selected when building the Konqueror plugin
+               "klash". Furthermore, the only renderer that currently
+               works with KDE is opengl.
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term>FLTK</term>
+             <listitem>
+               Fast Light ToolKit, low on resource usage.
+               Since all build using fltk are now broken, we declare it
+               "for developers".
+             </listitem>
+           </varlistentry>
+           <varlistentry>
+             <term>FB</term>
+             <listitem>
+               The Linux Frame Buffer, also known as /dev/fb0.
+               AGG is the only renderer that can currently be used
+               with the framebuffer GUI.
+             </listitem>
+           </varlistentry>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-ghelp</term>
+         <term>--enable-i810-lod-bias</term>
          <listitem>
            <para>
-             Enable support for the GNOME help system.
+             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>--enable-dom</term>
+         <term>--disable-klash</term>
          <listitem>
            <para>
-             When using the XML library, parse the messages using a
-             DOM based parser. This is the default.
+             Disable support for Konqueror plugin. If
+             <emphasis>--enable--plugin</emphasis> is  specified, and
+             support for building KDE programs is found, Klash is
+             built by default. This option limits the plugin to only
+             the Mozilla/Firefox one.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-xmlreader</term>
+         <term>--enable-libsuffix</term>
          <listitem>
            <para>
-             When using the XML library, parse the messages using a
-             SAX based parser.
+             /lib directory suffix (64,32,none=default). This is only
+             used by Klash.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-dmalloc</term>
+         <term>--enable-mac</term>
          <listitem>
            <para>
-             Enable support for the DMalloc memory debugging tool.
+             Link to Qt/Mac (don't use X). This is only used by
+             Klash. 
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-i810-lod-bias</term>
+         <term>--enable-media=ffmpeg|mad|gst</term>
          <listitem>
            <para>
-             Enable fix for Intel 810 LOD bias problem. Older versions
-             of libMesa on the Intel i810 or i815 graphics processor
-             need this flag or Gnash will core dump. This has been
-             fixed in newer versions (summer 2005) of libMesa.
+             Select the specified media decoder and sound engine.
+             FFMPEG and MAD use the SDL sound engine; GST uses its own.
+              Mixing this with --enable-sound=gst is invalid. Using
+             <emphasis>ffmpeg</emphasis> is the default decoder.
+           </para>
+           <para>
+             You should only select one media decoder.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--enable-sound=gst|sdl</term>
+         <term>--enable-plugin</term>
          <listitem>
            <para>
-             Enable support for the a sound handing system. Currently
-             only <emphasis>sdl</emphasis> works sufficiently. This
-             is enabled by default when building Gnash.
+             Enable building the plugin. By default the
+             Mozilla Firefox plugin won't be built, even if all the required
+             files are found by configure. Configure
+             <emphasis>--with-plugindir=</emphasis> to specify where the
+             plugin should be installed. 
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>--with-mp3-decoder=ffmpeg|mad</term>
+         <term>--enable-qtopia</term>
          <listitem>
            <para>
-             Specified the MP3 decoder to use with sdl sound handler.
-              Mixing this with --enable-sound=gst is invalid. Using
-             <emphasis>mad</emphasis> is the default decoder.
+             Link to Qt-embedded, link to the Qtopia
+             Environment. This is only used by Klash.
            </para>
          </listitem>
        </varlistentry>
@@ -216,52 +248,53 @@
          </listitem>
        </varlistentry>
 
-      </variablelist>
-      
+       <varlistentry>
+         <term>--enable-sdk-install</term>
+         <listitem>
       <para>
-       You can control other flags used for compiling using
-       environment variables. Set these variables before configuring,
-       and they will be used by the configure process instead of the
-       default values.
+             Enable installing the libraries and headers as an SDK.
       </para>
+         </listitem>
+       </varlistentry>
 
-      <variablelist>
        <varlistentry>
-         <term>CXX</term>
+         <term>--disable-shared</term>
          <listitem>
            <para>
-             C++ compiler command.
+             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>LDFLAGS</term>
+         <term>--enable-strict</term>
          <listitem>
            <para>
-             linker flags, e.g. -L[library directory] if you have libraries in 
a
-             nonstandard directory.
+             Turn on tons of GCC compiler warnings. By default only
+             <emphasis>-Wall</emphasis> is used with GCC.
            </para>
          </listitem>
        </varlistentry>
        
        <varlistentry>
-         <term>CPPFLAGS</term>
+         <term>--enable-testing</term>
          <listitem>
            <para>
-             C/C++ preprocessor flags, e.g. -I[headers directory] if you have
-             headers in a nonstandard directory.
+             Enable testing-specific methods.
            </para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term>CXXFLAGS</term>
+         <term>--enable-xmlreader</term>
          <listitem>
            <para>
-             C++ compiler flags.
+             When using the XML library, parse the messages using a
+             SAX based parser.
            </para>
          </listitem>
        </varlistentry>
-      </variablelist>
 
+      </variablelist>

Index: doc/C/usermanual/installation/configuration.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/configuration.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation/configuration.xml     22 May 2007 16:30:53 
-0000      1.2
+++ doc/C/usermanual/installation/configuration.xml     23 May 2007 19:36:36 
-0000      1.3
@@ -30,10 +30,12 @@
   <programlisting>
   ./configure &lt;options&gt;
   </programlisting>
-  The example below shows running <emphasis>configure</emphasis>
-  from the &app; source root directory, with several options specified:
+  The example below shows the <emphasis>configure</emphasis> options
+  which create the smallest working standalone version of &app;.  In
+  this example, <emphasis>configure</emphasis> is being run from the
+  source root directory:
   <programlisting>
-  ./configure --disable-sound --disable-klash 
--with-docbook-styles=/opt/local/share/xsl/docbook-xsl --enable-docbook 
--enable-gui=fltk --enable-renderer=agg
+  ./configure --disable-debugger --disable-cygnal --disable-docbook 
--disable-plugin --enable-media=mad --enable-gui=sdl
   </programlisting>
 </para>
 




reply via email to

[Prev in Thread] Current Thread [Next in Thread]