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

[Melissa Goldin]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Melissa Goldin <mushi>  07/08/16 14:25:58

Modified files:
        doc/C/usermanual/usage: gnashrc.xml 

Log message:
        Added explanatory text for the example .gnashrc file

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/usage/gnashrc.xml?cvsroot=gnash&r1=1.5&r2=1.6

Patches:
Index: gnashrc.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/usage/gnashrc.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- gnashrc.xml 1 Aug 2007 05:00:45 -0000       1.5
+++ gnashrc.xml 16 Aug 2007 14:25:58 -0000      1.6
@@ -3,188 +3,146 @@
   <title>User Configuration File</title>
 
   <para>
-    Gnash supports a configuration file which 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>
+Individual user preferences may be set by editing variables with the 
<filename>.gnashrc</filename> file:
+<programlisting>
+~/.gnashrc
+</programlisting>
+</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>
-    Gnash supports three types of configuration variables. The three
-    types are an on/off value, a numeric value, or in the case of the
+<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>
 
-   <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
+      <table id="tb-config-variables">
+<title>User Configuration Variables</title>
+<tgroup cols='3' align='left' colsep='1' rowsep='1'>
+<colspec colname='Variable' />
+<colspec colname='Value' />
+<colspec colname='Function' />
+<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
-           Gnash is running on.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>whitelist</term>
-       <listitem>
-         <para>
-           This is a list of hostnames, separated by a colon
-           <emphasis>:</emphasis>. If this list is not empty,
-           only external flash movies from these hosts are allowed to
-           load.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>blacklist</term>
-       <listitem>
-         <para>
-           This is a list of hostnames, separated by a colon
+           that is running &app;.</entry>
+</row>
+<row>
+<entry>whitelist</entry>
+<entry>hostnames</entry>
+<entry>This is a list of hostnames, separated by a colon (:). If this list is 
populated, &app; will only load external Flash movies from the specified hosts. 
 The whitelist takes precedence over the blacklist.</entry>
+</row>
+<row>
+<entry>blacklist</entry>
+<entry>hostnames</entry>
+<entry>This is a list of hostnames, separated by a colon
            <emphasis>:</emphasis>.  External flash movies from these
             domains are never allowed to load. If whitelist is present
-           and not empty, blacklist is not used.
-         </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 which defines the default level of
-           verbosity from the player.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>MalformedSWFVerbosity</term>
-       <listitem>
-         <para>
-           This value can be set to either <emphasis>on</emphasis> or
+           and not empty, blacklist is not used.</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 'verbosity' to 0 afterwards to hush.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>ASCodingErrorsVerbosity</term>
-       <listitem>
-         <para>
-           This value can be set to either <emphasis>on</emphasis> or
+           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 'verbosity' to 0 afterwards to hush.
-         </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
+           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;.</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 Gnash, or not at all.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry id="standalonesound">
-       <term>sound</term>
-       <listitem>
-         <para>
-           This value can be set to either <emphasis>on</emphasis> or
+           is always written by Gnash, 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 Gnash enables playing the
-           sound in any Flash movie.  Refer to
-            <emphasis><link 
linkend="pluginsound">pluginsound</link></emphasis> 
-            to control sound for the browser plugin.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry id="pluginsound">
-       <term>pluginsound</term>
-       <listitem>
-         <para>
-           This value can be set to either <emphasis>on</emphasis> or
+           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 Gnash as a browser plugin.  Refer to
-            <emphasis><link linkend="standalonesound">sound</link></emphasis> 
-            for information about standalone player sound control.
-         </para>
-       </listitem>
-      </varlistentry>
+           is enabled when using Gnash 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>
+</tbody>
+</tgroup>
+</table>
 
-      <varlistentry>
-       <term>EnableExtensions</term>
-       <listitem>
-         <para>
-           Set to ``on'' to enable extensions. Off by default.
-         </para>
-       </listitem>
-      </varlistentry>
 
-      <varlistentry>
-       <term>StartStopped</term>
-       <listitem>
          <para>
-           Set to ``on'' 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. Off by default.
-         </para>
-       </listitem>
-      </varlistentry>
-
-   </variablelist>
+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>
 
-  <para>
-    My current Gnash configuration file looks like this:
-  </para>
   <programlisting>
   
     #