[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc Makefile.am C/Makefile.am C/gnash.xml...
|
From: |
Rob Savoye |
|
Subject: |
[Gnash-commit] gnash/doc Makefile.am C/Makefile.am C/gnash.xml... |
|
Date: |
Wed, 20 Feb 2008 05:16:22 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Rob Savoye <rsavoye> 08/02/20 05:16:21
Modified files:
doc : Makefile.am
doc/C : Makefile.am gnash.xml sources.xml
doc/C/usermanual: introduction.xml specification.xml usage.xml
doc/C/usermanual/installation: code_dependencies.xml
cross_compiling.xml
documentation_dependencies.xml
testing_dependencies.xml
Added files:
doc/C/usermanual: acknowledgments.xml conventions.xml
Log message:
Beat back into a semblance of shape. Still needs massive work, but at
least
the chapters are in order.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/Makefile.am?cvsroot=gnash&r1=1.9&r2=1.10
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/Makefile.am?cvsroot=gnash&r1=1.47&r2=1.48
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnash.xml?cvsroot=gnash&r1=1.50&r2=1.51
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/sources.xml?cvsroot=gnash&r1=1.45&r2=1.46
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/introduction.xml?cvsroot=gnash&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/specification.xml?cvsroot=gnash&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/usage.xml?cvsroot=gnash&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/acknowledgments.xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/conventions.xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/code_dependencies.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.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/documentation_dependencies.xml?cvsroot=gnash&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/testing_dependencies.xml?cvsroot=gnash&r1=1.2&r2=1.3
Patches:
Index: Makefile.am
===================================================================
RCS file: /sources/gnash/gnash/doc/Makefile.am,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- Makefile.am 1 Jul 2007 10:53:57 -0000 1.9
+++ Makefile.am 20 Feb 2008 05:16:18 -0000 1.10
@@ -1,6 +1,6 @@
## Process this file with automake to generate Makefile.in
#
-# Copyright (C) 2005, 2006 Free Software Foundation, Inc.
+# Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Index: C/Makefile.am
===================================================================
RCS file: /sources/gnash/gnash/doc/C/Makefile.am,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -b -r1.47 -r1.48
--- C/Makefile.am 20 Feb 2008 01:43:07 -0000 1.47
+++ C/Makefile.am 20 Feb 2008 05:16:19 -0000 1.48
@@ -103,7 +103,8 @@
usermanual/usage.xml \
usermanual/usage/gnashrc.xml \
usermanual/bugreport.xml \
- usermanual/glossary.xml \
+ usermanual/acknowledgments.xml \
+ usermanual/conventions.xml \
$(NULL)
xml_files = $(docname).xml actionscript.xml
Index: C/gnash.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/gnash.xml,v
retrieving revision 1.50
retrieving revision 1.51
diff -u -b -r1.50 -r1.51
--- C/gnash.xml 20 Feb 2008 01:29:18 -0000 1.50
+++ C/gnash.xml 20 Feb 2008 05:16:19 -0000 1.51
@@ -11,11 +11,23 @@
<!ENTITY AS "ActionScript">
<!ENTITY legal SYSTEM "legal.xml">
- <!ENTITY fdl-app SYSTEM "fdl.xml">
+ <!ENTITY fdl-app SYSTEM "fdl-appendix.xml">
<!ENTITY amf SYSTEM "amf.xml">
<!ENTITY rtmp SYSTEM "rtmp.xml">
<!ENTITY programmers SYSTEM "app_authors.xml">
+ <!ENTITY extensions SYSTEM "extensions.xml">
+ <!ENTITY fileext SYSTEM "fileext.xml">
+ <!ENTITY gtkext SYSTEM "gtkext.xml">
+ <!ENTITY mysqlext SYSTEM "mysqlext.xml">
+ <!ENTITY internals SYSTEM "internals.xml">
+ <!ENTITY object SYSTEM "object.xml">
+ <!ENTITY plugin SYSTEM "plugin.xml">
+
+
+ <!ENTITY acknowledgments SYSTEM "usermanual/acknowledgments.xml">
+ <!ENTITY conventions SYSTEM "usermanual/conventions.xml">
+
<!ENTITY writers SYSTEM "usermanual/doc_authors.xml">
<!ENTITY revisionhistory SYSTEM "usermanual/revisions.xml">
<!ENTITY introduction SYSTEM "usermanual/introduction.xml">
@@ -42,7 +54,7 @@
<!-- TRANSLATOR NOTE: do not change the id, just the lang -->
-<book lang="en" id="index" status="draft">
+<book lang="en" id="index">
<title>Gnash Manual</title>
<titleabbrev>Gnash</titleabbrev>
@@ -65,7 +77,6 @@
-->
&legal;
- &writers;
&revisionhistory;
<releaseinfo>
@@ -77,23 +88,22 @@
<!-- ============= Introduction ============================== -->
&introduction;
- &specification;
<!-- ============= Document Body ============================= -->
-<!-- Logically, you must install Gnash
- before you can use it. -->
+ &usage;
&installation;
- &usage;
&bugreport;
+ &specification;
&glossary;
&rtmp;
<!-- ============= Authors =================================== -->
&programmers;
+<!-- &writers; -->
<!-- ============= Application License ======================= -->
&fdl-app;
Index: C/sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/sources.xml,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -b -r1.45 -r1.46
--- C/sources.xml 19 Feb 2008 02:13:22 -0000 1.45
+++ C/sources.xml 20 Feb 2008 05:16:19 -0000 1.46
@@ -32,15 +32,15 @@
configured and requires a total of about 25 megabytes to compile
it.
</para>
- <para>
- Gnash is known to compile for most any POSIX and ANSI C++
- conforming system if you have all the dependent libraries
- installed. Systems we test on, and which Gnash is know to
- run on are Ubuntu, Fedora, Debian, OpenBSD, NetBSD, FreeBSD,
- Win32, and Darwin (OSX) primarily. Occasionally other platforms
- are built, primarily by those distribution maintainers. This
- includes BeOS, Haiku, Syllable, OS/2, Solaris, Slackware, Gentoo.
- </para>
+<!-- <para> -->
+<!-- Gnash is known to compile for most any POSIX and ANSI C++ -->
+<!-- conforming system if you have all the dependent libraries -->
+<!-- installed. Systems we test on, and which Gnash is know to -->
+<!-- run on are Ubuntu, Fedora, Debian, OpenBSD, NetBSD, FreeBSD, -->
+<!-- Win32, and Darwin (OSX) primarily. Occasionally other platforms -->
+<!-- are built, primarily by those distribution maintainers. This -->
+<!-- includes BeOS, Haiku, Syllable, OS/2, Solaris, Slackware, Gentoo.
-->
+<!-- </para> -->
<para>
Continue reading for detailed step-by-step instructions of the
entire procedure. For Win32 users, you will need to install
@@ -1484,7 +1484,7 @@
<para>
There is also up to date information on the Gnash Developers
- weeb site at: <ulink type="http" url="http://www.gnashdev.org";>
+ 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>
@@ -1564,15 +1564,16 @@
<title>Compiling The Code</title>
<para>
- After configuring, typing <emphasis>make</emphasis> will compile the
- code. No options are necessary. If desired, you can redefine
- the variables used by <emphasis>make</emphasis> on the command line
- when invoking the program. The few flags of interest are
- <emphasis>CFLAGS</emphasis> and <emphasis>CXXFLAGS</emphasis>, often
used to
- turn on debugging or turn off optimizing. Invoking make as in
- this example would build all the code with debugging turned
- on, and optimizing turned off. The default values for both of
- these variables is <emphasis>-O2 -g</emphasis>.
+ After configuring, typing <emphasis>make</emphasis> will
+ compile the code. No options are necessary. If desired, you
+ can redefine the variables used by <emphasis>make</emphasis>
+ on the command line when invoking the program. The few flags
+ of interest are <emphasis>CFLAGS</emphasis> and
+ <emphasis>CXXFLAGS</emphasis>, often used to turn on debugging
+ or turn off optimizing. Invoking make as in this example would
+ build all the code with debugging turned on, and optimizing
+ turned off. The default values for both of these variables is
+ <emphasis>-O2 -g</emphasis>.
<programlisting>
make CFLAGS=-g CXXFLAGS=-g
@@ -1591,11 +1592,13 @@
<para>
By default, the documentation isn't built at all. It isn't
- even built when typing <emphasis>make install</emphasis> from the top
- level build directory. It's only built when specified with a
- specific target in the generated <emphasis>Makefile</emphasis> in the
- <emphasis>doc/C/</emphasis> sub-directory. All the documents are built
in
- this directory when executing a <emphasis>make install</emphasis>.
+ even built when typing <emphasis>make install</emphasis> from
+ the top level build directory. It's only built when specified
+ with a specific target in the generated
+ <emphasis>Makefile</emphasis> in the
+ <emphasis>doc/C/</emphasis> sub-directory. All the documents
+ are built in this directory when executing a <emphasis>make
+ install</emphasis>.
</para>
<para>
Index: C/usermanual/introduction.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/introduction.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- C/usermanual/introduction.xml 19 Feb 2008 02:06:30 -0000 1.4
+++ C/usermanual/introduction.xml 20 Feb 2008 05:16:20 -0000 1.5
@@ -4,72 +4,78 @@
<para>
&app; is a free SWF movie player. It is available as a
stand-alone application or as a plugin for several popular
- browsers.
+ web browsers. It supports playing media from a disk or streaming
+ over a network connection. Some popular video sharing sites like
+ YouTube are supported from a wide vaariety of devices from
+ embedded ones to modern desktops.
</para>
<para>
- &app; is based on the excellent work done on the public domain program
- <application>GameSWF</application>, which is a graphics library for
- games that contains the heart of a SWF interpreter. In December
- 2005, &app; was forked from <application>GameSWF</application> and
- repackaged in the GNU project style. The objective of &app; is to
- create an enterprise-quality SWF movie player that can be widely
- deployed.
+ &app; has a better focus on security, allowing the user tight
+ control of all network or disk based I/O. &app; also supports
+ extending ActionScript by creating your own. You can write
+ wrappers for any development library, and import them into the
+ player much like perl or python does.
</para>
+
<sect1 id="runs-on">
- <title>What does &app; run on?</title>
+ <title>What Is Supported ?</title>
<para>
- The list of successful &app; deployments grows every day. At this
- time, &app; has been found to run on several different UNIX and Linux
- distributions. The plugin currently works with any browser that uses
- the NSAPI. This includes:
+ &app; is known to compile for most any POSIX and ANSI C++
+ conforming system if you have all the dependent libraries
+ installed. Systems we test on, and which &app; is know to
+ run on are Ubuntu, Fedora, Debian, OpenBSD, NetBSD, FreeBSD,
+ Win32, and Darwin (OSX) primarily. Occasionally other platforms
+ are built, primarily by those distribution maintainers. This
+ includes BeOS, Haiku, Syllable, OS/2, Solaris, Slackware, and
+ Gentoo.
</para>
- <itemizedlist>
- <listitem>
- <para>Mozilla <ulink url="http://www.mozilla.org"; />
- </para>
- </listitem>
- <listitem>
- <para>Firefox <ulink url="http://www.mozilla.com/en-US/firefox"; />
- </para>
- </listitem>
- <listitem>
- <para>Galeon <ulink url="galeon.sourceforge.net" />
- </para>
- </listitem>
- <listitem>
- <para>Epiphany <ulink url="gnome.org/projects/epiphany" />
- </para>
- </listitem>
- <listitem>
- <para>Konqueror <ulink url="http://www.konqueror.org"; />
- </para>
- </listitem>
- <listitem>
- <para>Opera <ulink url="http://www.opera.com"; />
- </para>
- </listitem>
- <listitem>
- <para>OLPC Web Activity <ulink url="http://www.laptop.org"; />
+ <para>
+ Gnash is a capable of reading up to SWF v9 files and opcodes,
+ but primarily supports SWF v7, with better SWF v8 and v9
+ support under heavy developement. With the 0.8.2 release,
+ Gnash includes initial parser support for SWF v8 and v9.
+ Not all ActionScript 2 classes are implemented yet, but all of the
+ most heavily used ones are. Many ActionScript 2 classes are
+ partially implemented; there is support for all of the
+ commonly used methods of each class.
</para>
- </listitem>
- </itemizedlist>
- </sect1>
+ <para>
+ As ActionsScript 3 is a more developed version of
+ ActionScript 2, many of the same classes work for
+ both. Support has been added to Gnash's ActionScript library
+ to support the new ActionScript 3 filters, which get applied
+ to every class. Implementing ActionScript clases is often the
+ easiest way for new Gnash developers to make a contribution
+ without a deep internal knpowledge of Gnash.
+ </para>
- <sect1 id="flashsupport">
- <title>What Versions of Flash are Supported?</title>
+ <para>
+ Gnash has included video support since early 2007, but this is
+ an every changing field of reverse engineering. Many of the
+ popular video sharing sites use SWF v8 or v9, which Gnash
+ still has imperfect support for. This is improving all the
+ time, so often builds from a development snapshot will work
+ when using the older release packaged in your distribution
+ doesn't. You can find daily snapshots of the latest CVS tree
+ at: <ulink type="http" url="http://www.gnashdev.org/dev_snapshots/";>
+ http://www.gnashdev.org/dev_snapshots</ulink>.
+ </para>
<para>
- &app; supports the majority of Flash opcodes up to SWF version
- 7, and a wide sampling of ActionScript 2. Support for SWF v8 and
- v9 is under development, some sites already work. Support for
- ActionScript 3 is under development.
+ Gnash uses ffmpeg for codecs, so any file suppored by Mplayer
+ should work with Gnash. Gnash supports the loading of patent
+ free codecs like Ogg Vorbis or Theora from disk based files,
+ while work is being done to support these codecs when embedded
+ in a SWF file. Ffmpeg contains the codecs used by the current
+ SWF defintion, FLV, VP6 (ON2), H.263, H.264, and MP3.
</para>
</sect1>
+
<sect1 id="audience">
<title>Audience</title>
@@ -82,174 +88,7 @@
helpful.
</para>
- <para>
- Those who are new to &app; will find the <citetitle>&app; User's
- Guide</citetitle>, currently under development, to be more useful when
- learning to use &app;.
- </para>
- </sect1>
-
- <sect1 id="guide-conventions">
- <title>Guide Conventions</title>
-
- <para>
- This guide makes use of the following fairly standard typefaces,
- highlighting, and language usage:
- </para>
-
- <variablelist>
- <varlistentry>
- <term><application>application</application></term>
- <listitem>
- <para>
- The typeface above will be used whenever an application, such as
- <application>Firefox</application> or
- <application>OpenOffice.org</application>, is mentioned.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>command</command></term>
- <listitem>
- <para>
- The typeface above will be used whenever the text instructs a user
to
- enter a command at a shell prompt in UNIX/Linux, such as
- <command>ls</command>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><computeroutput>computeroutput</computeroutput></term>
- <listitem>
- <para>
- This is the typeface used to indicate information produced on
- <computeroutput>stdout</computeroutput> by the computer. This
include
- error messages and prompts.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><filename>filename</filename></term>
- <listitem>
- <para>
- This typeface indicates that the text is the name (and possibly the
- path) of a specific file on the system in question. For example,
- <filename>/etc/hosts</filename> would appear in this typeface.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guibutton>guibutton</guibutton></term>
- <listitem>
- <para>
- This formatting indicates a button on a Graphical User Interface
- (GUI). If this formatting appears, look for a button with the same
- text on the GUI of the &app; player; the button itself may look
- slightly different.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guimenu>guimenu</guimenu></term>
- <listitem>
- <para>
- This typeface indicates the topmost menu item in a GUI. For
example,
- in many applications the <guimenu>File</guimenu> menu item is a
- top=level menu item.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guimenuitem>guimenuitem</guimenuitem></term>
- <listitem>
- <para>
- This typeface indicates a sub-menu item in a GUI. For example, in
- many applications the <guimenuitem>Save As</guimenuitem> menu item
is
- a sub-menu item.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>guitext</guilabel></term>
- <listitem>
- <para>
- This typeface indicates a text string on the GUI. This is
generally a
- text string that appears on the GUI that is not a button or
menuitem.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><keycap>key</keycap></term>
- <listitem>
- <para>
- This typeface indicates a specific key on the keyboard. For
example,
- the <keycap>Ctrl</keycap> key appears in this typeface.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
-
<term><keycombo><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
- <listitem>
- <para>
- This formatting indicates a set of keys to be pressed at the same
- time. A familiar key combination is
-
<keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Delete</keycap></keycombo>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><replaceable><replaceable></replaceable></term>
- <listitem>
- <para>
- Whenever a general term is included in an example as a placeholder,
it
- will be signaled by this formatting. This formatting will usually
- appear inside other formatting. For example,
-
<filename>/home/<replaceable><username></replaceable></filename>
- indicates the home directory of a user, whose actual username would
be
- substituted in for <replaceable><username></replaceable>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><userinput>User input</userinput></term>
- <listitem>
- <para>
- This typeface indicates anything that the user must enter, whether
- that is at a shell prompt or in response to a GUI prompt.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
</sect1>
- <sect1 id="Acknowledgments">
- <title>Acknowledgments</title>
-
- <para>
- The first version of this guide was written by Rob Savoye. If not for
- his tireless efforts, this book - and this project - would never have
- come this far.
- </para>
-
- <para>
- John Steinhart has also been supportive of the project from the
- beginning. I have shamelessly plagiarized one of his early
- announcement emails in the early part of this chapter.
- </para>
-
- <para>
- Ann Barcomb was instrumental in taking this guide from the 0.3.0 to
- the 0.4.0 version, incorporating the many changes that came with &app;
- version 0.8.0.
- </para>
-
- <para>
- Finally, thanks to all of the &app; developers I haven't mentioned for
- all their hard work, and for answering my unending questions.
- </para>
- </sect1>
-
-
</chapter>
Index: C/usermanual/specification.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/specification.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- C/usermanual/specification.xml 19 Feb 2008 02:06:31 -0000 1.4
+++ C/usermanual/specification.xml 20 Feb 2008 05:16:20 -0000 1.5
@@ -8,6 +8,7 @@
url="http://www.gnashdev.org/wiki/index.php/Main_Page"; />.
</para>
+<!--
<sect1 id="spec-actionscript">
<title>&AS;</title>
@@ -23,8 +24,8 @@
implemented:
</para>
- <table frame='all'>
- <title>&AS; Classes</title>
+ <table frame='all' id="asclasses">
+ <title>ActionScript Classes</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname='Class'/>
<colspec colname='Status'/>
@@ -135,7 +136,7 @@
The next table indicates which opcodes have been implemented:
</para>
- <table frame='all'>
+ <table frame='all' id="opcodes">
<title>Opcodes</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname='Opcode'/>
@@ -212,6 +213,7 @@
</table>
</sect1>
+-->
<sect1 id="spec-memory">
<title>Memory Management</title>
Index: C/usermanual/usage.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/usage.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- C/usermanual/usage.xml 13 Feb 2008 14:58:46 -0000 1.7
+++ C/usermanual/usage.xml 20 Feb 2008 05:16:20 -0000 1.8
@@ -2,25 +2,35 @@
<title>Using &app;</title>
<para>
-When used as a standalone player, you can play any Flash file from the command
line by entering a command of the format:
-<programlisting>
-gnash <replaceable><option> <flashfile.swf></replaceable>
-</programlisting>
-The only required argument is the name (and location)of the file to be played.
- </para>
-
-<para>
- The available options are listed in the following section, or you may
view them in the terminal window by executing the following at the command line:
-<programlisting>
-gnash --help |less
-</programlisting>
- </para>
-
-<para>
-The source code download of &app; includes several example .SWF files. They
are located in the <filename>testsuite/samples/</filename> directory of the
&app; source directory. If you have installed &app; correctly, issuing the a
command similar to the following plays a short animation of a car swerving and
crashing:
-<programlisting>
-gnash
/home/<replaceable><username></replaceable>/gnash/testsuite/car_smash.swf
-</programlisting>
+ When used as a standalone player, you can play any Flash file from
+ the command line by entering a command of the format:
+ <programlisting>
+ gnash <replaceable><option> <flashfile.swf></replaceable>
+ </programlisting>
+ The only required argument is the name (and location)of the file
+ to be played.
+ </para>
+
+ <para>
+ The available options are listed in the following section, or you
+ may view them in the terminal window by executing the following at
+ the command line:
+ <programlisting>
+ gnash --help |less
+ </programlisting>
+ </para>
+
+ <para>
+ The source code download of &app; includes several example .SWF
+ files. They are located in the
+ <filename>testsuite/samples/</filename> directory of the &app;
+ source directory. If you have installed &app; correctly, issuing
+ the a command similar to the following plays a short animation of
+ a car swerving and crashing:
+ <programlisting>
+ gnash
+
/home/<replaceable><username></replaceable>/gnash/testsuite/car_smash.swf
+ </programlisting>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/car_crash.png"/>
@@ -28,40 +38,46 @@
</mediaobject>
</para>
-<para>
-The above is useful for playing Flash files downloaded to your local system.
It is also possible to play Flash files directly from the web. To do so, use
the <option>-u</option> option along with the URL of the desired file.
-<programlisting>
-gnash -u http://example.domain.com/flashfile.swf
-</programlisting>
-Note that this will not work with every website; some embedded Flash files are
difficult to play.
-</para>
+ <para>
+ The above is useful for playing Flash files downloaded to your
+ local system. It is also possible to play Flash files directly
+ from the web. To do so, use the <option>-u</option> option along
+ with the URL of the desired file.
+ <programlisting>
+ gnash -u http://example.domain.com/flashfile.swf
+ </programlisting>
+ Note that this will not work with every website; some embedded
+ Flash files are difficult to play.
+ </para>
<sect1 id="options">
<title>&app; Command Line Options</title>
<para>
- No options are required for &app;'s default behavior. However, there
are many options that can be used to that behavior.
+ No options are required for &app;'s default behavior. However,
+ there are many options that can be used to that behavior.
</para>
<para>
-<programlisting>
- gnash <replaceable><options></replaceable>
<filename>filename.swf</filename>
-</programlisting>
+ <programlisting>
+ gnash <replaceable><options></replaceable>
+ <filename>filename.swf</filename>
+ </programlisting>
</para>
<table id="tb-command-line-options">
-<title>Gnash Command Line 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>
+ <title>Gnash Command Line 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>-h</option></entry>
<entry>
Print usage information.
@@ -130,7 +146,7 @@
Be verbose about movie Actions.
</entry>
</row>
-<row>
+ <row>
<entry>
<option>-vp</option>
</entry>
@@ -179,7 +195,7 @@
</entry>
</row>
<row>
-<!--
+ <!--
<entry>
<option>-e</option>
</entry>
@@ -190,7 +206,7 @@
</entry>
</row>
<row>
--->
+ -->
<entry>
<option>-1</option>
</entry>
@@ -204,28 +220,28 @@
<option>-r [0|1|2|3]</option>
</entry>
<entry>
-<itemizedlist>
-<listitem>
-<para>
+ <itemizedlist>
+ <listitem>
+ <para>
0 disables rendering and sound (good for batch tests).
-</para>
-</listitem>
-<listitem>
-<para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
1 enables rendering and disables sound (default setting).
-</para>
-</listitem>
-<listitem>
-<para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
2 enables sound and disables rendering.
-</para>
-</listitem>
-<listitem>
-<para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
3 enables rendering and sound.
-</para>
-</listitem>
-</itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
</entry>
</row>
<row>
@@ -263,14 +279,14 @@
<entry>
Bit depth of output window (for example, 16 or 32). Appropriate
bit depths depend on the renderer and GUI library used.
-<!--
+ <!--
TODO: add information about which depths are suitable for each
renderer.
--->
+ -->
</entry>
</row>
<row>
-<entry>
+ <entry>
<option>-u url</option>
</entry>
<entry>
@@ -313,8 +329,8 @@
support javascript and target windows in geturl requests.
</entry>
</row>
-</tbody>
-</tgroup>
+ </tbody>
+ </tgroup>
</table>
</sect1>
@@ -329,19 +345,19 @@
</para>
<table id="tb-control-keys">
-<title>Gnash Interactive Control Keys</title>
-<tgroup cols='2' align='left' colsep='1' rowsep='1'>
-<colspec colname='Key Combination' />
-<colspec colname='Function' />
-<thead>
-<row>
-<entry>Key Combination</entry>
-<entry>Function</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry>
+ <title>Gnash Interactive Control Keys</title>
+ <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ <colspec colname='Key Combination' />
+ <colspec colname='Function' />
+ <thead>
+ <row>
+ <entry>Key Combination</entry>
+ <entry>Function</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
<option>CTRL-Q</option>
</entry>
<entry>
@@ -406,7 +422,7 @@
</entry>
</row>
-<!--
+ <!--
<entry>
<option>CTRL-A</option>
</entry>
@@ -415,7 +431,7 @@
</entry>
</row>
<row>
--->
+ -->
<entry>
<option>CTRL-T</option>
</entry>
@@ -447,11 +463,11 @@
Toggle the background color.
</entry>
</row>
-</tbody>
-</tgroup>
+ </tbody>
+ </tgroup>
</table>
</sect1>
&gnashrc;
- </chapter>
+</chapter>
Index: C/usermanual/installation/code_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/code_dependencies.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- C/usermanual/installation/code_dependencies.xml 19 Feb 2008 02:06:57
-0000 1.5
+++ C/usermanual/installation/code_dependencies.xml 20 Feb 2008 05:16:21
-0000 1.6
@@ -19,7 +19,7 @@
</para>
</note>
-<table frame='all'>
+<table frame='all' id="codedeps">
<title>Code Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
Index: C/usermanual/installation/cross_compiling.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/cross_compiling.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- C/usermanual/installation/cross_compiling.xml 16 Aug 2007 14:27:35
-0000 1.3
+++ C/usermanual/installation/cross_compiling.xml 20 Feb 2008 05:16:21
-0000 1.4
@@ -6,17 +6,48 @@
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> (if used), your
+ (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>
- Note that you may have some difficulties getting libMesa (opengl)
- to cross compile.
+ 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:
Index: C/usermanual/installation/documentation_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/documentation_dependencies.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- C/usermanual/installation/documentation_dependencies.xml 7 Jun 2007
14:11:26 -0000 1.3
+++ C/usermanual/installation/documentation_dependencies.xml 20 Feb 2008
05:16:21 -0000 1.4
@@ -4,7 +4,7 @@
The following packages are used to build &app;'s documentation.
</para>
-<table frame='all'>
+<table frame='all' id="docdeps">
<title>Documentation Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
Index: C/usermanual/installation/testing_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/testing_dependencies.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- C/usermanual/installation/testing_dependencies.xml 7 Jun 2007 14:11:26
-0000 1.2
+++ C/usermanual/installation/testing_dependencies.xml 20 Feb 2008 05:16:21
-0000 1.3
@@ -5,7 +5,7 @@
simply skip tests if the tools to run them are unavailable.
</para>
-<table frame='all'>
+<table frame='all' id="testdeps">
<title>Testing Dependency Table</title>
<tgroup cols='7' align='left' colsep='1' rowsep='1'>
<colspec colname='name'/>
Index: C/usermanual/acknowledgments.xml
===================================================================
RCS file: C/usermanual/acknowledgments.xml
diff -N C/usermanual/acknowledgments.xml
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ C/usermanual/acknowledgments.xml 20 Feb 2008 05:16:20 -0000 1.1
@@ -0,0 +1,35 @@
+ <sect1 id="Acknowledgments">
+ <title>Acknowledgments</title>
+
+ <para>
+ The first version of this guide was written by Rob Savoye. If not for
+ his tireless efforts, this book - and this project - would never have
+ come this far.
+ </para>
+
+ <para>
+ John Steinhart has also been supportive of the project from the
+ beginning. I have shamelessly plagiarized one of his early
+ announcement emails in the early part of this chapter.
+ </para>
+
+ <para>
+ Ann Barcomb was instrumental in taking this guide from the 0.3.0 to
+ the 0.4.0 version, incorporating the many changes that came with &app;
+ version 0.8.0.
+ </para>
+
+ <para>
+ &app; is based on the public domain program
+ <application>GameSWF</application>, which is a graphics library
+ for games that contains the heart of a SWF interpreter. In December
+ 2005, &app; was forked from <application>GameSWF</application> and
+ repackaged in the GNU project style, and a major recoding started.
+ </para>
+
+ <para>
+ Finally, thanks to all of the &app; developers I haven't mentioned for
+ all their hard work, and for answering my unending questions.
+ </para>
+ </sect1>
+
Index: C/usermanual/conventions.xml
===================================================================
RCS file: C/usermanual/conventions.xml
diff -N C/usermanual/conventions.xml
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ C/usermanual/conventions.xml 20 Feb 2008 05:16:20 -0000 1.1
@@ -0,0 +1,133 @@
+ <sect1 id="guide-conventions">
+ <title>Guide Conventions</title>
+
+ <para>
+ This guide makes use of the following fairly standard typefaces,
+ highlighting, and language usage:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><application>application</application></term>
+ <listitem>
+ <para>
+ The typeface above will be used whenever an application, such as
+ <application>Firefox</application> or
+ <application>OpenOffice.org</application>, is mentioned.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>command</command></term>
+ <listitem>
+ <para>
+ The typeface above will be used whenever the text instructs a user
to
+ enter a command at a shell prompt in UNIX/Linux, such as
+ <command>ls</command>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><computeroutput>computeroutput</computeroutput></term>
+ <listitem>
+ <para>
+ This is the typeface used to indicate information produced on
+ <computeroutput>stdout</computeroutput> by the computer. This
include
+ error messages and prompts.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><filename>filename</filename></term>
+ <listitem>
+ <para>
+ This typeface indicates that the text is the name (and possibly the
+ path) of a specific file on the system in question. For example,
+ <filename>/etc/hosts</filename> would appear in this typeface.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guibutton>guibutton</guibutton></term>
+ <listitem>
+ <para>
+ This formatting indicates a button on a Graphical User Interface
+ (GUI). If this formatting appears, look for a button with the same
+ text on the GUI of the &app; player; the button itself may look
+ slightly different.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guimenu>guimenu</guimenu></term>
+ <listitem>
+ <para>
+ This typeface indicates the topmost menu item in a GUI. For
example,
+ in many applications the <guimenu>File</guimenu> menu item is a
+ top=level menu item.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guimenuitem>guimenuitem</guimenuitem></term>
+ <listitem>
+ <para>
+ This typeface indicates a sub-menu item in a GUI. For example, in
+ many applications the <guimenuitem>Save As</guimenuitem> menu item
is
+ a sub-menu item.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>guitext</guilabel></term>
+ <listitem>
+ <para>
+ This typeface indicates a text string on the GUI. This is
generally a
+ text string that appears on the GUI that is not a button or
menuitem.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><keycap>key</keycap></term>
+ <listitem>
+ <para>
+ This typeface indicates a specific key on the keyboard. For
example,
+ the <keycap>Ctrl</keycap> key appears in this typeface.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><keycombo><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
+ <listitem>
+ <para>
+ This formatting indicates a set of keys to be pressed at the same
+ time. A familiar key combination is
+
<keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Delete</keycap></keycombo>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable><replaceable></replaceable></term>
+ <listitem>
+ <para>
+ Whenever a general term is included in an example as a placeholder,
it
+ will be signaled by this formatting. This formatting will usually
+ appear inside other formatting. For example,
+
<filename>/home/<replaceable><username></replaceable></filename>
+ indicates the home directory of a user, whose actual username would
be
+ substituted in for <replaceable><username></replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><userinput>User input</userinput></term>
+ <listitem>
+ <para>
+ This typeface indicates anything that the user must enter, whether
+ that is at a shell prompt or in response to a GUI prompt.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect1>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash/doc Makefile.am C/Makefile.am C/gnash.xml...,
Rob Savoye <=