[Gnash-commit] gnash README README_CVS ChangeLog po/.cvsignore

[John Gilmore]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     John Gilmore <jgilmore> 07/04/26 02:45:51

Modified files:
        .              : README README_CVS ChangeLog 
        po             : .cvsignore 

Log message:
        * README, README_CVS:  Improve configuration instructions.
          More work is needed to make it match the code.
        * po/.cvsignore:  Ignore all generated .gmo files.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/README?cvsroot=gnash&r1=1.26&r2=1.27
http://cvs.savannah.gnu.org/viewcvs/gnash/README_CVS?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.2996&r2=1.2997
http://cvs.savannah.gnu.org/viewcvs/gnash/po/.cvsignore?cvsroot=gnash&r1=1.1&r2=1.2

Patches:
Index: README
===================================================================
RCS file: /sources/gnash/gnash/README,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -b -r1.26 -r1.27
--- README      20 Apr 2007 11:41:26 -0000      1.26
+++ README      26 Apr 2007 02:45:51 -0000      1.27
@@ -1,4 +1,4 @@
-$Id: README,v 1.26 2007/04/20 11:41:26 jgilmore Exp $
+$Id: README,v 1.27 2007/04/26 02:45:51 jgilmore Exp $
 
                    Gnash: the GNU Flash Player
 
@@ -7,7 +7,7 @@
 plugin, or as a library used by other programs.  It is not yet complete;
 it does not correctly handle every .swf file.
 
-This is the README file for the soon to be released Gnash-0.7.2.
+This is the README file for the Gnash-0.8XXXXXX release (or CVS snapshot).
 
 Gnash is originally based on the code of GameSWF, by Thatcher Ulrich.
 GameSWF was the most advanced among free flash movie players; it
@@ -52,13 +52,9 @@
 Unimplemented Opcodes are: Throw, Implements, Extends, EnumObject, Try,
 NewMethod, MDLength, MDSubstring, MDChr, Delete, GetTarget.
 
-There is currently no FLV video, only minimal AMF data support,
+There is currently some FLV video support, only minimal AMF data support,
 and no loading of external jpegs.
 
-There is now experimental sound support if you configure this into
-your build. What works now is the sdl sound handler with either the
-ffmpeg or libMad decoder.
-
 Plugin:        
 -------
 
@@ -72,10 +68,10 @@
 in Firefox, which prevents the plugin from being loaded. In these cases
 I "view source" and then use wget to grab the movie for testing.
 
-By default, the configure script looks for the GtkGl extension, and if
-that can't be found, it defaults to using SDL. The plugin works by
-using the standalone player, so which ever graphics library Gnash
-uses, it's the same as the standalone player.
+By default, the configure script looks for the GtkGl extension, and
+if that can't be found, it defaults to using SDL. The plugin works by
+forking and running the standalone player, so whichever graphics library
+Gnash uses will also be used by the plugin.
 
 The GTK version has full event handling, and supports a right-click
 mouse menu to control the movie. The SDL version has no event
@@ -84,26 +80,36 @@
 boundaries. The GTK version requires GtkGlExt, and defaults to SDL if
 GtkGlExt is not installed, or if --disable-glext is passed to configure.
 
-All Flash movies are downloaded in full to /tmp, and then played from there.
-Gnash is not yet able to play a Flash file "as it arrives" over the
-network. Adding the ability to handle input streams is on the TODO list.
-
 Configure with --with-plugindir= to set the directory that "make
 install" will install the plugin in. By default it will be installed
-in the users .mozilla/plugins or .firefox/plugins directory.
+in the user's .mozilla/plugins or .firefox/plugins directory.
 
 
 Building Gnash:
 ---------------
 
