gnash-commit
[Top][All Lists]
Advanced

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

[Gnash-commit] gnash ChangeLog doc/C/bugreport.xml doc/C/doc_a... [relea


From: Sandro Santilli
Subject: [Gnash-commit] gnash ChangeLog doc/C/bugreport.xml doc/C/doc_a... [release_0_8_2_rc1]
Date: Tue, 04 Mar 2008 08:56:10 +0000

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         release_0_8_2_rc1
Changes by:     Sandro Santilli <strk>  08/03/04 08:56:10

Modified files:
        .              : ChangeLog 
Added files:
        doc/C          : bugreport.xml doc_authors.xml gnashref.xml 
                         gnashuser.xml introduction.xml security.xml 
        doc/C/usermanual: gnashrc.xml 

Log message:
        Add missing files. distcheck works again.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&r1=1.5711.2.45&r2=1.5711.2.46
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/bugreport.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.2.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/doc_authors.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.1.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnashref.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.3.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnashuser.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.3.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/introduction.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.2.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/security.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.2.2.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/gnashrc.xml?cvsroot=gnash&only_with_tag=release_0_8_2_rc1&rev=1.2.2.2

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.5711.2.45
retrieving revision 1.5711.2.46
diff -u -b -r1.5711.2.45 -r1.5711.2.46
--- ChangeLog   4 Mar 2008 00:25:03 -0000       1.5711.2.45
+++ ChangeLog   4 Mar 2008 08:56:08 -0000       1.5711.2.46
@@ -1,3 +1,10 @@
+2008-03-04 Sandro Santilli <address@hidden>
+
+       * doc/C/bugreport.xml, doc/C/doc_authors.xml, doc/C/gnashref.xml,
+         doc/C/gnashuser.xml, doc/C/introduction.xml, doc/C/security.xml,
+         doc/C/usermanual/gnashrc.xml: Add missing files. distcheck
+         works again.
+
 2008-03-03 Bastiaan Jacques <address@hidden>
 
        * backend/render_handler_{agg,ogl}.cpp: Wallpaper over bug #22462:

Index: doc/C/bugreport.xml
===================================================================
RCS file: doc/C/bugreport.xml
diff -N doc/C/bugreport.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/bugreport.xml 4 Mar 2008 08:56:09 -0000       1.2.2.2
@@ -0,0 +1,125 @@
+<chapter id="bugreport">
+  <title>Reporting Bugs</title>
+  
+  <para>
+    The Gnash project relies on the community of Gnash users to test
+    the player, feedback is critical to any successful project.  Not
+    only does it let us know that people use Gnash, but it helps us  
+    understand the community's needs. Gnash uses a bug tracker on
+    <ulink url="http://savannah.gnu.org"; /> to manage these reports.
+  </para>
+  
+  <para>
+    When filing a report, please follow the guidelines below. The better
+    your bug report is, the easier it will be for the developers to
+    address the issue. Bug reports without enough information will
+    initially be asked to provide this information anyway. Adding
+    critical details, like the Operating System you are on, its
+    version, and any relevant error messages from Gnash that you get.
+  </para>
+
+  <sect1 id="bugstep_package">
+    <title>Get a Fresh Binary Package</title>
+    <para>
+      For starters, it's a good idea to obtain a copy of the latest
+      snapshot. Although Gnash is primarily released as source, the
+      Gnash build infrastructure allows the automated building of
+      binary packages. Often the version of Gnash as packaged by a
+      GNU/Linux or BSD distribution is based on the last official
+      release, which could be months out of date. It is helpful if
+      this is the case to try a newer packaged build of Gnash. 
+    </para>
+
+    <para>
+      You can get a fresh binary package of Gnash, as well as recent 
+      source packages from
+      <ulink type="http"
+            url="http://www.getgnash.org/packages/";>
+       http://www.getgnash.org/packages
+      </ulink>. 
+    </para>    
+  </sect1>
+
+  <sect1 id="bugstep_search">
+    <title>Determine if the bug was previously reported</title>
+    <para>
+      Search the <ulink type="https"
+      url="https://savannah.gnu.org/bugs/?group=gnash";>Gnash
+      bug tracker</ulink> to see if the bug has already been identified.
+    </para>
+    <para>
+      If the issue has already been reported, you should not file
+      a bug report.  However, you may add some additional information
+      to the ticket if you feel that it will be beneficial to the
+      developers.  For instance, if someone reported a memory issue
+      on Ubuntu GNU/Linux, and you noticed the same problem on OpenBSD,
+      your stacktrace would be useful.  Conversely, adding a "me too"
+      note to a feature request is not helpful.
+    </para>
+  </sect1>
+
+  <sect1 id="bugstep_guidelines">
+    <title>Review the bug writing guidelines</title>
+    <para>
+      A good bug report should be precise, explicit, and discrete.
+      This means that there should be just one bug per ticket, and
+      that a ticket should contain the following information:
+    </para>
+    <itemizedlist mark="opencircle">
+      <listitem>
+       <para>
+         An overview of the problem;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         Instructions on how to replicate the bug;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         A description of what happened when you performed the steps
+         to replicate the bug, and what you expected to happen;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         Your system information: operating system name and version, as
+         well as the versions of major development dependencies;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         The release number or checkout timestamp for the version of Gnash
+         where you observe the problem;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         The file <filename>config.log</filename>, which should be
+         attached as a file;
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         A descriptive title.
+       </para>
+      </listitem> 
+    </itemizedlist>
+    <para>
+      Include any additional information that you feel might be useful
+      to the developers.
+    </para>
+  </sect1>
+  
+  <sect1 id="bugstep_file">
+    <title>Filing a bug report</title>
+    <para>
+      After following the steps described above, you can file a bug report at 
+      <ulink type="https"
+            url="https://savannah.gnu.org/bugs/?group=gnash"; />.
+    </para>
+  </sect1>
+  
+</chapter>
+    

Index: doc/C/doc_authors.xml
===================================================================
RCS file: doc/C/doc_authors.xml
diff -N doc/C/doc_authors.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/doc_authors.xml       4 Mar 2008 08:56:09 -0000       1.1.2.2
@@ -0,0 +1,26 @@
+  <authorgroup> 
+      <author> 
+          <firstname>Rob</firstname> 
+          <surname>Savoye</surname> 
+          <affiliation> 
+             <address>
+                 <email>address@hidden</email>
+             </address> 
+          </affiliation> 
+      </author> 
+
+      <!-- TRANSLATOR NOTE: add yourself to this section
+      <othercredit role="translator">
+        <firstname>Example</firstname> 
+        <surname>Translator</surname> 
+        <affiliation> 
+         <orgname>Example Translation Team</orgname> 
+         <address> 
+              <email>address@hidden</email> 
+          </address> 
+        </affiliation> 
+        <contrib>Example translation</contrib>
+      </othercredit>
+      -->
+
+  </authorgroup> 

Index: doc/C/gnashref.xml
===================================================================
RCS file: doc/C/gnashref.xml
diff -N doc/C/gnashref.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/gnashref.xml  4 Mar 2008 08:56:09 -0000       1.3.2.2
@@ -0,0 +1,119 @@
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+    
+    <!ENTITY appversion "0.8.2">
+    <!ENTITY manrevision "0.4.3">
+    <!ENTITY date "Feb 2008">
+    <!ENTITY app "<application>Gnash</application>">
+    <!ENTITY appname "Gnash">
+
+    <!ENTITY legal            SYSTEM "legal.xml">
+    <!ENTITY fdl-app          SYSTEM "fdl-appendix.xml"> 
+    <!ENTITY programmers      SYSTEM "app_authors.xml">
+    <!ENTITY introduction     SYSTEM "introduction.xml">
+    <!ENTITY bugreport        SYSTEM "bugreport.xml">
+
+    <!ENTITY amf              SYSTEM "refmanual/amf.xml">
+    <!ENTITY rtmp             SYSTEM "refmanual/rtmp.xml">
+    <!ENTITY internals        SYSTEM "refmanual/internals.xml">
+    <!ENTITY object           SYSTEM "refmanual/object.xml">
+    <!ENTITY plugin           SYSTEM "refmanual/plugin.xml">
+    <!ENTITY memory           SYSTEM "refmanual/memory.xml">
+    <!ENTITY newasclass       SYSTEM "refmanual/new_as_class.xml">
+    <!ENTITY asvalue          SYSTEM "refmanual/as_value.xml">
+    <!ENTITY revisionhistory  SYSTEM "refmanual/revisions.xml">
+    <!ENTITY specification    SYSTEM "refmanual/specification.xml">
+    <!ENTITY installation     SYSTEM "refmanual/installation.xml">
+
+    <!ENTITY custompath       SYSTEM "refmanual/custompath_configuration.xml">
+    <!ENTITY featureoptions   SYSTEM "refmanual/feature_configuration.xml">
+    <!ENTITY docdependencies  SYSTEM 
"refmanual/documentation_dependencies.xml">
+    <!ENTITY codedependencies SYSTEM "refmanual/code_dependencies.xml">
+    <!ENTITY testdependencies SYSTEM "refmanual/testing_dependencies.xml">
+    <!ENTITY sources          SYSTEM "refmanual/sources.xml">
+    <!ENTITY pkgmanager       SYSTEM "refmanual/packagemanager.xml">
+    <!ENTITY configuration    SYSTEM "refmanual/configuration.xml">
+    <!ENTITY crosscompiling   SYSTEM "refmanual/cross_compiling.xml">
+    <!ENTITY install          SYSTEM "refmanual/install.xml">
+    <!ENTITY building         SYSTEM "refmanual/building.xml">
+    <!ENTITY logging          SYSTEM "refmanual/logging.xml">
+    <!ENTITY internals        SYSTEM "refmanual/internals.xml">
+    <!ENTITY building         SYSTEM "refmanual/building.xml">
+    <!ENTITY codestyle        SYSTEM "refmanual/codestyle.xml">
+    <!ENTITY fn_call "<emphasis>fn_call</emphasis>">
+
+    <!ENTITY extensions       SYSTEM "refmanual/extensions/extensions.xml">
+    <!ENTITY fileext          SYSTEM "refmanual/extensions/fileext.xml">
+    <!ENTITY gtkext           SYSTEM "refmanual/extensions/gtkext.xml">
+    <!ENTITY mysqlext         SYSTEM "refmanual/extensions/mysqlext.xml">
+
+ ]
+>
+
+
+<!-- TRANSLATOR NOTE: do not change the id, just the lang -->
+<book lang="en" id="index">
+  <title>Gnash Reference Manual</title>
+  <titleabbrev>Gnash Ref</titleabbrev>
+  
+  <!-- =============Document Header ============================ -->
+  
+  <bookinfo>
+    <title>Gnash Reference Manual</title>
+    <copyright>
+      <year>2005, 2006, 2007, 2008</year>
+      <holder>Free Software Foundation</holder>
+    </copyright>
+    
+    <!-- TRANSLATOR NOTE: uncomment this section
+        
+        <copyright>
+        <year>2008</year>
+        <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+        </copyright>
+        
+    -->
+    
+    &legal;
+    &revisionhistory;
+    
+    <releaseinfo>
+      This manual describes version &appversion; of &appname;.
+    </releaseinfo>
+    
+  </bookinfo>
+  
+  
+<!-- ============= Introduction ============================== -->
+  &introduction;
+
+<!-- ============= Document Body ============================= -->
+
+<!-- This chapter includes all the other sections used to document how to
+     configure and compile Gnash. -->
+  &building;
+
+<!-- This chapter includes all the other sections used to document the
+     internals of how Gnash works. -->
+  &internals;
+  &bugreport;
+  &extensions;
+
+<!-- This chapter includes all the other sections used to document
+     protocols and formats used by Gnash. -->
+
+  &rtmp;
+  &plugin;
+
+  <!-- The appendix. Nobody reads these coding style suggestions
+       anyway -->
+  &codestyle;
+
+<!-- ============= Authors =================================== -->
+  &programmers;
+
+<!-- ============= Application License ======================= -->
+  &fdl-app;
+
+</book>

