[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash ./ChangeLog doc/C/Makefile.am doc/C/gnash...
|
From: |
Rob Savoye |
|
Subject: |
[Gnash-commit] gnash ./ChangeLog doc/C/Makefile.am doc/C/gnash... |
|
Date: |
Sun, 29 Jan 2006 02:11:17 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Branch:
Changes by: Rob Savoye <address@hidden> 06/01/29 02:11:17
Modified files:
. : ChangeLog
doc/C : Makefile.am gnash.xml
Added files:
doc/C : appendix.xml sources.xml
Log message:
* doc/C/sources.xml: New file extracted from gnash.xml, and made a
standalone file since it's grown in size.
* doc/C/appendix.xml: New file for Appendicies content.
* doc/C/gnash.xml: Move some sections to separete files. Include
the new files.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/ChangeLog.diff?tr1=1.48&tr2=1.49&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/Makefile.am.diff?tr1=1.4&tr2=1.5&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/appendix.xml?rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/gnash.xml.diff?tr1=1.7&tr2=1.8&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/gnash/gnash/doc/C/sources.xml?rev=1.1
Patches:
Index: gnash/ChangeLog
diff -u gnash/ChangeLog:1.48 gnash/ChangeLog:1.49
--- gnash/ChangeLog:1.48 Sat Jan 28 23:14:46 2006
+++ gnash/ChangeLog Sun Jan 29 02:11:17 2006
@@ -1,5 +1,11 @@
2006-01-28 Rob Savoye <address@hidden>
+ * doc/C/sources.xml: New file extracted from gnash.xml, and made a
+ standalone file since it's grown in size.
+ * doc/C/appendix.xml: New file for Appendicies content.
+ * doc/C/gnash.xml: Move some sections to separete files. Include
+ the new files.
+
* doc/C/Makefile.am: Add pdf and info to SUFFIXES so the rules
actually work.
Index: gnash/doc/C/Makefile.am
diff -u gnash/doc/C/Makefile.am:1.4 gnash/doc/C/Makefile.am:1.5
--- gnash/doc/C/Makefile.am:1.4 Sat Jan 28 23:14:46 2006
+++ gnash/doc/C/Makefile.am Sun Jan 29 02:11:17 2006
@@ -45,6 +45,8 @@
SUFFIXES = .xml .html .texi .pdf .info .1
+gnash.xml: sources.xml internals.xml
+
.xml.html:
@echo "Making HTML from XML source..."
@if test x"$(XSLTPROC)" != x; then \
Index: gnash/doc/C/gnash.xml
diff -u gnash/doc/C/gnash.xml:1.7 gnash/doc/C/gnash.xml:1.8
--- gnash/doc/C/gnash.xml:1.7 Thu Jan 19 23:50:11 2006
+++ gnash/doc/C/gnash.xml Sun Jan 29 02:11:17 2006
@@ -4,11 +4,14 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY fdl-app SYSTEM "fdl-appendix.xml">
<!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.7">
- <!ENTITY date "December 2005">
+ <!ENTITY manrevision "0.2">
+ <!ENTITY date "January 2006">
<!ENTITY app "<application>Gnash</application>">
<!ENTITY appname "Gnash">
<!ENTITY version "0.7">
+ <!ENTITY appendix SYSTEM "appendix.xml">
+ <!ENTITY sources SYSTEM "sources.xml">
+ <!ENTITY internals SYSTEM "internals.xml">
]
>
@@ -49,7 +52,7 @@
&legal;
- <!-- This file contains link to license for the documentation (GNU FDL),
and
+ <!-- This file contains link to license for the documentation (GNU FDL),
and suzuka.arc.nasa.gov
other legal stuff such as "NO WARRANTY" statement. Please do not
change
any of this. -->
@@ -477,525 +480,10 @@
</sect2>
</sect1>
- <sect1 id="build">
- <title>Building From Source</title>
+ &sources;
+ &internals;
+ &appendix;
- <para>
- </para>
-
- <sect2 id="depend">
- <title>Dependancies</title>
-
- <para>
- Gnash has dependancies on other packages. When installing
- from a packaged release file (rpm, deb, whatever), you'll need
- to install the development versions to get the tools used to
- compile Gnash.
- </para>
-
- <sect3 id="opengl">
- <title>OpenGL</title>
- <para>
- Gnash uses OpenGL for rendering the images. OpenGL is a 3D
- graphics package that support hardware acceleration. You can
- get the free version of OpenGL at this link:
- <ulink type="http"
url="http://www.mesa3d.org";>http://www.mesa3d.org</ulink>
- </para>
- </sect3>
-
- <sect3 id="sdl">
- <title>SDL</title>
- <para>
- The Simple DirectMedia Layer is a cross-platform multimedia
- library designed to provide low level access to audio,
- keyboard, mouse, joystick, 3D hardware via OpenGL, and 2D
- video framebuffer. You can get SDL from this link:
- <ulink type="http"
url="http://www.libsdl.org";>http://www.libsdl.org</ulink>
- </para>
- </sect3>
-
- <sect3 id="libxml2">
- <title>libxml2</title>
- <para>
- Libxml2 is the GNOME XML parser library. This is used when
- Gnash is configured with XL support. Libxml2 is used to
- parse any incoming messages when using the XML or XMLSocket
- ActionScript classes. You can get libxml2 from this link:
- <ulink type="http"
url="http://xmlsoft.org";>http://xmlsoft.org</ulink>
- </para>
- </sect3>
-
- <sect3 id="mozilla">
- <title>Mozilla/Firefox</title>
- <para>
- To build the plugin, you need Mozilla/Firefox. You probably
- already have Firefox or Mozilla installed on your
- computer. If not, you can get Firefox from this link:
- <ulink type="http"
url="http://www.mozilla.org";>http://www.mozilla.org</ulink>
- </para>
- </sect3>
-
- </sect2>
-
- <sect2 id="configure">
- <title>Configuring</title>
-
- <para>
- Gnash uses GNU Autoconf (<ulink type="http"
- url="http://www.gnu.org/software/autoconf/";>
- http://www.gnu.org/software/autoconf</ulink>) for
- configuration. All the standard configure options apply.
- </para>
-
- <para>
- By default, `make install' will install all the files in
- `/usr/local/bin', `/usr/local/lib' etc. You can specify
- an installation prefix other than `/usr/local' using `--prefix',
- for instance `--prefix=$HOME'.
- </para>
-
- <para>
- Occasionally the default paths for a development package
- aren't correct. There is a series of options that can be used
- to adjust these paths to your own setup. By default, Gnash
- will look in all the standard places for these tools.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>--x-includes=DIR</term>
- <listitem>
- <para>
- X include files are in DIR.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--x-libraries=DIR</term>
- <listitem>
- <para>
- X library files are in DIR.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml=PFX</term>
- <listitem>
- <para>
- Prefix to where libxml is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-libraries=DIR</term>
- <listitem>
- <para>
- Directory where libxml library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-libxml-includes=DIR</term>
- <listitem>
- <para>
- Directory where libxml header files are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-firefox=PFX</term>
- <listitem>
- <para>
- Prefix where firefox is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-firefox-libraries=DIR</term>
- <listitem>
- <para>
- Directory where firefox library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-firefox-includes=DIR</term>
- <listitem>
- <para>
- Directory where firefox header files are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-docbook=DIR</term>
- <listitem>
- <para>
- Directory where the DocBook stylesheets are installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-sdl-prefix=PFX</term>
- <listitem>
- <para>
- Prefix where SDL is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-sdl_mixer-incl</term>
- <listitem>
- <para>
- Directory where sdl_mixer header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-sdl_mixer-lib</term>
- <listitem>
- <para>
- Directory where sdl_mixer library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-incl</term>
- <listitem>
- <para>
- Directory where zlib header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-zlib-lib</term>
- <listitem>
- <para>
- Directory where zlib library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-incl</term>
- <listitem>
- <para>
- Directory where jpeg header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-jpeg-lib</term>
- <listitem>
- <para>
- Directory where jpeg library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-incl</term>
- <listitem>
- <para>
- Directory where png header is installed.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--with-png-lib</term>
- <listitem>
- <para>
- Directory where png library is installed.
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
-
- <para>
- In addition to being able to specify your the directories for
- various sub components, there are also some switches that can
- be used at configuration time to enable or disable various
- featires of Gnash.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>--disable-xml</term>
- <listitem>
- <para>
- Disable support for XML. The default is to support
- XML.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-dom</term>
- <listitem>
- <para>
- When using the XML library, parse the messages using a
- DOM based parser. This is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-xmlreader</term>
- <listitem>
- <para>
- When using the XML library, parse the messages using a
- SAX based parser.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-plugin</term>
- <listitem>
- <para>
- Enable support for being a plugin. This is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-dmalloc</term>
- <listitem>
- <para>
- Enable support for the DMalloc memory debugging tool.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>--enable-i810-lod-bias</term>
- <listitem>
- <para>
- Enable fix for Intel 810 LOD bias problem. Older version
- 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>
-
-
- </variablelist>
-
- <para>
- You can control other flags used for compiling using
- environment variables. Set these variables before configuring,
- and they will be used by the configure process instead of the
- default values.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>CXX</term>
- <listitem>
- <para>
- C++ compiler command.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>LDFLAGS</term>
- <listitem>
- <para>
- linker flags, e.g. -L[library directory] if you have libraries in
a
- nonstandard directory.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CPPFLAGS</term>
- <listitem>
- <para>
- C/C++ preprocessor flags, e.g. -I[headers directory] if you have
- headers in a nonstandard directory.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CXXFLAGS</term>
- <listitem>
- <para>
- C++ compiler flags.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </sect2>
-
- <sect2 id="install">
- <title>Installation</title>
-
- <para>
- Gnash installs it's libraries so they can be found in the
- runtime path for the Gnash executable. Unless the --prefix
- option is used at configuration time, the libraries get
- installed in /usr/local/lib. If you install Gnash in a
- non-standard location, you have to specify this runtime path
- by one of two means.
- </para>
-
-
- <para>
- The traditional way that works on all Unix platforms is to set
- the LD_LIBRARY_PATH environment variable to $prefix/lib. You
- can have multiple paths in this variable as long as they are
- seperated by a colon ":" character.
- </para>
-
- <para>
- For GNU/Linux systems, the custom path to the libraries can be
- added to the /etc/ld.so.conf file. After adding the custom
- path, then run (as root) the <code>ldconfig</code> command to
- update the runtime cache.
- </para>
-
- </sect2>
-
- </sect1>
-
- <sect1 id="code">
- <title>Code Overview</title>
-
- <para>
- The top level of Gnash has three libraries, <code>libbase</code>,
- <code>libgeometry</code>, and <code>libserver</code>. There are
- two utility programs included for debug parsing and processing
- of Flash movie files to test the Actionscript interpreter. There
- is also a standalone flash movie player.
- </para>
-
- <sect2 id="The Libraries">
- <title>The Libraries</title>
-
- <sect3 id="libbase">
- <title>libbase</title>
-
- <para>
- Libbase contains support classes used by the rest of the
- code. Among these classes is a small and efficient STL library
- clone that uses smart pointers. This helps isolate the
- problems that arise when using non GNU C Compilers that aren't
- compliant with the ANSI C++ standard.
- </para>
-
- <para>
- Gnash makes heavy use of smart pointers, so memory allocations
- are freed up automatically by the interpreter.
- </para>
-
- </sect3>
-
- <sect3 id="libgeometry">
- <title>libgeometry</title>
-
- <para>
- Libgeometry contains code for device independant graphics routines.
- </para>
-
- </sect3>
-
- <sect3 id="libserver">
- <title>libserver</title>
-
- <para>
- Libserver is the guts of the interpreter itself. This is where
- all the new ActionScript classes get defined, and the main
- code for the interpreter lives.
- </para>
- </sect3>
- </sect2>
-
- <sect2 id="apps">
- <title>The Applications</title>
-
- <para>
- There are currently a few standalone programs in Gnash to
- assist with Gnash development, and to play a flash movie.
- </para>
-
- <sect3 id="Gnash">
- <title>Gnash</title>
-
- <para>
- This is the standalone OpenGL backend used to play
- movies. There are several command line options and keyboard
- control keys used by Gnash that <link linkend="usage"> are
- documented here.</link>
- </para>
-
- </sect3>
-
- <sect3 id="parser">
- <title>Gparser</title>
-
- <para>
- Gparser use the Gnash parser to dissamble the flash
- movie, and dumps the object types, the depth, and other
- information to make sure Gnash is parsing the file
- correctly.
- </para>
-
- </sect3>
- <sect3 id="processor">
- <title>Gprocesser</title>
-
- <para>
- Gprocesser is used to print out the actions (using the -va
- option) or the parsing (using the -vp option) of a flash
- movie. It is also used to produce the <code>.gsc</code>
- files that Gnash uses to cache data, thereby speeding up the
- loading of files.
- </para>
-
- </sect3>
- </sect2>
-
- <sect2 id="plugin">
- <title>The Plugin</title>
-
- <para>
- The plugin is designed to work within Mozilla or Firefox. It
- currently doesn't use the latest plugin API additions, so it
- should work in older versions as well. The plugin uses the
- Mozilla plugin API to be cross platform, and portable.
- </para>
-
- <para>
- One future thought for the plugin is to use the new Firefox
- 1.5 or greater version of Firefox. This version has added a
- drawable canvas window that support hardware acceleration, and
- is desgined to support things like rendering diretly into the
- canvas without needing OpenGL.
- </para>
-
- </sect2>
-
- </sect1>
-
<!-- ============= Authors ================================ -->
<sect1 id="authors">
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash ./ChangeLog doc/C/Makefile.am doc/C/gnash...,
Rob Savoye <=