-See the generic installation instructions in the file called
-"INSTALL". As the configure script is not included in CVS, you need to
-run ./autogen.sh to produce this file. This depends on having
-autoconf, automake, and libtool installed on your system. After
-producing the configure script, executing it as "./configure" should
-be all that is necessary to buuild Gnash.
+See the generic installation instructions in the file called "INSTALL".
+(If you are building from a fresh CVS checkout, first see the file
+"README_CVS" for additional instructions.)
+
+Gnash can be configured and built in three main variations.  They
+differ in the graphics and multimedia libraries used to display
+flash files.  The three variants are configured with the options:
+
+   --enable-renderer=opengl
+   --enable-renderer=cairo
+or --enable-renderer=agg
+
+Only one can be specified.  In addition, Gnash can use different multimedia
+back-ends for sound and/or video:
+
+   --enable-media=GST                  Gstreamer
+   --enable-media=ffmpeg               Ffmpeg
+   --enable-media=mad                  libmad (MP3 audio decoding only)
+
+The "media" setting is independent of the "renderer" setting.
 
-You will also need the following development packages installed to
+You will need the following development packages installed to
 build the player with GTK support: glib, atk, pango, cairo, gtk2,
 gtkglext.
 
@@ -111,25 +117,22 @@
 dependent packages: OpenGL(libMesa), SDL.
 
 The GTK support is more developed and featureful, while the SDL
-support has less dependancies on other packages.
+support has fewer dependancies on other packages.
 
-Other required packages are libxml2, libpng, libjpeg, and gettext.
-If gettext is missing, gnash will compile, but you'll get errors when
-trying to build or install its message translations in the po/ directory.
+Other required packages are libxml2, libpng, and libjpeg.
+If gettext support is installed, or is present in the standard C library,
+gnash will support translation of its messages into other languages.
 
 At this time the sound support is experimental until the new sound
 support is completed. This will support both Gstreamer and
-ffmpeg. Current the ffmpeg support is the only one that works, and
-this only works with the sdl sound support.
+ffmpeg.
 
-When the Gstreamer support is working, Gstreamer version 0.10 will be
-required becasue earlier versions wouldn't let you insert clips into
-an existing sound stream as Gnash needs to do.
+Gstreamer version 0.10 is required because earlier versions wouldn't
+let you insert clips into an existing sound stream, as Gnash needs to do.
 
 You no longer need the Mozilla or Firefox development packages to
-build Gnash. All the required files are now included in Gnash so the
-plugin can be built as long as the other development libraries are
-installed.
+build Gnash. All the required files are now included in Gnash, so the
+plugin can be built whenever the main gnash program can be built.
 
 To build Klash, the Konqueror plugin, you need to have the KDE
 development packages installed. This now installs a KDE executable
@@ -170,10 +173,10 @@
 For information about contributing to the GNU Project, please read How
 to help GNU at <http://www.gnu.org/help/help.html>.
 
-If you think you have found a bug in Gnash, then you should file as
-complete a report as possible at 
-https://savannah.gnu.org/bugs/?group=gnash.  Please include the
-operating system name and version, and which gnash version you are
-using, in your bug reports. Please try to reproduce your bug reports
-with Gnash cvs HEAD, as bugs are fixed there that may be broken in a
-standard release.
+If you think you have found a bug in Gnash, then
+you should file as complete a report as possible at
+https://savannah.gnu.org/bugs/?group=gnash.  Please include the operating
+system name and version, and which gnash version you are using, in your
+bug reports. Please try to reproduce your bug reports with the most
+recent version of Gnash in CVS, as bugs are fixed there that may be
+broken in a standard release.

Index: README_CVS
===================================================================
RCS file: /sources/gnash/gnash/README_CVS,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- README_CVS  25 Apr 2007 17:29:30 -0000      1.1
+++ README_CVS  26 Apr 2007 02:45:51 -0000      1.2
@@ -1,22 +1,58 @@
-$Id: README_CVS,v 1.1 2007/04/25 17:29:30 strk Exp $
+$Id: README_CVS,v 1.2 2007/04/26 02:45:51 jgilmore Exp $
 
-Using Gnash CVS repository.
+               Building Gnash from its CVS repository
 