Index: doc/C/gnashuser.xml
===================================================================
RCS file: doc/C/gnashuser.xml
diff -N doc/C/gnashuser.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/gnashuser.xml 4 Mar 2008 08:56:09 -0000       1.3.2.2
@@ -0,0 +1,84 @@
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+    
+    <!ENTITY appversion "0.8.2">
+    <!ENTITY manrevision "0.2">
+    <!ENTITY date "Feb 2008">
+    <!ENTITY app "<application>Gnash</application>">
+    <!ENTITY appname "Gnash">
+
+    <!ENTITY legal            SYSTEM "legal.xml">
+    <!ENTITY fdl-app          SYSTEM "fdl-appendix.xml"> 
+    <!ENTITY programmers      SYSTEM "app_authors.xml">
+    <!ENTITY introduction     SYSTEM "introduction.xml">
+    <!ENTITY security         SYSTEM "security.xml">
+    <!ENTITY bugreport        SYSTEM "bugreport.xml">
+
+    <!ENTITY acknowledgments  SYSTEM "usermanual/acknowledgments.xml">
+    <!ENTITY conventions      SYSTEM "usermanual/conventions.xml">
+
+    <!ENTITY pkgmanager       SYSTEM "usermanual/packagemanager.xml">
+    <!ENTITY revisionhistory  SYSTEM "usermanual/revisions.xml">
+    <!ENTITY specification    SYSTEM "usermanual/specification.xml">
+    <!ENTITY installation     SYSTEM "usermanual/installation.xml">
+    <!ENTITY usage            SYSTEM "usermanual/usage.xml">
+    <!ENTITY gnashrc          SYSTEM "usermanual/gnashrc.xml">
+    <!ENTITY glossary         SYSTEM "usermanual/glossary.xml">
+
+ ]
+>
+
+
+<!-- TRANSLATOR NOTE: do not change the id, just the lang -->
+<book lang="en" id="index">
+  <title>Gnash User Manual</title>
+  <titleabbrev>Gnash User</titleabbrev>
+
+<!-- =============Document Header ============================ -->
+
+<bookinfo>
+  <title>Gnash User Manual</title>
+  <copyright>
+    <year>2005, 2006, 2007, 2008</year>
+    <holder>Free Software Foundation</holder>
+  </copyright>
+  
+  <!-- TRANSLATOR NOTE: uncomment this section
+       
+       <copyright>
+       <year>2008</year>
+       <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+       </copyright>
+       
+  -->
+  
+  &legal;
+  &revisionhistory;
+  
+    <releaseinfo>
+        This manual describes version &appversion; of &appname;.
+    </releaseinfo>
+
+  </bookinfo>
+
+  
+<!-- ============= Introduction ============================== -->
+  &introduction;
+
+<!-- ============= Document Body ============================= -->
+
+  &usage;
+  &installation;
+  &bugreport;
+  &glossary;
+
+
+<!-- ============= Authors =================================== -->
+  &programmers;
+<!--  &writers; -->
+
+<!-- ============= Application License ======================= -->
+  &fdl-app;
+
+</book>

