[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc/C/usermanual bugreport.xml glossary.x...
|
From: |
Rob Savoye |
|
Subject: |
[Gnash-commit] gnash/doc/C/usermanual bugreport.xml glossary.x... |
|
Date: |
Tue, 26 Feb 2008 15:20:52 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Rob Savoye <rsavoye> 08/02/26 15:20:52
Modified files:
doc/C/usermanual: bugreport.xml glossary.xml installation.xml
introduction.xml revisions.xml
Added files:
doc/C/usermanual: gnashrc.xml
Log message:
New user manual, rewritten and reorganized, probably needs to be
spell-checked.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/bugreport.xml?cvsroot=gnash&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/glossary.xml?cvsroot=gnash&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation.xml?cvsroot=gnash&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/introduction.xml?cvsroot=gnash&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/revisions.xml?cvsroot=gnash&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/gnashrc.xml?cvsroot=gnash&rev=1.1
Patches:
Index: bugreport.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/bugreport.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- bugreport.xml 19 Feb 2008 02:06:30 -0000 1.5
+++ bugreport.xml 26 Feb 2008 15:20:50 -0000 1.6
@@ -1,74 +1,50 @@
<chapter id="bugreport">
<title>Reporting Bugs</title>
-<para>
- The &app; project relies on the community to use and test the
- player; feedback is critical to any successful project. Not only
- does it let us know that people use &app;, but it helps us
- understand the community's needs. &app; uses a bug tracker on
+ <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>
-<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.
-</para>
- <orderedlist>
- <listitem><para>
- <link linkend="bugstep_newcheckout">Compile the latest
- &app; build.</link>
- </para></listitem>
- <listitem><para>
- <link linkend="bugstep_search">Determine if the bug was
- previously reported.</link>
- </para></listitem>
- <listitem><para>
- <link linkend="bugstep_guidelines">Review the bug writing
- guidelines.</link>
- </para></listitem>
- </orderedlist>
-
-
- <sect1 id="bugstep_newcheckout">
- <title>Compile the latest &app; build</title>
- <para>
- Obtain a copy of the latest <link linkend="sourcerepo">development
- checkout</link> or <link linkend="sourcesnapshot">development
- snapshot</link>. Put the source in an empty directory, then
- <link linkend="pre-configuration">configure</link> and
- <link linkend="compile">compile</link> &app;.
+ 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, it's
+ 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>
- If you are able to replicate the bug in the latest version,
- <link linkend="bugstep_search">proceed to the next step</link>.
- If you cannot replicate the bug with the newer version, the
- problem may have been solved, or the issue may involve your
- environment
+ 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>
-
- <para>
- To check this, create a fresh build of the version in which you
- encountered the bug. If you can reproduce the bug with the
- fresh copy of the original version, but cannot with the latest
- version, this is most likely a resolved bug.
-</para>
-
-<para>
- If you cannot reproduce the bug, it may still be unclear whether the
- bug is related to your environment or a &app; bug. Try to determine
- the source of the problem. &app; offers several helpful debugging
- options in the configure stage, and many verbosity options at the
- command line to help.
-</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";>&app;
+ url="https://savannah.gnu.org/bugs/?group=gnash";>Gnash
bug tracker</ulink> to see if the bug has already been identified.
</para>
<para>
@@ -109,20 +85,19 @@
<listitem>
<para>
Your system information: operating system name and version, as
- well as the versions of major <link
- linkend="codedepend">dependencies</link>;
+ well as the versions of major development dependencies;
</para>
</listitem>
<listitem>
<para>
- The release number or checkout timestamp for the version of &app;
+ 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; and
+ attached as a file;
</para>
</listitem>
<listitem>
Index: glossary.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/glossary.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- glossary.xml 19 Feb 2008 02:30:50 -0000 1.5
+++ glossary.xml 26 Feb 2008 15:20:50 -0000 1.6
@@ -146,12 +146,11 @@
</glossterm>
<glossdef>
<para>
- A &app; <emphasis>extension</emphasis> is a plugin (not
- a browser plugin) which
- implements additional
- functionality beyond what is covered by
- <emphasis>Flash</emphasis> specification.
- These are shared libraries which are loaded at runtime.
+ A &app; <emphasis>extension</emphasis> is a plugin (not a
+ browser plugin) which implements additional functionality
+ beyond what is covered by <emphasis>Flash</emphasis>
+ specification. These are shared libraries which are loaded
+ at runtime.
</para>
</glossdef>
</glossentry>
@@ -182,8 +181,9 @@
<para>
The term <emphasis>Flash</emphasis> is used to describe both the
Adobe IDE for creating <emphasis>SWF</emphasis>
- files, and the technology itself.
- &app; documentation uses the latter definition.
+ files, and the technology itself. Flash is a trademarked
+ term of Adobe's, we prfer to use SWF to refer to the files
+ themselves, as well as the format, instead of flash(tm).
</para>
</glossdef>
</glossentry>
@@ -287,7 +287,7 @@
library provides a wrapper for mouse and keyboard events,
menus, windowing (where available) and a drawing area.
You must choose a GUI library during the
- <link linkend="pre-configuration">configuration</link> stage.
+ configuration stage of building Gnash.
</para>
</glossdef>
</glossentry>
@@ -476,7 +476,7 @@
<para>
The <emphasis>renderer</emphasis> is the subsystem of &app;
which renders content. Only one renderer may be used; it is
- chosen during <link linkend="pre-configuration">configuration</link>.
+ selected at configuration time if building from source.
</para>
<para>
Available renderers are: AGG, OpenGL, and Cairo. In terms of
@@ -565,7 +565,7 @@
which handles both event sounds and streaming sound. Audio
from external sources are also handled through the sound handler
when SDL is used. The sound handler must be selected during
- <link linkend="pre-configuration">configuration</link>.
+ configuration of Gnash when compiling.
</para>
<para>
There are currently two sound handlers available in &app;:
@@ -597,8 +597,7 @@
</glossterm>
<glossdef>
<para>
- The visible area of a Flash movie. The name derives from a
- theater analogy. Graphical elements are referred to as
+ The visible area of a Flash movie. The name derives from a
theater analogy. Graphical elements are referred to as
characters.
</para>
</glossdef>
Index: installation.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- installation.xml 19 Feb 2008 02:06:30 -0000 1.6
+++ installation.xml 26 Feb 2008 15:20:51 -0000 1.7
@@ -1,8 +1,8 @@
<chapter id="build">
- <title>Installing and Configuring &app;</title>
+ <title>Installing and Configuring Gnash</title>
<para>
- There are two ways of installing &app;:
+ There are two ways of installing Gnash:
<link linkend="packagemanager">using a package manager</link>
or <link linkend="gettingsource">installing from source</link>.
</para>
@@ -11,7 +11,7 @@
<title>Requirements</title>
<para>
- Before downloading and installing &app;, check that your
+ Before downloading and installing Gnash, check that your
hardware and software meet the following requirements.
</para>
@@ -19,12 +19,12 @@
<title>Hardware Requirements</title>
<para>
- One of the goals of &app; is to make it portable enough to install on
- small devices. As a result, the hardware requirements are
- minimal. &app; has even run on an ARM9 at 200 MHz with 64 MB of RAM!
- (It ran without video support in this case.) While firm minimums
- have not been established, &app; has been shown to run successfully
- with the following:
+ One of the goals of Gnash is to make it portable enough to
+ install on small devices. As a result, the hardware
+ requirements are minimal. Gnash has even run on an ARM9 at 200
+ MHz with 32 MB of RAM! (It ran without video support in this
+ case.) While firm minimums have not been established, Gnash
+ has been shown to run successfully with the following:
</para>
<itemizedlist>
@@ -35,20 +35,20 @@
</listitem>
<listitem>
<para>
- 256 MB RAM
+ 128 MB RAM
</para>
</listitem>
<listitem>
<para>
- Video — &app; will run on anything from a raw frame buffer up
to
- an OpenGL-supporting graphics card.
+ Video — Gnash will run on anything from a raw frame
+ buffer up to an OpenGL-supporting graphics card.
</para>
</listitem>
</itemizedlist>
<para>
The following table provides a list of the Operating System/CPU
- combinations on which &app; has been shown to run.
+ combinations on which Gnash has been shown to run.
</para>
<table id="tb-os-cpu">
@@ -58,8 +58,8 @@
<colspec colname='CPU' />
<thead>
<row>
- <entry>Render GUI</entry>
- <entry>Virtual Memory</entry>
+ <entry>Operating System</entry>
+ <entry>Processor</entry>
</row>
</thead>
<tbody>
@@ -69,14 +69,6 @@
</entry>
</row>
<row>
- <entry>ALTLinux</entry>
- <entry>i586</entry>
- </row>
- <row>
- <entry>Arklinux</entry>
- <entry>i586</entry>
- </row>
- <row>
<entry>Debian</entry>
<entry>Alpha AXP, AMD64, ARM, hppa, i386, Itanium, MIPS,
PowerPC, IBM zSeries (s390), SPARC
@@ -108,10 +100,10 @@
<row>
<entry>Mandriva
</entry>
- <entry>i386</entry>
+ <entry>i386, MIPS</entry>
</row>
<row>
- <entry>Open Embedded
+ <entry>Open Embedded, OpenMoko, Poky
</entry>
<entry>ARM
</entry>
@@ -129,7 +121,7 @@
</entry>
</row>
<row>
- <entry>Red Hat Enterprise and CentOS
+ <entry>Red Hat Enterprise, CentOS
</entry>
<entry>x86-32, x86-64
</entry>
@@ -145,6 +137,10 @@
<entry>i386</entry>
</row>
<row>
+ <entry>Syllable</entry>
+ <entry>i386</entry>
+ </row>
+ <row>
<entry>Irix 6.5
</entry>
<entry>MIPS R10K
@@ -157,16 +153,7 @@
</entry>
</row>
<row>
- <entry>NetBSD</entry>
- <entry>many, including VAX
- </entry>
- </row>
- <row>
- <entry>OpenBSD</entry>
- <entry>many, including VAX, OS/2 and eComstation</entry>
- </row>
- <row>
- <entry>Windows</entry>
+ <entry>Windows XP, Windows Vista</entry>
<entry>x86-32</entry>
</row>
</tbody>
@@ -179,57 +166,45 @@
<title>Software Requirements</title>
<para>
- The &appversion; release of &app; has been designed to run on
+ The &appversion; release of Gnash has been designed to run on
UNIX/Linux variants, and has been run on most of the free ones.
- However, &app; has successfully run on Windows, Darwin (Mac OS X),
- Irix, Solaris, BeOs, OS/2, and Haiku. &app; has also run on the
+ However, Gnash has successfully run on Windows, Darwin (Mac OS X),
+ Irix, Solaris, BeOs, OS/2, and Haiku. Gnash has also run on the
following 64-bit systems: PowerPC, Itanium, UltraSparc, and AMD64.
For now, it is important to be sure that the following code, testing,
- and documentation dependencies are met before installing &app;. If
- you will be downloading &app; with a package manager, these
+ and documentation dependencies are met before installing Gnash. If
+ you will be downloading Gnash with a package manager, these
dependencies may be solved by the package manager. Otherwise, you
must first verify that each of these dependencies are installed on the
target system.
</para>
- <sect3 id="codedepend">
- &codedependencies;
- </sect3>
-
- <sect3 id="testdepend">
- &testdependencies;
- </sect3>
-
- <sect3 id="docdepend">
- &docdependencies;
- </sect3>
-
</sect2>
</sect1>
<sect1 id="downloading">
- <title>Downloading &app;</title>
+ <title>Downloading Gnash</title>
<para>
- There are two ways to download &app;: using a package manager or by
+ There are two ways to download Gnash: using a package manager or by
downloading the source code and building it on your system. If
- possible, it is advisable to use a package manager to download &app;,
+ possible, it is advisable to use a package manager to download Gnash,
as it will resolve dependencies for you. However, if you want the
- very latest features, or a &app; package is not available for your
+ very latest features, or a Gnash package is not available for your
operating system, it is better to download the source code and build
- &app; locally.
+ Gnash locally.
</para>
- <sect2 id="packagemanager">
- &pkgmanager;
- </sect2>
+<!-- <sect2 id="packagemanager"> -->
+<!-- &pkgmanager; -->
+<!-- </sect2> -->
<sect2 id="gettingsource">
<title>Getting the Source</title>
<para>
- &app; is available as a <link linkend="sourcereleases">release
+ Gnash is available as a <link linkend="sourcereleases">release
tarball</link>, a <link linkend="sourcerepo">development
checkout</link>, or a <link linkend="sourcesnapshot">development
snapshot</link>.
@@ -255,6 +230,19 @@
</para>
</sect3>
+ <sect3 id="sourcesnapshot">
+ <title>Snapshot</title>
+
+ <para>
+ The daily development snapshot can be downloaded from
+ <ulink url="http://www.gnashdev.org/dev_snapshots/";
+ type="http">http://www.gnashdev.org/dev_snapshots/</ulink>.
+ This is the best option if you need changes which were introduced
+ after the <link linkend="sourcereleases">last release</link> of
+ Gnash, but are unable to <link linkend="sourcerepo">download
+ directly from the repository.</link>
+ </para>
+ </sect3>
<sect3 id="sourcerepo">
<title>Repository</title>
@@ -285,38 +273,24 @@
</para>
</sect3>
- <sect3 id="sourcesnapshot">
- <title>Snapshot</title>
+ </sect2>
+
+ <sect2 id="getcodecs">
+ <title>Getting Codec Support</title>
<para>
- The daily development snapshot can be downloaded from
- <ulink url="http://www.gnashdev.org/dev_snapshots/";
- type="http">http://www.gnashdev.org/dev_snapshots/</ulink>.
- This is the best option if you need changes which were introduced
- after the <link linkend="sourcereleases">last release</link> of
- &app;, but are unable to <link linkend="sourcerepo">download
- directly from the repository.</link>
+ Gnash requires codec support to handle audio and video
+ correctly. Some platforms like Ubuntu or Fedora under the
+ GNOME desktop will automatically notify the user that the
+ proper codecs aren't installed, and pop up a dialog box to
+ let the user download the codecs Gnash needs to make site
+ like YouTube work correctly. If you have installed Gnash on
+ any other platform, and video
</para>
- </sect3>
</sect2>
</sect1>
- <sect1 id="pre-configuration">
- <title>Pre-Compile Configuration</title>
-
- &configuration;
-
- </sect1>
-
- <sect1 id="compiling">
- &building;
- </sect1>
-
- <sect1 id="install">
- &install;
- </sect1>
-
</chapter>
Index: introduction.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/introduction.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- introduction.xml 20 Feb 2008 05:16:20 -0000 1.5
+++ introduction.xml 26 Feb 2008 15:20:51 -0000 1.6
@@ -18,6 +18,17 @@
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>
@@ -67,7 +78,7 @@
</para>
<para>
- Gnash uses ffmpeg for codecs, so any file suppored by Mplayer
+ 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
@@ -76,19 +87,5 @@
</para>
</sect1>
- <sect1 id="audience">
- <title>Audience</title>
-
- <para>
- This manual is primarily focused on developers interested in
- contributing to or building from the &app; project. It serves as a
- detailed reference guide, including a catalog and explanation of all
- options and features. This level of detail may make this guide
- cumbersome for the average user, although advanced users may find it
- helpful.
- </para>
-
- </sect1>
-
</chapter>
Index: revisions.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/revisions.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- revisions.xml 13 Feb 2008 02:30:10 -0000 1.4
+++ revisions.xml 26 Feb 2008 15:20:51 -0000 1.5
@@ -1,42 +1,18 @@
- <revhistory>
+<revhistory>
<revision>
- <revnumber>&appname; Manual version 0.3.0</revnumber>
- <date>Oct 2006</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>
-
- <revision>
- <revnumber>&appname; Manual version 0.4.0</revnumber>
- <date>June 2007</date>
- <revdescription>
- <para role="author">Ann Barcomb
- <email>address@hidden</email>
- Rewritten for software version 0.8.0.
- </para>
-
- <para role="publisher">Free Software Foundation</para>
- </revdescription>
- </revision>
-
- <revision>
- <revnumber>&appname; Manual version 0.4.1</revnumber>
+ <revnumber>Gnash User Manual version 0.1</revnumber>
<date>Feb 2008</date>
<revdescription>
<para role="author">Rob Savoye
- <email>address@hidden</email>
- Updated for the 0.8.2 release.
+ <email>address@hidden</email>
+ The end user parts of the manual have been pulled out of
+ the original version of the manual, and rewritten.
</para>
- <para role="publisher">Free Software Foundation</para>
+ <para role="publisher">Open Media Now!</para>
</revdescription>
</revision>
- </revhistory>
+</revhistory>
+
\ No newline at end of file
Index: gnashrc.xml
===================================================================
RCS file: gnashrc.xml
diff -N gnashrc.xml
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ gnashrc.xml 26 Feb 2008 15:20:50 -0000 1.1
@@ -0,0 +1,307 @@
+<?xml version="1.0" encoding="utf-8"?>
+<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'>
+<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
+ 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 ("flash cookies") 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>
+
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash/doc/C/usermanual bugreport.xml glossary.x...,
Rob Savoye <=