-Building gnash from CVS requires the following additional packages:
+The source code of Gnash is checked into a CVS repository.  (See the main
+web page for Gnash for the current details on where that repository is.)
+The instructions for building Gnash in README and INSTALL assume that
+you are starting from a released "tarball" (e.g. gnash-VERSION.tar.gz).
+The tarball contains some files that are not in the original source code
+in CVS.  They are generated using tools that not everyone is expected
+to have.  This simplifies the process of building Gnash releases, for
+ordinary people.
 
-       - automake (version?)
-       - autoheader (version?)
-       - aclocal (version?)
-       - autoconf (version?)
-       - intltool (version?)
-       - xml-i18n-toolize (version?)
-       - libtool (version?)
-       - glib-gettextize (version?)
-       - libltdl (version?)
-
-All the above tools are used by the ./autogen.sh script, which you'd run
-to setup the build scripts as they are distributed.
-If anything is missing, autogen.sh should tell you.
+People who are actively working on maintaining Gnash need to have these
+extra tools.  They are used to build configuration files, international
+message translation catalogs, and such.  After you check out the source
+code of Gnash from CVS, you'll have to run a single script that rebuilds
+all these files.  This script is called "./autogen.sh", and it lives
+in the top-level directory of gnash.  You run it without any arguments.
+When it finishes, you can run "./configure", with or without arguments,
+as instructed in the README and INSTALL files.
 
-Once ./autogen.sh completes successfully you can go on with normal
+A variety of GNU programs are required when checking out the
+CVS tree and building the auto-generated files.  If anything is
+missing, ./autogen.sh will (probably) tell you, or produce a relatively
+understandable error message.  When in doubt, look at the *first*
+error message.  Here are the programs required:
+
+GNU            Minimum         RPM or DEB package names:
+Package                Version  Debian         Ubuntu          Fedora          
Gentoo
+-------         -------  ------         ------          ------         ------
+automake       1.6.0   automake        automake        automake
+autoconf       2.59                    autoconf        autoconf
+cvs            1.11.22                 cvs             cvs
+gettext                0.14.6                  gettext         gettext
+libtool                1.5.22                  libtool         libtool
+               1.5.22                  libltdl3-dev    libtool
+
+The "Minimum Version" is not necessarily the lowest version that will work;
+it's the lowest version that the Gnash team has recently tested with.  
+(You'll also need some very common tools, for example the standard Unix/GNU
+core utilities (ls, mv); text utilities (grep, sed), and shell (sh).
+Unless your system is very unusual, these will already be installed.)
+
+The version dependencies among these tools are, unfortunately, more
+complicated than we can describe here.  When ./autogen.sh is failing
+for you, either upgrade all the things in the above table to the latest
+version available (which may break other packages you're trying to build),
+or seek a compatible set of tools, perhaps the set that comes by default
+in your operating system (if any).
+
+If you are unable to run ./autogen.sh successfully on your system, consider
+building Gnash from a tarball release.  Or, move the CVS tree to a system
+on which you can run ./autogen.sh successfully, then move it back to the
+system you are trying to build on.
+
+Once ./autogen.sh completes successfully, you can go on with the normal
 instructions found in the README file.

Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.2996
retrieving revision 1.2997
diff -u -b -r1.2996 -r1.2997
--- ChangeLog   25 Apr 2007 17:29:29 -0000      1.2996
+++ ChangeLog   26 Apr 2007 02:45:51 -0000      1.2997
@@ -1,3 +1,9 @@
+2007-04-25  John Gilmore  <address@hidden>
+
+       * README, README_CVS:  Improve configuration instructions.
+         More work is needed to make it match the code.
+       * po/.cvsignore:  Ignore all generated .gmo files.
+
 2007-04-25 Sandro Santilli <address@hidden>
 
        * README_CVS: some info for CVS users.

Index: po/.cvsignore
===================================================================
RCS file: /sources/gnash/gnash/po/.cvsignore,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- po/.cvsignore       12 Apr 2007 09:53:08 -0000      1.1
+++ po/.cvsignore       26 Apr 2007 02:45:51 -0000      1.2
@@ -1,5 +1,5 @@
 Makefile
 Makefile.in
 POTFILES
-es.gmo
+*.gmo
 stamp-po