Index: doc/C/introduction.xml
===================================================================
RCS file: doc/C/introduction.xml
diff -N doc/C/introduction.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/introduction.xml      4 Mar 2008 08:56:10 -0000       1.2.2.2
@@ -0,0 +1,97 @@
+<chapter id="intro">
+  <title>Introduction</title>
+  
+  <para>
+    &app; is a free SWF movie player.  It is available as a
+    stand-alone application or as a plugin for several popular
+    web browsers. It supports playing media from a disk or streaming
+    over a network connection. Some popular video sharing sites like
+    YouTube are supported on a wide variety of devices from
+    embedded ones to modern desktops.
+  </para>
+
+  <para>
+    &app; has a better focus on security, allowing the user tight
+    control of all network or disk based I/O. Gnash also supports
+    extending ActionScript by creating your own classes. You can write
+    wrappers for any development library, and import them into the
+    player much like Perl or Python does.
+  </para>
+
+  <sect1 id="audience">
+    <title>Audience</title>
+    
+    <para>
+      This manual is primarily focused on users interested in how to
+      get Gnash installed from a package, and basic usage as a web
+      browser plugin. For more technical details, please refer to the
+      Gnash Reference manual.
+    </para>
+    
+  </sect1>    
+  
+  <sect1 id="runs-on">
+    <title>What Is Supported?</title>
+    
+    <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 known to
+      run on are Ubuntu, Fedora, Debian, Mandriva, 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>
+    
+    <para>
+      Gnash is capable of reading up to SWF v9 files and opcodes,
+      but primarily supports SWF v7, with better SWF v8 and v9
+      support under heavy development. 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>
+    
+    <para>
+      Gnash has implemented about 80% of ActionScript v2.0, and has
+      begun implementing ActionScript v3.0. Gnash supports the
+      majority of Flash opcodes up to SWF v9, and a wide
+      sampling of ActionScript classes for SWF v8.
+    </para>
+     <para>
+      As ActionScript 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>
+    
+    <para>
+      Gnash has included video support since early 2007, but this is
+      an ever 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>
+      Gnash uses ffmpeg for codecs, so any file supported 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>
+
+</chapter>
+

