[Gnash-commit] gnash doc/C/gnash.xml ChangeLog doc/C/gnashrc.xml

[Rob Savoye]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Rob Savoye <rsavoye>    06/10/16 17:13:01

Modified files:
        doc/C          : gnash.xml 
        .              : ChangeLog 
Added files:
        doc/C          : gnashrc.xml 

Log message:
                * doc/C/gnashrc.xml: New section on the Gnash configuration file
                and it's settings.
                * doc/C/gnash.xml: Add section on the Gnash configuration file.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnash.xml?cvsroot=gnash&r1=1.30&r2=1.31
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnashrc.xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.1244&r2=1.1245

Patches:
Index: doc/C/gnash.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/gnash.xml,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -b -r1.30 -r1.31
--- doc/C/gnash.xml     15 Oct 2006 12:02:31 -0000      1.30
+++ doc/C/gnash.xml     16 Oct 2006 17:13:01 -0000      1.31
@@ -53,6 +53,7 @@
   <!ENTITY logging SYSTEM "logging.xml">
   <!ENTITY opcodes SYSTEM "opcodes.xml">
   <!ENTITY rtmp SYSTEM "rtmp.xml">
+  <!ENTITY gnashrc SYSTEM "gnashrc.xml">
  ]
 >
 
@@ -681,6 +682,9 @@
        </varlistentry>
       </variablelist>
     </sect2>
+
+    &gnashrc;
+
   </sect1>
 
   &sources;

Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.1244
retrieving revision 1.1245
diff -u -b -r1.1244 -r1.1245
--- ChangeLog   16 Oct 2006 16:47:27 -0000      1.1244
+++ ChangeLog   16 Oct 2006 17:13:01 -0000      1.1245
@@ -1,9 +1,14 @@
 2006-10-16 Hannes Mayr <address@hidden>
-       * gui/gtk.cpp: Use set_invalidated_region() only with AGG renderer until
-               world_to_pixel() is implemented for triangle-based renders.
+
+       * gui/gtk.cpp: Use set_invalidated_region() only with AGG renderer
+       until world_to_pixel() is implemented for triangle-based renders.
 
 2006-10-16  Rob Savoye  <address@hidden>
 
+       * doc/C/gnashrc.xml: New section on the Gnash configuration file
+       and it's settings.
+       * doc/C/gnash.xml: Add section on the Gnash configuration file.
+       
        * gui/gtksup.h: Add prototype for menuitem_sound_callback.
        * gui/gtk.cpp: Add menuitem_sound_callback, and a "Toggle Sound"
        menu item.

Index: doc/C/gnashrc.xml
===================================================================
RCS file: doc/C/gnashrc.xml
diff -N doc/C/gnashrc.xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ doc/C/gnashrc.xml   16 Oct 2006 17:13:01 -0000      1.1
@@ -0,0 +1,178 @@
+<?xml version="1.0" encoding="utf-8"?>
+<sect2 id="gnashrc">
+  <title>User Configuration File</title>
+
+  <para>
+    Gnash supports a configuration file that lives in the users home
+    directory. This file is called <emphasis>.gnashrc</emphasis>. In
+    this you can have default settings which will be used by Gnash
+    when running standalone, or as a browser plugin. Any command line
+    options override these values.
+  </para>
+
+  <para>
+    Gnash supports three types of configuration variables. The three
+    types are an on/off value, a numeric value, or in the case of the
+    whitelist and blacklist, a list of domain names as ASCII text.
+  </para>
+
+   <variablelist>
+      <varlistentry>
+       <term>localdomain</term>
+       <listitem>
+         <para>
+           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. Traditionally this
+           tells Gnash to only load Flash movies from the existing domain.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>localhost</term>
+       <listitem>
+         <para>
+           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
+           Gnash is running on.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>whitelist</term>
+       <listitem>
+         <para>
+           This is a list of domain names, seperated by a colon
+           <emphasis>:</emphasis> that we always allow the loading of
+           external Flash movies from.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>blacklist</term>
+       <listitem>
+         <para>
+           This is a list of domain names, seperated by a colon
+           <emphasis>:</emphasis> that we never allow the loading of
+           external Flash movies from.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>delay</term>
+       <listitem>
+         <para>
+           Gnash uses a timer based event mechanism to advance frames
+           at a steady rate. This lets one override the default
+           setting in Gnash to play a movie slower or faster.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>verbosity</term>
+       <listitem>
+         <para>
+           This is a numeric value that defines the default level of
+           verbosity from the player.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>debuglog</term>
+       <listitem>
+         <para>
+           This is the full path and name of debug logfile as
+           produced by Gnash.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>writelog</term>
+       <listitem>
+         <para>
+           This value can be set to either <emphasis>on</emphasis> or
+           <emphasis>off</emphasis>, and controls whether a debug log
+           is always written by Gnash, or not at all.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>sound</term>
+       <listitem>
+         <para>
+           This value can be set to either <emphasis>on</emphasis> or
+           <emphasis>off</emphasis>, and controls the sound of the
+           standalone player. By default Gnash enables playing the
+           sound in any Flash movie.
+         </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>pluginSound</term>
+       <listitem>
+         <para>
+           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 Gnash as a browser plugin.
+         </para>
+       </listitem>
+      </varlistentry>
+   </variablelist>
+
+  <para>
+    My current Gnash configuration file looks like this:
+  </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
+    set whitelist www.doonesbury.com:www.cnn.com:www.9news.com
+
+    # Don't access content from these sites
+    set blacklist www.doubleclick.com:mochibot.com
+
+    # The delay between timer interupts
+    set delay 50
+
+    # The default verbosity level
+    set verbosity 1
+
+    # 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
+
+  </programlisting>
+
+
+</sect2>
+