[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash ChangeLog doc/C/gnash.xml doc/C/usermanua...
|
From: |
Ann Barcomb |
|
Subject: |
[Gnash-commit] gnash ChangeLog doc/C/gnash.xml doc/C/usermanua... |
|
Date: |
Thu, 07 Jun 2007 14:11:27 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Ann Barcomb <ann> 07/06/07 14:11:27
Modified files:
. : ChangeLog
doc/C : gnash.xml
doc/C/usermanual: installation.xml usage.xml
doc/C/usermanual/installation: building.xml
code_dependencies.xml
custompath_configuration.xml
documentation_dependencies.xml
feature_configuration.xml
install.xml
testing_dependencies.xml
Log message:
This commit brings all recent documentation commits in branch
release-8-0-0 to head.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.3486&r2=1.3487
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnash.xml?cvsroot=gnash&r1=1.43&r2=1.44
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation.xml?cvsroot=gnash&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/usage.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/building.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/code_dependencies.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.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/documentation_dependencies.xml?cvsroot=gnash&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/feature_configuration.xml?cvsroot=gnash&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/install.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/testing_dependencies.xml?cvsroot=gnash&r1=1.1&r2=1.2
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.3486
retrieving revision 1.3487
diff -u -b -r1.3486 -r1.3487
--- ChangeLog 7 Jun 2007 13:11:32 -0000 1.3486
+++ ChangeLog 7 Jun 2007 14:11:25 -0000 1.3487
@@ -1,3 +1,34 @@
+2007-06-07 Ann Barcomb <address@hidden>
+
+ * doc/C/usermanual/installation/building.xml: mention that
+ GNOME help is a possible documentation make target. Completed
+ instructions for building documentation; added instructions for
+ testing from old manual.
+ * doc/C/usermanual/installation/feature_configuration.xml: The
+ default renderer isn't AGG. FLTK works. Spelling fixes.
+ Comment out TODO/FIXME sections, so that they are not visible
+ to users, but can still be searched.
+ * doc/C/usermanual/installation.xml: Changed the title of this
+ section.
+ * doc/C/usermanual/installation/install.xml: Added information on
+ where Gnash installs.
+ * doc/C/usermanual/installation/custompath_configuration.xml,
+ doc/C/usermanual/usage.xml: Comment out TODO/FIXME sections,
+ so that they are not visible to users, but can still be searched.
+ * doc/C/usermanual/installation/testing_dependencies.xml,
+ doc/C/usermanual/installation/documentation_dependencies.xml,
+ doc/C/usermanual/installation/code_dependencies.xml: Resolved
+ TODO items in the dependency tables (package names).
+ * doc/C/usermanual/bugreport.xml: Described how to make a bug
+ report.
+ * doc/C/usermanual/glossary.xml: Created the glossary.
+ * doc/C/sources.xml: Removed file; the replacement is
+ doc/C/usermanual/installation/sources.xml.
+ * doc/C/gnashrc.xml: Removed file; it has been moved to
+ doc/C/usermanual/usage/gnashrc.xml.
+ * doc/C/gnash.xml: Replace the old usermanual + developer
+ information with the new usermanual.
+
2007-06-07 Sandro Santilli <address@hidden>
* server/Makefile.am: add libgnashbackend to libserver LDADD.
Index: doc/C/gnash.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/gnash.xml,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -b -r1.43 -r1.44
--- doc/C/gnash.xml 29 Mar 2007 22:09:44 -0000 1.43
+++ doc/C/gnash.xml 7 Jun 2007 14:11:26 -0000 1.44
@@ -1,714 +1,89 @@
<?xml version="1.0"?>
+
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY fdl-app SYSTEM "fdl-appendix.xml">
- <!ENTITY appversion "0.7.2">
- <!ENTITY manrevision "0.3.9">
- <!ENTITY date "Feb 2007">
+ <!ENTITY appversion "0.8.0">
+ <!ENTITY manrevision "0.4.0">
+ <!ENTITY date "May 2007">
<!ENTITY app "<application>Gnash</application>">
<!ENTITY appname "Gnash">
- <!ENTITY version "0.7.2">
- <!ENTITY appendix SYSTEM "appendix.xml">
- <!ENTITY sources SYSTEM "sources.xml">
- <!ENTITY internals SYSTEM "internals.xml">
- <!ENTITY amf SYSTEM "amf.xml">
- <!ENTITY plugin SYSTEM "plugin.xml">
- <!ENTITY logging SYSTEM "logging.xml">
- <!ENTITY opcodes SYSTEM "opcodes.xml">
- <!ENTITY rtmp SYSTEM "rtmp.xml">
- <!ENTITY gnashrc SYSTEM "gnashrc.xml">
- <!ENTITY debugger SYSTEM "debugger.xml">
- <!ENTITY extend SYSTEM "extensions.xml">
- <!ENTITY mysql SYSTEM "mysqlext.xml">
- <!ENTITY file SYSTEM "fileext.xml">
- <!ENTITY gtk SYSTEM "gtkext.xml">
+
+ <!ENTITY programmers SYSTEM "app_authors.xml">
+ <!ENTITY writers SYSTEM "usermanual/doc_authors.xml">
+ <!ENTITY revisionhistory SYSTEM "usermanual/revisions.xml">
+ <!ENTITY introduction SYSTEM "usermanual/introduction.xml">
+ <!ENTITY installation SYSTEM "usermanual/installation.xml">
+ <!ENTITY usage SYSTEM "usermanual/usage.xml">
+ <!ENTITY glossary SYSTEM "usermanual/glossary.xml">
+ <!ENTITY bugreport SYSTEM "usermanual/bugreport.xml">
+
+ <!ENTITY custompath SYSTEM
"usermanual/installation/custompath_configuration.xml">
+ <!ENTITY featureoptions SYSTEM
"usermanual/installation/feature_configuration.xml">
+ <!ENTITY docdependencies SYSTEM
"usermanual/installation/documentation_dependencies.xml">
+ <!ENTITY codedependencies SYSTEM
"usermanual/installation/code_dependencies.xml">
+ <!ENTITY testdependencies SYSTEM
"usermanual/installation/testing_dependencies.xml">
+ <!ENTITY sources SYSTEM "usermanual/installation/sources.xml">
+ <!ENTITY pkgmanager SYSTEM
"usermanual/installation/packagemanager.xml">
+ <!ENTITY configuration SYSTEM
"usermanual/installation/configuration.xml">
+ <!ENTITY cross_compiling SYSTEM
"usermanual/installation/cross_compiling.xml">
+ <!ENTITY building SYSTEM "usermanual/installation/building.xml">
+ <!ENTITY install SYSTEM "usermanual/installation/install.xml">
+ <!ENTITY gnashrc SYSTEM "usermanual/usage/gnashrc.xml">
]
>
- <!-- =============Document Header ============================= -->
- <article id="index" lang="en">
-<!-- please do not change the id; for translations, change lang to -->
-<!-- appropriate code -->
+
+<!-- TRANSLATOR NOTE: do not change the id, just the lang -->
+<article id="index" lang="en">
+
+<!-- =============Document Header ============================ -->
+
<articleinfo>
- <title>&app; Manual V&manrevision;</title>
+ <title>&app; Manual version &manrevision;</title>
<copyright>
<year>2005, 2006, 2007</year>
<holder>Free Software Foundation</holder>
</copyright>
-<!-- translators: uncomment this:
+
+ <!-- TRANSLATOR NOTE: uncomment this section
<copyright>
- <year>2005, 2006, 2007</year>
+ <year>2007</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
-<!-- An address can be added to the publisher information. If a role is
- not specified, the publisher/author is the same for all versions of the
- document. -->
- <publisher>
- <publishername> GNOME Documentation Project </publishername>
- </publisher>
-
-<!--
- Copyright (c) 2005, 2006, 2007, Free Software Foundation, Inc.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
- Texts. A copy of the license is included in the section entitled "GNU
- Free Documentation License".
--->
&legal;
+ &writers;
+ &revisionhistory;
- <!-- This file contains link to license for the documentation (GNU FDL),
and
- other legal stuff such as "NO WARRANTY" statement. Please do not
change
- any of this. -->
-
- <authorgroup>
- <author>
- <firstname>Rob</firstname>
- <surname>Savoye</surname>
- <affiliation>
- <address>
- <email>address@hidden</email>
- </address>
- </affiliation>
- </author>
-
-<!-- This is appropriate place for other contributors: translators,
- maintainers, etc. Commented out by default.
- <othercredit role="translator">
- <firstname>Latin</firstname>
- <surname>Translator 1</surname>
- <affiliation>
- <orgname>Latin Translation Team</orgname>
- <address> <email>address@hidden</email> </address>
- </affiliation>
- <contrib>Latin translation</contrib>
- </othercredit>
--->
- </authorgroup>
-
- <revhistory>
- <revision>
- <revnumber>&appname; Manual V&manrevision;</revnumber>
- <date>&date;</date>
- <revdescription>
- <para role="author">Rob Savoye
- <email>address@hidden</email>
- Updated for the alpha release.
- </para>
- <para role="publisher">Free Software Foundation</para>
- </revdescription>
- </revision>
- </revhistory>
-
- <releaseinfo>This manual describes version &appversion; of &appname;.
+ <releaseinfo>
+ This manual describes version &appversion; of &appname;.
</releaseinfo>
+
</articleinfo>
<indexterm zone="index">
<primary>Gnash</primary>
</indexterm>
-<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
- <sect1 id="intro"> <title>Introduction</title>
- <para>
- Gnash is a free Flash movie player, which can be used
- standalone or as a Firebox/Mozilla plugin.
- </para>
-
- <sect2 id="Gnash Overview">
- <title>Gnash Overview</title>
-
- <para>
- Gnash is originally based on the code of GameSWF, by Thatcher
- Ulrich. GameSWF was the most advanced of the free flash movie player
- projects, and implemented a fairly broad set of Flash Format
- v7 compliance. GameSWF was unsupported public domain software however,
- and not really designed as an industrial strength project which could
- be used by everyone who uses Firefox. So in early December of 2005,
- GameSWF was forked. After being rearranged in GNU project style,
- development of the plugin was started.
- </para>
-
- <para>
- Gnash works as standalone player; as a Mozilla Firefox plugin;
- and as a Konqueror plugin, called Klash. The plugins use the
- standalone player for processing, but embed the output into
- the browser.
- </para>
-
- <para>
- Currently, Gnash uses OpenGL to get a high quality rendered
- image. There are plans to write a Cairo back-end to give Gnash
- a performance boost on graphics processors without 3D hardware
- acceleration. Other plans involve running Gnash in a framebuffer,
- with no windowing system at all.
- </para>
-
-<!--
- <para>
- Gnash currently has two back-ends for graphic display. The
- only one currently used by Gnash is the OpenGL one. There is
- an XBox back-end, but as I don't own an XBox, I can't verify if
- it even works anymore.
- </para>
--->
-
- <para>
- Included in the Gnash is an XML-based messaging system, as
- specified in the Flash specification. This lets a flash movie
- communicate over a TCP/IP socket, and parse the incoming XML
- message. This allows a movie be a remote control for other
- devices or applications.
- </para>
-
- <sect3 id="pluginintro">
- <title>Plugin Overview</title>
- <para>
- The plugin currently works by creating a new window in the
- standalone player which is connected to the browser window in
- Firefox.
- </para>
-
- <para>
- All movies are downloaded to /tmp and played from there.
- Many web pages use IE-specific JavaScript to initiate movies,
- which means that Firefox does not load the Gnash plugin.
- </para>
- </sect3>
-
- <sect3 id="playerintro">
- <title>Standalone Player Overview</title>
- <para>
- The standalone player supports both SDL and GTK2. The SDL
- support is more portable, and the GTK support allows better
- integration as a Firefox plugin. When using GTK, a right-button
- mouse click will activate a menu which can be used to control
- the movie.
- </para>
- </sect3>
-
- <sect3 id="flashsupport">
- <title>Flash Support:</title>
-
- <para>
- Many movies play without any difficulty in Gnash.
- Gnash supports the majority of Flash
- opcodes up to SWF version 7, and a wide sampling of
- ActionScript classes for SWF version 7. All the core ones
- are implemented, and many of the newer ones work, but may be
- missing some of the methods. All unimplemented opcodes and
- ActionScript classes and methods print a warning when using
- -v with gnash or gprocessor. Using gprocessor -v is a quick
- way to see why a movie isn't playing correctly.
- </para>
-
- <para>
- There are plans to work towards supporting all the SWF
- version 8 and greater opcodes, as well as as implementing the
- missing methods and ActionScript classes. During the first
- few months of Gnash's existence as a project, most of the
- focus has been towards portability issues, and getting the
- plugin to work. Now that the plugin works, more focus will
- be spent on catching up to full compliance with version 7
- and beyond.
-
- </para>
- <para>
- Currently implemented ActionScript classes are: Array,
- Boolean, Date, Key, Math, Mouse, MovieClip, Number, Object,
- Sound, String, XML, XMLNode, and XMLSocket.
- </para>
-
- <para>
- Partially implemented classes are: MovieClipLoader,
- NetConnection, LocalConnection, TextField, and TextFormat.
- </para>
-
- <para>
- Unimplemented classes are: Accessibility, Error, Function,
- LoadVars, Microphone, NetStream, Selection, SharedObject,
- Stage, System, Button, Camera, Color, ContextMenu,
- CustomActions, and Video.
- </para>
- <para>
- Unimplemented Opcodes are: Throw, Implements, Extends,
- enum_object, Try, new_method, enum_object, md length, md
- substring, md chr, delete, and get target.
- </para>
- <para>
- There is currently no support for FLV video, more than minimal
- AMF data, or loading external jpegs.
- </para>
- </sect3>
-
- </sect2>
- </sect1>
-
- <sect1 id="usage">
- <title>Gnash Usage</title>
-
- <para>
- Gnash can be used as a standalone player or as a plugin. Using it
- as a standalone player, you
- can execute any flash movie from the command line by just
- supplying the file name. No command line options are required to
- just play the movie using the default actions. So if you type:
- </para>
-
-
- <para>
- <emphasis>gnash samples/car_smash.swf</emphasis>
- </para>
-
- <para>
- It will create a window and play the movie. In this case it's a
- simple animation of a car driving, swerving, and finally
- crashing.
- <mediaobject>
- <imageobject>
- <imagedata align="center" fileref="images/car_crash.png"/>
- </imageobject>
- </mediaobject>
-
- </para>
-
- <sect2 id="options">
- <title>Gnash Command Line Options</title>
-
- <para>
- While by default no options are necessary, there are options
- that can be used to change <emphasis>Gnash's</emphasis> basic
- behavior.
- </para>
-
- <para>
- gnash [options] file
- </para>
-
- <variablelist>
- <varlistentry>
- <term>-h</term>
- <listitem>
- <para>
- Print usage information.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-s factor</term>
- <listitem>
- <para>
- Scale the movie up/down by the specified factor.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-c</term>
- <listitem>
- <para>
- Produce a core file instead of letting SDL trap it. By
- default, SDL traps all signals, but sometimes a core file
- is desired to assist with debugging.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-d num</term>
- <listitem>
- <para>
- Number of milliseconds to delay in main loop. The main
- loop polls continuously with a delay to adjust how long
- <emphasis>Gnash</emphasis> sleeps between iterations of the
- loop. The smaller the number, the higher the CPU load
- gets, and of course, the more iterations of the main
- command loop.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-p</term>
- <listitem>
- <para>
- Run full speed (no sleep) and log frame rate.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-a</term>
- <listitem>
- <para>
- Enable Actionscript debugging.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-v</term>
- <listitem>
- <para>
- Be verbose; i.e. print debug messages to stdout.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-va</term>
- <listitem>
- <para>
- Be verbose about movie Actions.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-vp</term>
- <listitem>
- <para>
- Be verbose about parsing the movie. Warning: this can
- generate a lot of text, and can affect the performance of
- the movie you are playing.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-ml bias</term>
- <listitem>
- <para>
- Specify the texture LOD bias (float, default is -1) This
- affects the fuzziness of small objects, especially small
- text.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-w</term>
- <listitem>
- <para>
- Write a debug log called gnash-dbg.log. This will
- record of all the debug messages whether they are printed
- to the screen or not.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-j</term>
- <listitem>
- <para>
- Specify the width of the window. This is mostly used
- only by the plugin.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-k</term>
- <listitem>
- <para>
- Specify the height of the window. This is mostly used
- only by the plugin.
- </para>
- </listitem>
- </varlistentry>
-<!--
- <varlistentry>
- <term>-e</term>
- <listitem>
- <para>
- Use SDL Event thread. This uses a separate thread to make
- the event loop more event driven than polling. This can
- improve performance for some types of movies.
- </para>
- </listitem>
- </varlistentry>
--->
- <varlistentry>
- <term>-1</term>
- <listitem>
- <para>
- Play once; exit when/if movie reaches the last
- frame. This is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-r [0|1|2|3]</term>
- <listitem>
- <para>
- 0 disables rendering and sound (good for batch tests).
- </para>
- <para>
- 1 enables rendering and disables sound (default setting).
- </para>
- <para>
- 2 enables sound and disables rendering.
- </para>
- <para>
- 3 enables rendering and sound.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-t sec</term>
- <listitem>
- <para>
- Timeout and exit after the specified number of
- seconds. This is useful for movies which repeat
- themselves.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-g</term>
- <listitem>
- <para>
- Start Gnash with a Flash debugger console so one can set
- break points or watchpoints.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-x id</term>
- <listitem>
- <para>
- This specifies the X11 window ID to display
- in; this is mainly used by plugins.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-b bits</term>
- <listitem>
- <para>
- Bit depth of output window (for example, 16 or 32). Appropriate
- bit depths depend on the renderer and GUI library used.
- FIXME: add information about which depths are suitable for each
- renderer.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-u url</term>
- <listitem>
- <para>
- Set the _url member of the root movie. This is useful
- when you download a movie and play it from a different
- location. See also the -U switch.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-U baseurl</term>
- <listitem>
- <para>
- Set base url for this run. URLs are resolved relative to
- this base. If omitted defaults to the _url member of the
- top-level movie (see the -u switch).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-P parameter</term>
- <listitem>
- <para>
- Parameters are given in ParamName=Value syntax and are mostly
- useful to the plugin to honour EMBED tags attributes
- or explicit OBJECT PARAM tags. A common use for -P
- is to provide FlashVars
- (ie: -P "FlashVars=home=http://www.gnu.org";).
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
-
- </sect2>
-
- <sect2 id="keys">
- <title>Gnash Interactive Control Keys</title>
-
- <para>
- While a movie is playing, there are several control
- keys. These can be used to step through frames, pause the
- playing, and control other actions.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>CTRL-Q</term>
- <listitem>
- <para>
- Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-W</term>
- <listitem>
- <para>
- Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>ESC</term>
- <listitem>
- <para>
- Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-P</term>
- <listitem>
- <para>
- Toggle Pause.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-R </term>
- <listitem>
- <para>
- Restart the movie.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-[ or kp-</term>
- <listitem>
- <para>
- Step back one frame.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-] or kp+</term>
- <listitem>
- <para>
- Step forward one frame.
- </para>
- </listitem>
- </varlistentry>
-
-<!--
- <varlistentry>
- <term>CTRL-A</term>
- <listitem>
- <para>
- Toggle anti-aliasing (doesn't work).
- </para>
- </listitem>
- </varlistentry>
--->
-
- <varlistentry>
- <term>CTRL-T</term>
- <listitem>
- <para>
- Debug. Test the set_variable() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-G</term>
- <listitem>
- <para>
- Debug. Test the get_variable() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-M</term>
- <listitem>
- <para>
- Debug. Test the call_method() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-B</term>
- <listitem>
- <para>
- Toggle the background color.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- &gnashrc;
- &debugger;
-
- </sect1>
-
- &sources;
- &internals;
- &extend;
- &appendix;
-
-<!-- ============= Authors ================================ -->
-
- <sect1 id="authors">
- <title>Authors</title>
- <para>
- <application>Gnash</application> is maintained by Rob Savoye
- <email>address@hidden</email>. Other active developers are:
- Sandro Santilli, Bastiaan Jacques, Vitaly Alexeev, and Tomas
- Groth. Please send all comments and suggestions to
- <email>address@hidden</email>. Please use this link to <ulink
- type="http"
- url="https://savannah.gnu.org/patch/?group=gnash";>submit a
- patch</ulink>
- or this link to <ulink type="http"
- url="https://savannah.gnu.org/bugs/?group=gnash";>file a bug
- report</ulink>.
- I am available for consulting on a variety of renewable energy
- and open source technologies. More details at <ulink type="http"
- url="http://www.senecass.com";>http://www.senecass.com</ulink>
- </para>
-
- <para>
- The primary author of GameSWF (which provided the initial code for
- Gnash) is Thatcher Ulrich <email>address@hidden</email>. Other
- individuals who contributed code are: Mike Shaver, Thierry Berger-Perrin,
- Ignacio Castaño, Willem Kokke, Vitaly Alexeev,
- Alexander Streit, and Rob Savoye.
- </para>
+ &introduction;
- </sect1>
+<!-- ============= Document Body ============================= -->
+ &usage;
+ &installation;
+ &bugreport;
+ &glossary;
- <!-- ============= Application License ============================= -->
+<!-- ============= Authors =================================== -->
+ &programmers;
+<!-- ============= Application License ======================= -->
&fdl-app;
</article>
Index: doc/C/usermanual/installation.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation.xml 27 May 2007 09:00:29 -0000 1.2
+++ doc/C/usermanual/installation.xml 7 Jun 2007 14:11:26 -0000 1.3
@@ -1,5 +1,5 @@
<sect1 id="build">
- <title>Installing &app;</title>
+ <title>Installing and Configuring &app;</title>
<para>
There are two ways of installing &app;:
Index: doc/C/usermanual/usage.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/usage.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/usermanual/usage.xml 22 May 2007 13:48:09 -0000 1.1
+++ doc/C/usermanual/usage.xml 7 Jun 2007 14:11:26 -0000 1.2
@@ -1,5 +1,5 @@
<sect1 id="usage">
- <title>&app; Usage</title>
+ <title>Using &app;</title>
<para>
&app; can be used as a standalone player or as a plugin. Using it
@@ -245,8 +245,10 @@
<para>
Bit depth of output window (for example, 16 or 32). Appropriate
bit depths depend on the renderer and GUI library used.
- FIXME: add information about which depths are suitable for each
+<!--
+ TODO: add information about which depths are suitable for each
renderer.
+-->
</para>
</listitem>
</varlistentry>
Index: doc/C/usermanual/installation/building.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/building.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/usermanual/installation/building.xml 27 May 2007 09:00:29 -0000
1.1
+++ doc/C/usermanual/installation/building.xml 7 Jun 2007 14:11:26 -0000
1.2
@@ -57,14 +57,147 @@
documentation. The available output formats are:
<emphasis>html</emphasis>,
<emphasis>pdf</emphasis>, <emphasis>info</emphasis>,
<emphasis>man</emphasis>, and <emphasis>alldocs</emphasis>.
- <emphasis>alldocs</emphasis> will build all of the other four output
- formats. For example, to create HTML output, type:
+ It is also possible to output <emphasis>GNOME help</emphasis> if
+ the <link linkend="features">configure option</link>
+ <emphasis>--enable-ghelp</emphasis> was used.
+ The <emphasis>alldocs</emphasis> target will build all output formats
+ except <emphasis>GNOME help</emphasis>.
+ For example, to create HTML output, type:
<programlisting>
make html
</programlisting>
</para>
- <para>TODO</para>
+ <para>
+ &app; also uses <ulink
url="http://www.stack.nl/~dimitri/doxygen/index.html";
+ type="http">Doxygen</ulink> to produce <emphasis>HTML</emphasis>
+ documentation of &app; internals. You must have Doxygen installed
+ to produce this documentation, which is built from the
+ <filename>doc</filename> directory with the command (documents
+ will be placed in the subdirectory <filename>apidoc/html</filename>):
+ <programlisting>
+ make apidoc
+ </programlisting>
+ </para>
</sect3>
+<sect3 id="runtests">
+ <title>Running the Tests</title>
+
+ <para>
+ If a test fails, please report it by following the
+ <link linkend="bugreport">instructions for reporting a bug</link>.
+ </para>
+
+ <sect4 id="dejagnu">
+ <title>Using DejaGnu</title>
+
+ <para>
+ <!--
+ TODO: Add a section on running tests without DejaGnu.
+ -->
+ The easiest way to run &app;'s test suite is to install
+ <emphasis><ulink type="http"
+ url="http://www.gnu.org/software/dejagnu";>DejaGnu</ulink></emphasis>.
+ After installing DejaGnu, run:
+ <programlisting>
+ make check
+ </programlisting>
+ </para>
+
+ <sect5 id="testing_verbosity">
+ <title>Increasing Verbosity</title>
+ <para>
+ If you encounter a problem with a test, increasing the
+ verbosity may make the issue easier to spot.
+ 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.
+ <programlisting>
+ make check RUNTESTFLAGS="-v -a"
+ </programlisting>
+ </para>
+ </sect5>
+
+ <sect5 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
+ 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
+ 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
+ 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
+ <filename>movies.all</filename>:
+ <programlisting>
+ make -C testsuite/movies.all check
+ </programlisting>
+ </para>
+ </sect5>
+
+ </sect4>
+ <sect4 id="manually">
+ <title>Running The Tests Manually</title>
+
+ <para>
+ You may also run test cases by hand, which can be useful if you
+ want to see all the debugging output from the test case. Often
+ the messages which come from deep within &app; are most useful for
+ development.
+ </para>
+
+ <para>
+ The first step is to compile the test case, which can be done
+ with <filename>make XML-v#.swf</filename> where the '#' is replaced
+ with the <emphasis>target</emphasis> SWF version or versions.
+ For example:
+ <programlisting>
+ make XML-v{5,6,7,8}.swf
+ </programlisting>
+ </para>
+
+ <sect5 id="manual_compiled_tests">
+ <title>Movie tests</title>
+ <para>
+ This creates a Flash movie version of the test case, which
+ can be run with a standalone Flash player. For instance,
+ the target for SWF version 6 could be run with &app;:
+ <programlisting>
+ gnash -v XML-v6.swf
+ </programlisting>
+ </para>
+ </sect5>
+
+ <sect5 id="manual_actionscript_tests">
+ <title>ActionScript Unit Tests</title>
+ <para>
+ Unit tests for ActionScript classes in 'testsuite/actionscript.all'
+ are run without a graphical display:
+ <programlisting>
+ gprocessor -v XML-v6.swf
+ </programlisting>
+ </para>
+ </sect5>
+ </sect4>
+
+
+
+</sect3>
Index: doc/C/usermanual/installation/code_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/code_dependencies.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation/code_dependencies.xml 26 May 2007 10:45:16
-0000 1.2
+++ doc/C/usermanual/installation/code_dependencies.xml 7 Jun 2007 14:11:26
-0000 1.3
@@ -75,7 +75,7 @@
<entry>
&app; requires the installation of at least one
renderer. AGG is considered the <emphasis>best
- supported</emphasis> renderer for &app;
+ supported</emphasis> renderer for &app;.
</entry>
<entry><filename>libagg-dev</filename></entry>
<entry><filename>agg-devel</filename></entry>
@@ -194,8 +194,8 @@
GUI library. FLTK may be used in conjunction with
the Cairo and AGG renderers.
</entry>
- <entry>No distribution packages are available</entry>
- <entry>No distribution packages are available</entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
@@ -319,8 +319,9 @@
<entry>
This library is used for URL downloading.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry><filename>libcurl4-gnutls</filename></entry>
+ <entry><filename>libcurl</filename></entry>
+
</row>
<row>
Index: doc/C/usermanual/installation/custompath_configuration.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/custompath_configuration.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation/custompath_configuration.xml 26 May 2007
10:42:50 -0000 1.2
+++ doc/C/usermanual/installation/custompath_configuration.xml 7 Jun 2007
14:11:26 -0000 1.3
@@ -9,7 +9,7 @@
</para>
<para>
The following custom path options are available:
-TODO - review this section
+<!-- TODO - review this section -->
</para>
<variablelist>
Index: doc/C/usermanual/installation/documentation_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/documentation_dependencies.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/usermanual/installation/documentation_dependencies.xml 27 May
2007 09:03:45 -0000 1.2
+++ doc/C/usermanual/installation/documentation_dependencies.xml 7 Jun
2007 14:11:26 -0000 1.3
@@ -43,8 +43,10 @@
<entry>
&app; documentation is written in Docbook.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry><filename>docbook-utils</filename> and
+ <filename>docbook-dsssl</filename></entry>
+ <entry><filename>docbook-dtd41-sgml</filename> and
+ <filename>docbook-style-dsssl</filename></entry>
</row>
<row>
@@ -99,8 +101,8 @@
<entry>
FOP is required for PDF output.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry><filename>fop</filename></entry>
+ <entry><filename>fop</filename></entry>
</row>
<row>
Index: doc/C/usermanual/installation/feature_configuration.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/feature_configuration.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- doc/C/usermanual/installation/feature_configuration.xml 26 May 2007
10:42:51 -0000 1.4
+++ doc/C/usermanual/installation/feature_configuration.xml 7 Jun 2007
14:11:26 -0000 1.5
@@ -14,7 +14,7 @@
<listitem>
<para>
<emphasis>--enable-renderer</emphasis> allows a renderer to be
-chosen. The default renderer is AGG.
+chosen. The default renderer is OpenGL.
</para>
</listitem>
<listitem>
@@ -27,7 +27,7 @@
A complete list of available features follows.
</para>
-<para>TODO - review this section</para>
+<!-- <para>TODO - review this section</para> -->
<variablelist>
<varlistentry>
@@ -243,7 +243,7 @@
used when you don't have hardware accelerated
graphics. Typically most desktop machines have OpenGL
support, and most embedded systems don't. OpenGl is the
- default when building Gnash, though the quality of AGG's
+ default when building Gnash, although the quality of AGG's
rendering is currently superior to OpenGL.
</para>
</listitem>
Index: doc/C/usermanual/installation/install.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation/install.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/usermanual/installation/install.xml 27 May 2007 09:01:58 -0000
1.1
+++ doc/C/usermanual/installation/install.xml 7 Jun 2007 14:11:26 -0000
1.2
@@ -1 +1,110 @@
<title>Installation</title>
+
+<para>
+ Installation is done with the command:
+ <programlisting>
+ make install
+ </programlisting>
+</para>
+
+<para>
+ &app; installs a number of <link linkend="libinstall">libraries</link>,
+ namely: <emphasis>libbase</emphasis>,
+ <emphasis>libgeometry</emphasis>, <emphasis>libbackend</emphasis>,
+ <emphasis>libserver</emphasis>, and <emphasis>libmozsdk</emphasis>.
+ <link linkend="appinstall">Executables</link>
+ consist of the (optional) plugin, <filename>gprocessor</filename>,
+ <filename>cygnal</filename>, and <filename>gnash</filename>.
+ <link linkend="docinstall">Documentation</link> may also be installed.
+ The installation location is controlled with the
+ <emphasis>--prefix</emphasis> <link linkend="custompath">configure
+ option</link>.
+</para>
+
+<para>
+ Note that if you are using a single file-system <emphasis>NFS</emphasis>
+ mounted to multiple platforms, the
+ <link linkend="custompath">configuration option</link>
+ <emphasis>--exec-prefix</emphasis> may be used to specify where
+ platform-dependent executables and libraries are installed.
+</para>
+
+<sect4 id="libinstall">
+ <title>Libraries</title>
+
+ <para>
+ Installed libraries are located in
+ <filename>/usr/local/lib</filename> by default.
+ If the <emphasis>--prefix</emphasis> option was used in
+ <link linkend="configure">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.
+ </para>
+
+ <para>
+ The traditional way to do this on UNIX
+ platforms is to set the <emphasis>LD_LIBRARY_PATH</emphasis> variable
+ to the path plus <filename>/lib</filename>. For example, if you
+ installed in <filename>/home/gnash</filename>, the
+ <emphasis>LD_LIBRARY_PATH</emphasis> path would be
+ <filename>/home/gnash/lib</filename>. Multiple paths are delimited
+ with a colon (':').
+ </para>
+
+ <para>
+ GNU/Linux allows the custom path to be added to
+ <filename>/etc/ld.so.conf</filename>. After adding the path,
+ run <emphasis>ldconfig</emphasis> as root to update the runtime
+ cache.
+ </para>
+</sect4>
+
+<sect4 id="appinstall">
+ <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>/usr/lib/mozilla/plugins</filename>.
+ You may also specify the plugin installation directory by using the
+ <emphasis>--with-plugindir</emphasis> <link linkend="custompath">option
+ to configure</link>.
+ </para>
+
+ <para>
+ The remaining executables will be 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>.
+ </para>
+</sect4>
+
+<sect4 id="docinstall">
+ <title>Documentation</title>
+
+ <para>
+ Documentation is not built by default; please refer to the
+ <link linkend="processdoc">section on documentation</link> for
+ more information on building documentation.
+ </para>
+
+ <para>
+ <emphasis>man</emphasis> and <emphasis>info</emphasis>
+ will be 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>
+ <link linkend="custompath">configuration options</link> are used.
+ </para>
+
+ <para>
+ <emphasis>GNOME help</emphasis> documentation uses the directory
+ <filename>/usr/local/share/gnash/doc/gnash/C/</filename> by default.
+ A configuration file in the &app; source tree,
+ <filename>doc/C/gnash.omf</filename> is used to specify under
+ which menu item &app; appears in the <emphasis>GNOME help</emphasis>
+ system.
+ </para>
+</sect4>
Index: doc/C/usermanual/installation/testing_dependencies.xml
===================================================================
RCS file:
/sources/gnash/gnash/doc/C/usermanual/installation/testing_dependencies.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/usermanual/installation/testing_dependencies.xml 22 May 2007
13:48:10 -0000 1.1
+++ doc/C/usermanual/installation/testing_dependencies.xml 7 Jun 2007
14:11:26 -0000 1.2
@@ -39,8 +39,8 @@
<entry>
Ming is the primary compiler for ActionScript testcases.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
@@ -53,8 +53,8 @@
<entry>
Mtasc is used in some tests.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry><filename>mtasc</filename></entry>
+ <entry>No distribution packages are available.</entry>
</row>
<row>
@@ -67,8 +67,8 @@
<entry>
Swfdec is used in some testcases.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry>No distribution packages are available.</entry>
+ <entry>Unofficial package <filename>swfdec</filename></entry>
</row>
<row>
@@ -82,8 +82,8 @@
DejaGnu is used to run multiple tests in an
automated fashion.
</entry>
- <entry>TODO<filename></filename></entry>
- <entry>TODO<filename></filename></entry>
+ <entry><filename>dejagnu</filename></entry>
+ <entry><filename>dejagnu</filename></entry>
</row>
</tbody>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash ChangeLog doc/C/gnash.xml doc/C/usermanua...,
Ann Barcomb <=