Index: doc/C/security.xml
===================================================================
RCS file: doc/C/security.xml
diff -N doc/C/security.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/security.xml  4 Mar 2008 08:56:10 -0000       1.2.2.2
@@ -0,0 +1,108 @@
+  <sect1 id="spec-security">
+    <title>Security</title>
+    
+    <para>
+      Many Flash implementations contain potential security exploits that
+      could compromise a viewer's system.  With &app;, an end-user has the
+      ability to see "what's going on" &mdash; what types of data the
+      application accesses, where it is found, and how it is used. Many
+      known Flash exploits are included in the &app; test suite that is
+      used to check whether a release is ready for the public. The &app;
+      developers are also in the process of a security review, developing a
+      security layer that will protect an end-user, no matter what operating
+      system they use. 
+    </para>
+    
+    <para>
+      One early security feature is the blacklist/whitelist.  Flash movies
+      running in a browser can make outgoing network connections. This can
+      be used, for example, to compromise a network device inside a
+      company firewall via a Flash movie running on an employee's
+      browser. &app; allows you to blacklist hosts that you know are
+      insecure, or to whitelist hosts you know are secure, by editing a
+      configuration file.
+    </para>
+    
+    <sect2 id="lso">
+      <title>Local Shared Objects</title>
+      
+      <para>
+       SWF movies support a form of persistent storage called Local
+       Shared Objects. These are stored in the subdirectories of one's
+       <emphasis>~/.macromedia</emphasis> configuration. These files
+       are comonly called &quot;Flash Cookies&quot;, as they don't get
+       deleted when the SWF movie that created or writes data to them
+       stops executing. These files often store things like game
+       scores, but can also store a unique identifier for tracking users.
+      </para>
+      
+      <para>
+       Till recently, what was contained in these files wasn't widely
+       known. There are several LSO file utilities floating around on
+       the Web. &app; has its own <emphasis>soldumper</emphasis>
+       program that lets one find and dump the contents of these
+       files. As of yet, I haven't discovered any nasty privacy issues
+       yet, but as &app;'s SharedObject support is new, I may have just
+       been lucky.
+      </para>
+      
+      <para>
+       An LSO file uses a <emphasis>.sol</emphasis>suffix, and is
+       stored in binary, big endian format. While one can look at the
+       data in any binary editor or hex dumper, it's easier to use
+       soldumper, which knows how to decode all the objects. The data
+       is stored in AMF format, a simple data interhange formats used
+       in several other places in SWF.
+      </para>
+      
+      <para>
+       The one security setting &app; supports is the
+       <emphasis>SOLReadOnly</emphasis> setting for your $HOME/.gnashrc
+       file. This makes &app; never write to a .sol file, it only reads
+       them. You can also set <emphasis>SOLSafeDir</emphasis> to a safe
+       subdirectory, or even remove it later, although most people
+       will want to set this path to the default one created by the other
+       SWF player.
+      </para>
+      
+    </sect2>
+    
+    <sect2 id="lc">
+      <title>Local Connections</title>
+      
+      <para>
+       SWF movies support a form of data interchange between running
+       SWF movies called LocalConnection. This uses a shared memory
+       segment to exchange AMF objects. While the specification claims
+       an application has to register as a Listener, it turns out in
+       reality that this isn't required. Even YouTube violates this
+       requirement. While one would think that data written to this
+       memory segment would go away when the SWF movies are done
+       playing, they are in fact persistent, and on some systems, the data
+       even survives a reboot. Thank you Solaris...
+      </para>
+      
+      <para>
+       The &app; utility <emphasis>dumpshm</emphasis> can be used to do
+       several things with these shared memory segments. This utility
+       can find the shared memory segment left by using other SWF
+       players to see what has been left. it can then dump the contents
+       of the shared mempory segment either by decoding the AMF objects
+       and printing the values, or by dumping the raw file to disk
+       where you can analyze it with any other program you wish. If
+       you run dumpshm repeatedly, you can even do crude packet
+       sniffing between two SWF movies playing.
+      </para>
+      
+      <para>
+       The only current security related option for this is
+       <emphasis>LocalConnection</emphasis>. This just disables all
+       communication with other SWF movies. Work is in progress on
+       adding a tracing ability to &app;.
+      </para>
+      
+    </sect2>
+ 
+</sect1>
+
+</chapter>

Index: doc/C/usermanual/gnashrc.xml
===================================================================
RCS file: doc/C/usermanual/gnashrc.xml
diff -N doc/C/usermanual/gnashrc.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/usermanual/gnashrc.xml        4 Mar 2008 08:56:10 -0000       1.2.2.2
@@ -0,0 +1,308 @@
+<sect1 id="gnashrc">
+  <title>User Configuration File</title>
+  
+  <para>
+    Individual user preferences may be set by editing variables with
+    the <filename>.gnashrc</filename> file: 
+    <programlisting>
+      ~/.gnashrc
+    </programlisting>
+  </para>
+  
+  <para>
+    Each line must begin with an action: either
+    <emphasis>set</emphasis> or, in the case of lists, also 
+    <emphasis>append</emphasis>.
+  </para>
+  
+  <para>
+    The values in this configuration file apply only to an individual
+    user, and become the default settings of the standalone player and
+    the plugin.  Note that any command line options take precedence
+    over <filename>.gnashrc</filename> settings. 
+  </para>
+
+  <para>
+    The variables in the <filename>.gnashrc</filename> file support
+    three types of arguments: on/off, numeric values, or in the case
+    of the whitelist and blacklist, a list of hostnames as ASCII text. 
+  </para>  
+  
+  <table id="tb-config-variables">
+    <title>User Configuration Variables</title>
+    <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+      <thead>
+       <row>
+         <entry>Variable</entry>
+         <entry>Value</entry>
+         <entry>Function</entry>
+       </row>
+      </thead>
+      <tbody>
+       <row>
+         <entry>localdomain</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls the loading of
+         external Flash movies over a network. This option
+         tells Gnash to only load Flash movies from the existing 
domain.</entry>
+       </row>
+       <row>
+         <entry>localhost</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls the loading of
+         external Flash movies over a network. This is a stricter
+         version of the <emphasis>localdomain</emphasis> setting as
+         this allows the loading of Flash movies to the same host
+         that is running &app;.</entry>
+       </row>
+       <row>
+         <entry>whitelist</entry>
+         <entry>hostnames</entry>
+         <entry>This is a list of hostnames separated by spaces, or 
<emphasis>off</emphasis>
+         to disable the whitelist. The hostname must be given
+         without a protocol (http://, https://). If this list is populated,
+         &app; will only load external Flash movies from the specified hosts.  
The
+         whitelist takes precedence over the blacklist. Because several files 
can
+         be parsed in succession, each file can override or add to
+         lists in other files. Use <emphasis>set</emphasis> to override
+         all other lists or <emphasis>append</emphasis> to add your blacklisted
+         hosts to lists in previously parsed files.</entry>
+       </row>
+       <row>
+         <entry>blacklist</entry>
+         <entry>hostnames</entry>
+         <entry>This is a list of hostnames separated by spaces, or 
<emphasis>off</emphasis>
+         to disable the blacklist. The hostname must be given
+         without a protocol (http://, https://).
+         External flash movies from these
+         domains are never allowed to load. If whitelist is present
+         and not empty, blacklist is not used. Because several files can
+         be parsed in succession, each file can override or add to
+         lists in other files. Use <emphasis>set</emphasis> to override
+         all other lists or <emphasis>append</emphasis> to add your blacklisted
+         hosts to lists in previously parsed files.</entry>
+       </row>
+       <row>
+         <entry>localSandboxPath</entry>
+         <entry>dirs</entry>
+         <entry>This is a list of directories separated by spaces.
+         Only resources from these directories and from the directory
+         portion of movie filename (if loaded from filesystem) are allowed to 
load.
+         Because several files can be parsed in succession, each file can 
override
+         or add to lists in other files. Use <emphasis>set</emphasis> to 
override
+         all other lists or <emphasis>append</emphasis> to add new sandboxes.
+         Note that there's currently no way to *drop* the directory of base dir
+         from the list of allowed local sandboxes.
+         </entry>
+       </row>
+       <row>
+         <entry>delay</entry>
+         <entry>Number</entry>
+         <entry>&app; uses a timer-based event mechanism to advance frames
+         at a steady rate. This option overrides the default
+         setting in Gnash to play a movie slower or faster.</entry>
+       </row>
+       <row>
+         <entry>verbosity</entry>
+         <entry>Number</entry>
+         <entry>This is a numeric value which defines the default level of
+         verbosity from the player.</entry>
+       </row>
+       <row>
+         <entry>MalformedSWFVerbosity</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls whether malformed SWF errors 
should
+         be printed. If set to true, verbosity level is automatically 
incremented.
+         Set <option>verbosity</option> to 0 afterwards to hush.</entry>
+       </row>
+       <row>
+         <entry>ASCodingErrorsVerbosity</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls whether ActionScript coding
+         errors should be printed. If set to true, verbosity level is
+         automatically incremented.  Set <option>verbosity</option> to 0 
afterwards to hush.</entry>
+       </row>
+       <row>
+         <entry>debuglog</entry>
+         <entry>Absolute path</entry>
+         <entry>This is the full path and name of debug logfile as
+         produced by &app;. On systems with a UNIX-type shell,
+         a tilde prefix (~) will be expanded as by Posix shell requirements
+         (see 
http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_01).</entry>
+       </row>
+       <row>
+         <entry>writelog</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls whether a debug log
+         is always written by &app;, or not at all.</entry>
+       </row>
+       <row>
+         <entry>sound</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls the sound of the
+         standalone player. By default &app; enables playing the
+         sound in any Flash movie.</entry>
+       </row>
+       <row>
+         <entry>pluginsound</entry>
+         <entry>on/off</entry>
+         <entry>This value can be set to either <emphasis>on</emphasis> or
+         <emphasis>off</emphasis>, and controls the sound of the
+         player when running as a browser plugin. By default, sound
+         is enabled when using &app; as a browser plugin.</entry>
+       </row>
+       <row>
+         <entry>EnableExtensions</entry>
+         <entry>on/off</entry>
+         <entry>Set to <emphasis>on</emphasis> to enable extensions. This 
option is <emphasis>off</emphasis> by default</entry>
+       </row>
+       <row>
+         <entry>StartStopped</entry>
+         <entry>on/off</entry>
+         <entry>Set to <emphasis>on</emphasis> to have the GUI start in "stop" 
mode. This is useful in particular
+         for the plugin, so you have to explicitly start any movie on a 
webpage. This option is <emphasis>off</emphasis> by default.
+         </entry>
+       </row>
+       <row>
+         <entry>flashVersionString</entry>
+         <entry>string</entry>
+         <entry>Set the string returned by $version and 
System.capabilities.version.
+         Useful to get around some flash version detection movies.
+         Note that the version advertised by the plugin is NOT affected by 
this setting,
+         instead you need to set the GNASH_FLASH_VERSION environment variable 
for
+         the latter (which doesn't affect $version and 
System.capabilities.version).</entry>
+       </row>
+       
+       <row>
+         <entry>flashSystemOS</entry>
+         <entry>string</entry>
+         <entry>The string that Gnash should return for 
System.capabilities.OS</entry>
+       </row>
+       
+       <row>
+         <entry>flashSystemManufacturer</entry>
+         <entry>string</entry>
+         <entry>The string that Gnash should return for 
System.capabilities.manufacturer</entry>
+       </row>
+       
+       <row>
+         <entry>StreamsTimeout</entry>
+         <entry>double</entry>
+         <entry>
+           Set the number of seconds after which streams download time out. 
Note that timeouts only occurs after the given number of seconds
+           passed w/out anything was received.
+         </entry>
+       </row>
+       
+       <row>
+         <entry>insecureSSL</entry>
+         <entry>on/off</entry>
+         <entry>If set to <emphasis>on</emphasis>, no verification of SSL 
connections
+         is performed. This means that, although the connection is encrypted, 
the server
+         certificate could be invalid, may not belong to the host, or both. 
Equivalent
+         to curl --insecure. By default, this option is 
<emphasis>off</emphasis> and
+         connections will fail when a host cannot be verified.</entry>
+       </row>
+       
+       <row>
+         <entry>SOLsafedir</entry>
+         <entry>Absolute path</entry>
+         <entry>The full path to a directory where &app; should store Shared 
Object files (&quot;flash cookies&quot;) if
+         they are enabled.</entry>
+       </row>
+       
+       <row>
+         <entry>SOLreadonly</entry>
+         <entry>on/off</entry>
+         <entry>If set to <emphasis>on</emphasis>, &app; will not write Shared 
Object files.</entry>
+       </row>
+       
+       <row>
+         <entry>URLOpenerFormat</entry>
+         <entry>string</entry>
+         <entry>
+           Set the format of an url opener command. The %u label would be 
substituted by the actual url to be opened.
+           Examples:
+           <programlisting>
+             set urlOpenerFormat firefox -remote 'openurl(%u)'
+             set urlOpenerFormat xdg-open %u
+             set urlOpenerFormat open %u
+             set urlOpenerFormat kfmclient exec %u
+           </programlisting>
+         </entry>
+       </row>
+       
+      </tbody>
+    </tgroup>
+  </table>
+  
+  
+  <para>
+    The following example <filename>.gnashrc</filename> file allows a user to 
only play Flash files saved locally to the machine on which &app; is running.  
It also specifically forbids content from doubleclick.com and mochibot.com.  
&app;'s error output is set to be fairly verbose, with the debug log placed in 
a location convenient for the user.  Finally, sound is turned on for both the 
standalone player and the plugin.
+  </para>
+  
+  <programlisting>
+    
+    #
+    # Gnash client options
+    #
+    
+    # Only access remote content from our local domain
+    set localdomain on
+    
+    # Only access content from our local host
+    set localhost on
+    
+    # These sites are OK
+    # uncommenting the following line will allow load of external
+    # movies *only* from the specified hosts.
+    #set whitelist www.doonesbury.com www.cnn.com www.9news.com
+    
+    # Disable whitelists set in any other gnashrc files, because
+    # these could override our blacklist.
+    set whitelist off
+    
+    # Don't access content from these sites
+    set blacklist www.doubleclick.com mochibot.com
+    
+    # The delay between timer interrupts
+    set delay 50
+    
+    # The default verbosity level
+    set verbosity 1
+    
+    # Be verbose about malformed SWF
+    set MalformedSWFVerbosity true
+    
+    # Be verbose about AS coding errors
+    set ASCodingErrorsVerbosity true
+    
+    # The full path to the debug log
+    set debuglog ~/gnash-dbg.log
+    
+    # Write a debug log to disk
+    set writelog on
+    
+    # Enable or Disable sound for the standalone player
+    set sound on
+    
+    # Enable or Disable sound for the standalone player
+    set pluginsound on
+    
+    # Make sure SSL connections are always verified
+    set insecureSSL off
+    
+    # Use firefox to open urls
+    set urlOpenerFormat firefox -remote 'openurl(%u)'
+    
+  </programlisting>
+  
+  
+</sect1>
+




reply via email to

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