~ubuntu-branches/ubuntu/saucy/gnash/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/C/preformatted/gnashuser.html.in

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Sack
  • Date: 2008-10-13 14:29:49 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20081013142949-f6qdvnu4mn05ltdc
Tags: 0.8.4~~bzr9980-0ubuntu1
* new upstream release 0.8.4 (LP: #240325)
* ship new lib usr/lib/gnash/libmozsdk.so.* in mozilla-plugin-gnash
  - update debian/mozilla-plugin-gnash.install
* ship new lib usr/lib/gnash/libgnashnet.so.* in gnash-common
  - update debian/gnash-common.install
* add basic debian/build_head script to build latest CVS head packages.
  - add debian/build_head
* new sound architecture requires build depend on libsdl1.2-dev
  - update debian/control
* head build script now has been completely migrated to bzr (upstream +
  ubuntu)
  - update debian/build_head
* disable kde gui until klash/qt4 has been fixed; keep kde packages as empty
  packages for now.
  - update debian/rules
  - debian/klash.install
  - debian/klash.links
  - debian/klash.manpages
  - debian/konqueror-plugin-gnash.install
* drop libkonq5-dev build dependency accordingly
  - update debian/control
* don't install headers manually anymore. gnash doesnt provide a -dev
  package after all
  - update debian/rules
* update libs installed in gnash-common; libgnashserver-*.so is not available
  anymore (removed); in turn we add the new libgnashcore-*.so
  - update debian/gnash-common.install
* use -Os for optimization and properly pass CXXFLAGS=$(CFLAGS) to configure
  - update debian/rules
* touch firefox .autoreg in postinst of mozilla plugin
  - update debian/mozilla-plugin-gnash.postinst
* link gnash in ubufox plugins directory for the plugin alternative switcher
  - add debian/mozilla-plugin-gnash.links
* suggest ubufox accordingly
  - update debian/control
* add new required build-depends on libgif-dev
  - update debian/control
* add Xb-Npp-Description and Xb-Npp-File as new plugin database meta data
  - update debian/control

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Gnash User Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="index"></a>Gnash User Manual</h1></div><div><p class="releaseinfo">
2
 
        This manual describes version 0.8.2 of Gnash.
 
2
        This manual describes version 0.8.3 of Gnash.
3
3
    </p></div><div><p class="copyright">Copyright � 2005, 2006, 2007, 2008 Free Software Foundation</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>
4
4
    Permission is granted to copy, distribute and/or modify this document
5
5
    under the terms of the <a class="link" href="#fdl" title="Appendix�A.�GNU Free Documentation License"><em class="citetitle">GNU
13
13
      <p class="author">Rob Savoye
14
14
      <code class="email">&lt;<a class="email" href="mailto:rob@openmedianow.org">rob@openmedianow.org</a>&gt;</code>
15
15
      The end user parts of the manual have been pulled out of
16
 
      the original version of the manual, and rewritten.
 
16
      the original version of the manual and rewritten.
17
17
      </p>
18
18
      
19
19
      <p class="publisher">Open Media Now! Foundation</p>
20
 
    </td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#audience">Audience</a></span></dt><dt><span class="sect1"><a href="#runs-on">What Is Supported ?</a></span></dt></dl></dd><dt><span class="chapter"><a href="#usage">2. Using <span class="application">Gnash</span></a></span></dt><dd><dl><dt><span class="sect1"><a href="#options"><span class="application">Gnash</span> Command Line Options</a></span></dt><dt><span class="sect1"><a href="#keys"><span class="application">Gnash</span> Interactive Control Keys</a></span></dt><dt><span class="sect1"><a href="#gnashrc">User Configuration File</a></span></dt></dl></dd><dt><span class="chapter"><a href="#build">3. Installing and Configuring Gnash</a></span></dt><dd><dl><dt><span class="sect1"><a href="#requirements">Requirements</a></span></dt><dd><dl><dt><span class="sect2"><a href="#hardware">Hardware Requirements</a></span></dt><dt><span class="sect2"><a href="#software">Software Requirements</a></span></dt></dl></dd><dt><span class="sect1"><a href="#downloading">Downloading Gnash</a></span></dt><dd><dl><dt><span class="sect2"><a href="#gettingsource">Getting the Source</a></span></dt><dt><span class="sect2"><a href="#getcodecs">Getting Codec Support</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bugreport">4. Reporting Bugs</a></span></dt><dd><dl><dt><span class="sect1"><a href="#bugstep_package">Get a Fresh Binary Package</a></span></dt><dt><span class="sect1"><a href="#bugstep_search">Determine if the bug was previously reported</a></span></dt><dt><span class="sect1"><a href="#bugstep_guidelines">Review the bug writing guidelines</a></span></dt><dt><span class="sect1"><a href="#bugstep_file">Filing a bug report</a></span></dt></dl></dd><dt><span class="glossary"><a href="#glossary">Glossary</a></span></dt><dt><span class="chapter"><a href="#authors">5. Authors</a></span></dt><dt><span class="appendix"><a href="#fdl">A. GNU Free Documentation License</a></span></dt><dd><dl><dt><span class="sect1"><a href="#fdl-preamble">0. PREAMBLE</a></span></dt><dt><span class="sect1"><a href="#fdl-section1">1. APPLICABILITY AND DEFINITIONS</a></span></dt><dt><span class="sect1"><a href="#fdl-section2">2. VERBATIM COPYING</a></span></dt><dt><span class="sect1"><a href="#fdl-section3">3. COPYING IN QUANTITY</a></span></dt><dt><span class="sect1"><a href="#fdl-section4">4. MODIFICATIONS</a></span></dt><dt><span class="sect1"><a href="#fdl-section5">5. COMBINING DOCUMENTS</a></span></dt><dt><span class="sect1"><a href="#fdl-section6">6. COLLECTIONS OF DOCUMENTS</a></span></dt><dt><span class="sect1"><a href="#fdl-section7">7. AGGREGATION WITH INDEPENDENT WORKS</a></span></dt><dt><span class="sect1"><a href="#fdl-section8">8. TRANSLATION</a></span></dt><dt><span class="sect1"><a href="#fdl-section9">9. TERMINATION</a></span></dt><dt><span class="sect1"><a href="#fdl-section10">10. FUTURE REVISIONS OF THIS LICENSE</a></span></dt><dt><span class="sect1"><a href="#fdl-using">Addendum</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>2.1. <a href="#tb-command-line-options">Gnash Command Line Options</a></dt><dt>2.2. <a href="#tb-control-keys">Gnash Interactive Control Keys</a></dt><dt>2.3. <a href="#tb-config-variables">User Configuration Variables</a></dt><dt>3.1. <a href="#tb-os-cpu">Build Matrix</a></dt></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter�1.�Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#audience">Audience</a></span></dt><dt><span class="sect1"><a href="#runs-on">What Is Supported ?</a></span></dt></dl></div><p>
 
20
    </td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#audience">Audience</a></span></dt><dt><span class="sect1"><a href="#runs-on">What Is Supported?</a></span></dt></dl></dd><dt><span class="chapter"><a href="#usage">2. Using <span class="application">Gnash</span></a></span></dt><dd><dl><dt><span class="sect1"><a href="#options"><span class="application">Gnash</span> Command Line Options</a></span></dt><dt><span class="sect1"><a href="#keys"><span class="application">Gnash</span> Interactive Control Keys</a></span></dt><dt><span class="sect1"><a href="#gnashrc">User Configuration File</a></span></dt></dl></dd><dt><span class="chapter"><a href="#build">3. Installing and Configuring Gnash</a></span></dt><dd><dl><dt><span class="sect1"><a href="#requirements">Requirements</a></span></dt><dd><dl><dt><span class="sect2"><a href="#hardware">Hardware Requirements</a></span></dt><dt><span class="sect2"><a href="#software">Software Requirements</a></span></dt></dl></dd><dt><span class="sect1"><a href="#downloading">Downloading Gnash</a></span></dt><dd><dl><dt><span class="sect2"><a href="#gettingsource">Getting the Source</a></span></dt><dt><span class="sect2"><a href="#getcodecs">Getting Codec Support</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bugreport">4. Reporting Bugs</a></span></dt><dd><dl><dt><span class="sect1"><a href="#bugstep_package">Get a Fresh Binary Package</a></span></dt><dt><span class="sect1"><a href="#bugstep_search">Determine if the bug was previously reported</a></span></dt><dt><span class="sect1"><a href="#bugstep_guidelines">Review the bug writing guidelines</a></span></dt><dt><span class="sect1"><a href="#bugstep_file">Filing a bug report</a></span></dt></dl></dd><dt><span class="glossary"><a href="#glossary">Glossary</a></span></dt><dt><span class="chapter"><a href="#authors">5. Authors</a></span></dt><dt><span class="appendix"><a href="#fdl">A. GNU Free Documentation License</a></span></dt><dd><dl><dt><span class="sect1"><a href="#fdl-preamble">0. PREAMBLE</a></span></dt><dt><span class="sect1"><a href="#fdl-section1">1. APPLICABILITY AND DEFINITIONS</a></span></dt><dt><span class="sect1"><a href="#fdl-section2">2. VERBATIM COPYING</a></span></dt><dt><span class="sect1"><a href="#fdl-section3">3. COPYING IN QUANTITY</a></span></dt><dt><span class="sect1"><a href="#fdl-section4">4. MODIFICATIONS</a></span></dt><dt><span class="sect1"><a href="#fdl-section5">5. COMBINING DOCUMENTS</a></span></dt><dt><span class="sect1"><a href="#fdl-section6">6. COLLECTIONS OF DOCUMENTS</a></span></dt><dt><span class="sect1"><a href="#fdl-section7">7. AGGREGATION WITH INDEPENDENT WORKS</a></span></dt><dt><span class="sect1"><a href="#fdl-section8">8. TRANSLATION</a></span></dt><dt><span class="sect1"><a href="#fdl-section9">9. TERMINATION</a></span></dt><dt><span class="sect1"><a href="#fdl-section10">10. FUTURE REVISIONS OF THIS LICENSE</a></span></dt><dt><span class="sect1"><a href="#fdl-using">Addendum</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>2.1. <a href="#tb-command-line-options">Gnash Command Line Options</a></dt><dt>2.2. <a href="#tb-control-keys">Gnash Interactive Control Keys</a></dt><dt>2.3. <a href="#tb-config-variables">User Configuration Variables</a></dt><dt>3.1. <a href="#tb-os-cpu">Build Matrix</a></dt></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter�1.�Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#audience">Audience</a></span></dt><dt><span class="sect1"><a href="#runs-on">What Is Supported?</a></span></dt></dl></div><p>
21
21
    <span class="application">Gnash</span> is a free SWF movie player.  It is available as a
22
22
    stand-alone application or as a plugin for several popular
23
23
    web browsers. It supports playing media from a disk or streaming
24
24
    over a network connection. Some popular video sharing sites like
25
 
    YouTube are supported from a wide vaariety of devices from
 
25
    YouTube are supported on a wide variety of devices from
26
26
    embedded ones to modern desktops.
27
27
  </p><p>
28
28
    <span class="application">Gnash</span> has a better focus on security, allowing the user tight
29
29
    control of all network or disk based I/O. Gnash also supports
30
 
    extending ActionScript by creating your own. You can write
 
30
    extending ActionScript by creating your own classes. You can write
31
31
    wrappers for any development library, and import them into the
32
 
    player much like perl or python does.
 
32
    player much like Perl or Python does.
33
33
  </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="audience"></a>Audience</h2></div></div></div><p>
34
34
      This manual is primarily focused on users interested in how to
35
35
      get Gnash installed from a package, and basic usage as a web
36
36
      browser plugin. For more technical details, please refer to the
37
37
      Gnash Reference manual.
38
 
    </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="runs-on"></a>What Is Supported ?</h2></div></div></div><p>
 
38
    </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="runs-on"></a>What Is Supported?</h2></div></div></div><p>
39
39
      Gnash is known to compile for most any POSIX and ANSI C++
40
40
      conforming system if you have all the dependent libraries
41
 
      installed. Systems we test on, and which Gnash is know to
42
 
      run on are Ubuntu, Fedora, Debian, OpenBSD, NetBSD, FreeBSD,
 
41
      installed. Systems we test on, and which Gnash is known to
 
42
      run on are Ubuntu, Fedora, Debian, Mandriva, OpenBSD, NetBSD, FreeBSD,
43
43
      Win32, and Darwin (OSX) primarily. Occasionally other platforms
44
44
      are built, primarily by those distribution maintainers. This
45
45
      includes BeOS, Haiku, Syllable, OS/2, Solaris, Slackware, and
46
46
      Gentoo.
47
47
    </p><p>
48
 
      Gnash is a capable of reading up to SWF v9 files and opcodes,
 
48
      Gnash is capable of reading up to SWF v9 files and opcodes,
49
49
      but primarily supports SWF v7, with better SWF v8 and v9
50
 
      support under heavy developement. With the 0.8.2 release,
 
50
      support under heavy development. Since the 0.8.2 release,
51
51
      Gnash includes initial parser support for SWF v8 and v9.
52
52
      Not all ActionScript 2 classes are implemented yet, but all of the
53
53
      most heavily used ones are. Many ActionScript 2 classes are
54
54
      partially implemented; there is support for all of the
55
55
      commonly used methods of each class.
56
56
    </p><p>
57
 
      Gnash has implemented about 80% of ActionScript v. 2.0, and has
58
 
      begun implementing ActionScript v. 3.0. Gnash supports the
59
 
      majority of Flash opcodes up to SWF version 9, and a wide
60
 
      sampling of ActionScript classes for SWF version 8.
 
57
      Gnash has implemented about 80% of ActionScript v2.0, and has
 
58
      begun implementing ActionScript v3.0. Gnash supports the
 
59
      majority of Flash opcodes up to SWF v9, and a wide
 
60
      sampling of ActionScript classes for SWF v8.
61
61
    </p><p>
62
 
      As ActionsScript 3 is a more developed version of
 
62
      As ActionScript 3 is a more developed version of
63
63
      ActionScript 2, many of the same classes work for
64
64
      both. Support has been added to Gnash's ActionScript library
65
65
      to support the new ActionScript 3 filters, which get applied
66
 
      to every class. Implementing ActionScript clases is often the
 
66
      to every class. Implementing ActionScript classes is often the
67
67
      easiest way for new Gnash developers to make a contribution
68
 
      without a deep internal knpowledge of Gnash.
 
68
      without a deep internal knowledge of Gnash.
69
69
    </p><p>
70
70
      Gnash has included video support since early 2007, but this is
71
 
      an every changing field of reverse engineering. Many of the
 
71
      an ever changing field of reverse engineering. Many of the
72
72
      popular video sharing sites use SWF v8 or v9, which Gnash
73
 
      still has imperfect support for. This is improving all the
 
73
      supports imperfectly. This is improving all the
74
74
      time, so often builds from a development snapshot will work
75
75
      when using the older release packaged in your distribution
76
76
      doesn't. You can find daily snapshots of the latest CVS tree
84
84
      in a SWF file. Ffmpeg contains the codecs used by the current
85
85
      SWF defintion, FLV, VP6 (ON2), H.263, H.264, and MP3.
86
86
    </p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="usage"></a>Chapter�2.�Using <span class="application">Gnash</span></h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#options"><span class="application">Gnash</span> Command Line Options</a></span></dt><dt><span class="sect1"><a href="#keys"><span class="application">Gnash</span> Interactive Control Keys</a></span></dt><dt><span class="sect1"><a href="#gnashrc">User Configuration File</a></span></dt></dl></div><p>
87
 
    When used as a standalone player, you can play any Flash file from
 
87
    When used as a standalone player, you can play any SWF file from
88
88
    the command line by entering a command of the format: 
89
89
    </p><pre class="programlisting">
90
90
      gnash <em class="replaceable"><code>&lt;option&gt; &lt;flashfile.swf&gt;</code></em>
91
91
    </pre><p>
92
 
    The only required argument is the name (and location)of the file
 
92
    The only required argument is the name (and location) of the file
93
93
    to be played. 
94
94
  </p><p>
95
95
    The available options are listed in the following section, or you
96
96
    may view them in the terminal window by executing the following at
97
97
    the command line: 
98
98
    </p><pre class="programlisting">
99
 
      gnash --help |less
 
99
      gnash --help | less
100
100
    </pre><p>
101
101
  </p><p>
102
 
    The source code download of <span class="application">Gnash</span> includes several example .SWF
 
102
    The source code download of <span class="application">Gnash</span> includes several example SWF
103
103
    files.  They are located in the
104
104
    <code class="filename">testsuite/samples/</code> directory of the <span class="application">Gnash</span>
105
105
    source directory.  If you have installed <span class="application">Gnash</span> correctly, issuing
106
 
    the a command similar to the following plays a short animation of
 
106
    a command similar to the following plays a short animation of
107
107
    a car swerving and crashing: 
108
108
    </p><pre class="programlisting">
109
109
      gnash
122
122
    Flash files are difficult to play. 
123
123
  </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="options"></a><span class="application">Gnash</span> Command Line Options</h2></div></div></div><p>
124
124
      No options are required for  <span class="application">Gnash</span>'s default behavior.  However,
125
 
      there are many options that can be used to that behavior. 
 
125
      there are many options that can be used to change that behavior. 
126
126
    </p><p>
127
127
      </p><pre class="programlisting">
128
128
        gnash <em class="replaceable"><code>&lt;options&gt;</code></em>
129
129
        <code class="filename">filename.swf</code> 
130
130
      </pre><p>
131
 
    </p><div class="table"><a name="tb-command-line-options"></a><p class="title"><b>Table�2.1.�Gnash Command Line Options</b></p><div class="table-contents"><table summary="Gnash Command Line Options" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Option</th><th align="left">Function</th></tr></thead><tbody><tr><td align="left"><code class="option">-h</code></td><td align="left">
 
131
    </p><div class="table"><a name="tb-command-line-options"></a><p class="title"><b>Table�2.1.�Gnash Command Line Options</b></p><div class="table-contents"><table summary="Gnash Command Line Options" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Option</th><th align="left">Function</th></tr></thead><tbody><tr><td align="left"><code class="option">-h, --help</code></td><td align="left">
132
132
              Print usage information.
133
133
            </td></tr><tr><td align="left">
134
 
              <code class="option">-s factor</code>
 
134
              <code class="option">-s, --scale</code> <em class="replaceable"><code>&lt;factor&gt;</code></em>
135
135
            </td><td align="left">
136
136
              Scale the movie up/down by the specified factor.
137
137
            </td></tr><tr><td align="left">
141
141
              default, SDL traps all signals, but sometimes a core file
142
142
              is desired to assist with debugging.
143
143
            </td></tr><tr><td align="left">
144
 
              <code class="option">-d num</code>
 
144
              <code class="option">-d, --delay</code> <em class="replaceable"><code>&lt;num&gt;</code></em>
145
145
            </td><td align="left">
146
146
              Number of milliseconds to delay in main loop. The main
147
147
              loop polls continuously with a delay to adjust how long
150
150
              gets, and of course, the more iterations of the main
151
151
              command loop.
152
152
            </td></tr><tr><td align="left">
153
 
              <code class="option">-p</code>
154
 
            </td><td align="left">
155
 
              Run full speed (no sleep) and log frame rate.
156
 
            </td></tr><tr><td align="left">
157
 
              <code class="option">-a</code>
158
 
            </td><td align="left">
159
 
              Enable Actionscript debugging.
160
 
            </td></tr><tr><td align="left">
161
 
              <code class="option">-v</code>
162
 
            </td><td align="left">
163
 
              Be verbose; i.e. print debug messages to stdout.
 
153
              <code class="option">-v, --verbose</code>
 
154
            </td><td align="left">
 
155
              Be verbose; i.e. print important messages to stdout.
 
156
            </td></tr><tr><td align="left">
 
157
              <code class="option">-vv</code>
 
158
            </td><td align="left">
 
159
              Be very verbose; i.e. also print debug messages to stdout.
164
160
            </td></tr><tr><td align="left">
165
161
              <code class="option">-va</code>
166
162
            </td><td align="left">
167
 
              Be verbose about movie Actions. 
 
163
              Be verbose about movie actions (for ActionScript debugging). This usually
 
164
              generates very large amounts of text and will affect <span class="application">Gnash</span>'s performance.
168
165
            </td></tr><tr><td align="left">
169
166
              <code class="option">-vp</code>
170
167
            </td><td align="left">
171
 
              Be verbose about parsing the movie. Warning: this can
172
 
              generate a lot of text, and can affect the performance of
173
 
              the movie you are playing.
174
 
            </td></tr><tr><td align="left">
175
 
              <code class="option">-ml bias</code>
176
 
            </td><td align="left">
177
 
              Specify the texture LOD bias (float, default is -1) This
178
 
              affects the fuzziness of small objects, especially small
179
 
              text.
180
 
            </td></tr><tr><td align="left">
181
 
              <code class="option">-w</code>
182
 
            </td><td align="left">
183
 
              Write a debug log called gnash-dbg.log. This will 
184
 
              record of all the debug messages whether they are printed
185
 
              to the screen or not.
186
 
            </td></tr><tr><td align="left">
187
 
              <code class="option">-j</code>
188
 
            </td><td align="left">
189
 
              Specify the width of the window. This is mostly used
190
 
              only by the plugin.
191
 
            </td></tr><tr><td align="left">
192
 
              <code class="option">-k</code>
193
 
            </td><td align="left">
194
 
              Specify the height of the window. This is mostly used
195
 
              only by the plugin.
196
 
            </td></tr><tr><td align="left">
197
 
              <code class="option">-1</code>
198
 
            </td><td align="left">
199
 
              Play once; exit when/if movie reaches the last
200
 
              frame. This is the default.
201
 
            </td></tr><tr><td align="left">
202
 
              <code class="option">-r [0|1|2|3]</code>
 
168
              Be verbose about parsing the movie. This generates a fairly large
 
169
              amount of text, and is likely to affect <span class="application">Gnash</span>'s performance.
 
170
            </td></tr><tr><td align="left">
 
171
              <code class="option">-A</code> <em class="replaceable"><code>&lt;file&gt;</code></em>
 
172
            </td><td align="left">
 
173
              Write the audio output to a wave format file.
 
174
            </td></tr><tr><td align="left">
 
175
              <code class="option">-D</code> <em class="replaceable"><code>&lt;file&gt;</code></em>
 
176
            </td><td align="left">
 
177
              Write the video output to a raw video file.  This option
 
178
              is only valid with dump-gnash.
 
179
            </td></tr><tr><td align="left">
 
180
              <code class="option">-w, --writelog</code>
 
181
            </td><td align="left">
 
182
              Write the log messages to disk using the file specified in the gnashrc file.
 
183
              The default is gnash-dbg.log.
 
184
            </td></tr><tr><td align="left">
 
185
              <code class="option">-j, --width</code> <em class="replaceable"><code>&lt;num&gt;</code></em>
 
186
            </td><td align="left">
 
187
              Specify the starting width of the window. This is mostly used
 
188
              only by the plugin.
 
189
            </td></tr><tr><td align="left">
 
190
              <code class="option">-k, --height</code> <em class="replaceable"><code>&lt;num&gt;</code></em>
 
191
            </td><td align="left">
 
192
              Specify the starting height of the window. This is mostly used
 
193
              only by the plugin.
 
194
            </td></tr><tr><td align="left">
 
195
              <code class="option">-1, --once</code>
 
196
            </td><td align="left">
 
197
              Play once; exit if or when the movie reaches the last
 
198
              frame.
 
199
            </td></tr><tr><td align="left">
 
200
              <code class="option">-r, --render-mode</code> <em class="replaceable"><code>&lt;0|1|2|3&gt;</code></em>
203
201
            </td><td align="left">
204
202
              <div class="itemizedlist"><ul type="disc"><li><p>
205
203
                    0 disables rendering and sound (good for batch tests).
206
204
                  </p></li><li><p>
207
 
                    1 enables rendering and disables sound (default setting).
 
205
                    1 enables rendering and disables sound.
208
206
                  </p></li><li><p>
209
207
                    2 enables sound and disables rendering.
210
208
                  </p></li><li><p>
211
 
                    3 enables rendering and sound.
 
209
                    3 enables rendering and sound (default).
212
210
                  </p></li></ul></div>
213
211
            </td></tr><tr><td align="left">
214
 
              <code class="option">-t sec</code>
 
212
              <code class="option">-t, --timeout</code> <em class="replaceable"><code>&lt;sec&gt;</code></em>
215
213
            </td><td align="left">
216
214
              Timeout and exit after the specified number of
217
215
              seconds. This is useful for movies which repeat
218
216
              themselves.
219
217
            </td></tr><tr><td align="left">
220
 
              <code class="option">-g</code>
 
218
              <code class="option">-g, --debugger</code>
221
219
            </td><td align="left">
222
220
              Start <span class="application">Gnash</span> with a Flash debugger console so one can set
223
221
              break points or watchpoints.
224
222
            </td></tr><tr><td align="left">
225
 
              <code class="option">-x id</code>
 
223
              <code class="option">-x, --xid</code> <em class="replaceable"><code>&lt;ID&gt;</code></em>
226
224
            </td><td align="left">
227
225
              This specifies the X11 window ID to display
228
226
              in; this is mainly used by plugins.
229
227
            </td></tr><tr><td align="left">
230
 
              <code class="option">-b bits</code>
231
 
            </td><td align="left">
232
 
              Bit depth of output window (for example, 16 or 32). Appropriate
233
 
              bit depths depend on the renderer and GUI library used.
234
 
              
235
 
            </td></tr><tr><td align="left">
236
 
              <code class="option">-u url</code>
 
228
              <code class="option">-u, --real-url</code> <em class="replaceable"><code>&lt;URL&gt;</code></em>
237
229
            </td><td align="left">
238
230
              Set the _url member of the root movie. This is useful 
239
231
              when you download a movie and play it from a different 
240
232
              location. See also the -U switch.
241
233
            </td></tr><tr><td align="left">
242
 
              <code class="option">-U baseurl</code>
 
234
              <code class="option">-U, --base-url</code> <em class="replaceable"><code>&lt;URL&gt;</code></em>
243
235
            </td><td align="left">
244
236
              Set base URL for this run. URLs are resolved relative to 
245
 
              this base. If omitted defaults to the _url member of the 
 
237
              this base. If omitted or empty, it defaults to the _url member of the 
246
238
              top-level movie (see the -u switch).
247
239
            </td></tr><tr><td align="left">
248
 
              <code class="option">-P entrymeter</code>
 
240
              <code class="option">-P, --param</code> <em class="replaceable"><code>&lt;parameter&gt;</code></em>
249
241
            </td><td align="left">
250
 
              Parameters are given in ParamName=Value syntax and are mostly 
251
 
              useful to the plugin to honour EMBED tags attributes 
 
242
              Parameters are given in the syntax "ParamName=Value" and are mostly 
 
243
              useful for the plugin to honour EMBED tags attributes 
252
244
              or explicit OBJECT PARAM tags. A common use for -P 
253
245
              is to provide FlashVars 
254
246
              (ie: -P "FlashVars=home=http://www.gnu.org").
255
247
            </td></tr><tr><td align="left">
256
 
              <code class="option">-F filedescriptor</code>
 
248
              <code class="option">-F, --fd</code> <em class="replaceable"><code>&lt;filedescriptor&gt;</code></em>
257
249
            </td><td align="left">
258
250
              Use the given filedescriptor to send requests to the host
259
251
              application. This is currently only used for GETURL requests.
260
252
              The protocol is not documented yet, and also needs improvement.
261
253
              Primary use for this switch is for the NPAPI plugin to properly
262
254
              support javascript and target windows in geturl requests.
 
255
            </td></tr><tr><td align="left">
 
256
              <code class="option">--max-advances</code> <em class="replaceable"><code>&lt;num&gt;</code></em>
 
257
            </td><td align="left">
 
258
          Exit after the specified number of frame advances.
 
259
            </td></tr><tr><td align="left">
 
260
              <code class="option">--fullscreen</code>
 
261
            </td><td align="left">
 
262
          Start <span class="application">Gnash</span> in fullscreen mode as long as the GUI and window
 
263
          manager support this. 
263
264
            </td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="keys"></a><span class="application">Gnash</span> Interactive Control Keys</h2></div></div></div><p>
264
265
      While a movie is playing, there are several control
265
266
      keys. These can be used to step through frames, pause the
285
286
            </td><td align="left">
286
287
              Restart the movie.
287
288
            </td></tr><tr><td align="left">
288
 
              <code class="option">CTRL-[ or kp-</code>
289
 
            </td><td align="left">
290
 
              Step back one frame.
291
 
            </td></tr><tr><td align="left">
292
 
              <code class="option">CTRL-] or kp+</code>
293
 
            </td><td align="left">
294
 
              Step forward one frame.
295
 
            </td></tr><tr><td align="left">
296
289
                <code class="option">CTRL-L</code>
297
290
              </td><td align="left">
298
291
                Force immediate redraw.
308
301
              <code class="option">CTRL-M</code>
309
302
            </td><td align="left">
310
303
              Debug.  Test the call_method() function.
311
 
            </td></tr><tr><td align="left">
312
 
              <code class="option">CTRL-B</code>
313
 
            </td><td align="left">
314
 
              Toggle the background color.
315
304
            </td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="gnashrc"></a>User Configuration File</h2></div></div></div><p>
316
305
    Individual user preferences may be set by editing variables with
317
306
    the <code class="filename">.gnashrc</code> file: 
362
351
          Because several files can be parsed in succession, each file can override
363
352
          or add to lists in other files. Use <span class="emphasis"><em>set</em></span> to override
364
353
          all other lists or <span class="emphasis"><em>append</em></span> to add new sandboxes.
365
 
          Note that there's currently no way to *drop* the directory of base dir
 
354
          Note that there's currently no way to <span class="emphasis"><em>drop</em></span> the directory of base dir
366
355
          from the list of allowed local sandboxes.
367
356
          </td></tr><tr><td align="left">delay</td><td align="left">Number</td><td align="left"><span class="application">Gnash</span> uses a timer-based event mechanism to advance frames
368
357
          at a steady rate. This option overrides the default
391
380
          Note that the version advertised by the plugin is NOT affected by this setting,
392
381
          instead you need to set the GNASH_FLASH_VERSION environment variable for
393
382
          the latter (which doesn't affect $version and System.capabilities.version).</td></tr><tr><td align="left">flashSystemOS</td><td align="left">string</td><td align="left">The string that Gnash should return for System.capabilities.OS</td></tr><tr><td align="left">flashSystemManufacturer</td><td align="left">string</td><td align="left">The string that Gnash should return for System.capabilities.manufacturer</td></tr><tr><td align="left">StreamsTimeout</td><td align="left">double</td><td align="left">
394
 
            Set the number of seconds after which streams download time out. Note that timeouts only occurs after the given number of seconds
395
 
            passed w/out anything was received.
 
383
            Set the number of seconds after which streams download time
 
384
            out. Timeouts only occur after the given number
 
385
            of seconds have passed without anything being received.
396
386
          </td></tr><tr><td align="left">insecureSSL</td><td align="left">on/off</td><td align="left">If set to <span class="emphasis"><em>on</em></span>, no verification of SSL connections
397
387
          is performed. This means that, although the connection is encrypted, the server
398
388
          certificate could be invalid, may not belong to the host, or both. Equivalent
399
389
          to curl --insecure. By default, this option is <span class="emphasis"><em>off</em></span> and
400
390
          connections will fail when a host cannot be verified.</td></tr><tr><td align="left">SOLsafedir</td><td align="left">Absolute path</td><td align="left">The full path to a directory where <span class="application">Gnash</span> should store Shared Object files ("flash cookies") if
401
 
          they are enabled.</td></tr><tr><td align="left">SOLreadonly</td><td align="left">on/off</td><td align="left">If set to <span class="emphasis"><em>on</em></span>, <span class="application">Gnash</span> will not write Shared Object files.</td></tr><tr><td align="left">URLOpenerFormat</td><td align="left">string</td><td align="left">
 
391
          they are enabled.</td></tr><tr><td align="left">SOLreadonly</td><td align="left">on/off</td><td align="left">If set to <span class="emphasis"><em>on</em></span>, <span class="application">Gnash</span> will not write Shared Object files.</td></tr><tr><td align="left">ignoreFSCommand</td><td align="left">on/off</td><td align="left">If set to on (default), <span class="application">Gnash</span> will ignore fscommands in standalone mode.
 
392
          Fscommands are requests from the playing movie to the operating system or 
 
393
          user interface: the most common are quit, fullscreen, showmenu and exec. <span class="application">Gnash</span>
 
394
          always ignores fscommands when running as a plugin.
 
395
          </td></tr><tr><td align="left">URLOpenerFormat</td><td align="left">string</td><td align="left">
402
396
            Set the format of an url opener command. The %u label would be substituted by the actual url to be opened.
403
397
            Examples:
404
398
            <pre class="programlisting">
494
488
              </td></tr><tr><td align="left">Gentoo</td><td align="left">AMD64, PowerPC, SPARC, x86 
495
489
              </td></tr><tr><td align="left">Maemo 2.1</td><td align="left">i385, ARMv5t</td></tr><tr><td align="left">Scratchbox</td><td align="left">i386, ARMv5t</td></tr><tr><td align="left">Access Linux Platform
496
490
              </td><td align="left">i386, ARMv5t</td></tr><tr><td align="left">Mandriva
497
 
              </td><td align="left">i386, MIPS</td></tr><tr><td align="left">Open Embedded, OpenMoko, Poky
 
491
              </td><td align="left">i386, x86-64, MIPS</td></tr><tr><td align="left">Open Embedded, OpenMoko
498
492
              </td><td align="left">ARM
499
493
              </td></tr><tr><td align="left">YellowDog Linux 6
500
494
              </td><td align="left">PowerPC, PS3
509
503
              </td></tr><tr><td align="left">Darwin (MacOS X)
510
504
              </td><td align="left">PowerPC and x86-32 
511
505
              </td></tr><tr><td align="left">Windows XP, Windows Vista</td><td align="left">x86-32</td></tr></tbody></table></div></div><br class="table-break"></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="software"></a>Software Requirements</h3></div></div></div><p>
512
 
        The 0.8.2 release of Gnash has been designed to run on
 
506
        The 0.8.3 release of Gnash has been designed to run on
513
507
        UNIX/Linux variants, and has been run on most of the free ones.
514
508
        However, Gnash has successfully run on Windows, Darwin (Mac OS X),
515
509
        Irix, Solaris, BeOs, OS/2, and Haiku.  Gnash has also run on the
583
577
          from your distributions repository.
584
578
        </p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="bugreport"></a>Chapter�4.�Reporting Bugs</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#bugstep_package">Get a Fresh Binary Package</a></span></dt><dt><span class="sect1"><a href="#bugstep_search">Determine if the bug was previously reported</a></span></dt><dt><span class="sect1"><a href="#bugstep_guidelines">Review the bug writing guidelines</a></span></dt><dt><span class="sect1"><a href="#bugstep_file">Filing a bug report</a></span></dt></dl></div><p>
585
579
    The Gnash project relies on the community of Gnash users to test
586
 
    the player, feedback is critical to any successful project.  Not
 
580
    the player.  Feedback is critical to any successful project.  Not
587
581
    only does it let us know that people use Gnash, but it helps us  
588
582
    understand the community's needs. Gnash uses a bug tracker on
589
583
    <a class="ulink" href="http://savannah.gnu.org" target="_top">http://savannah.gnu.org</a> to manage these reports.
591
585
    When filing a report, please follow the guidelines below. The better
592
586
    your bug report is, the easier it will be for the developers to
593
587
    address the issue. Bug reports without enough information will
594
 
    initially be asked to provide this information anyway. Adding
595
 
    critical details, like the Operating System you are on, it's
 
588
    be asked to provide this information anyway. Adding
 
589
    critical details, like the Operating System you are on, its
596
590
    version, and any relevant error messages from Gnash that you get.
597
591
  </p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="bugstep_package"></a>Get a Fresh Binary Package</h2></div></div></div><p>
598
592
      For starters, it's a good idea to obtain a copy of the latest
600
594
      Gnash build infrastructure allows the automated building of
601
595
      binary packages. Often the version of Gnash as packaged by a
602
596
      GNU/Linux or BSD distribution is based on the last official
603
 
      release, which could be months out of date. It is helpful if
604
 
      this is the case to try a newer packaged build of Gnash. 
 
597
      release, which could be months out of date. It helps us, if
 
598
      this is the case, for you to try a newer packaged build of Gnash. 
605
599
    </p><p>
606
600
      You can get a fresh binary package of Gnash, as well as recent 
607
601
      source packages from
660
654
          AGG is the AntiGrain 2D graphics library, which can be used
661
655
          as a renderer in Gnash. It is faster than OpenGL on systems
662
656
          without hardware graphics acceleration. As of Gnash version
663
 
          0.8.1 it is the more feature complete renderer. 
 
657
          0.8.2 it is the more feature complete renderer. 
664
658
        </p></dd><dt>
665
659
        AMF
666
660
      </dt><dd><p>
722
716
      </dt><dd><p>
723
717
          The term <span class="emphasis"><em>Flash</em></span> is used to describe both the 
724
718
          Adobe IDE for creating <span class="emphasis"><em>SWF</em></span>
725
 
          files, and the technology itself. Flash is a trademarked
726
 
          term of Adobe's, we prfer to use SWF to refer to the files
727
 
          themselves, as well as the format, instead of flash(tm).
 
719
          files, and the technology itself. Flash is a registered trademark
 
720
          belonging to Adobe.   Unfortunately, neither Macromedia nor
 
721
          Adobe have done a good job creating a generic name for all
 
722
          things having to do with Flash.  They risk
 
723
          loss of their trademark.
728
724
        </p></dd><dt>
729
725
        FLV
730
726
      </dt><dd><p>
776
772
        You must choose a GUI library during the
777
773
        configuration stage of building Gnash.
778
774
      </p></dd></dl></div><div class="glossdiv"><h3 class="title">K</h3><dl><dt>
779
 
        Klash
 
775
        kde-gnash
780
776
      </dt><dd><p>
781
 
          <span class="emphasis"><em>Klash</em></span> was the name given to the stand-alone 
 
777
          <span class="emphasis"><em>kde-gnash</em></span> is the name given to the stand-alone 
782
778
          instance of <span class="application">Gnash</span> which used the KDE GUI.  It has been replaced with 
783
 
          an implementation using Qt.  Some documentation may incorrectly
784
 
          refer to the Konqueror plugin as <span class="emphasis"><em>Klash</em></span>.
785
 
          The plugin was renamed <span class="emphasis"><em>Kpart</em></span>.
 
779
          an implementation using Qt.  The Konqueror plugin runs kde-gnash
 
780
          and is called <span class="emphasis"><em>Kparts</em></span>.
786
781
        </p></dd><dt>
787
 
        Kpart
 
782
        Kparts
788
783
      </dt><dd><p>
789
 
          <span class="emphasis"><em>Kpart</em></span> is a plugin for Konqueror which is
 
784
          <span class="emphasis"><em>Kparts</em></span> is a plugin for Konqueror which is
790
785
          enabled with the configuration option --enable-kparts.
791
786
        </p></dd></dl></div><div class="glossdiv"><h3 class="title">L</h3><dl><dt>
792
787
        libmad
882
877
          platforms' graphics, sound, and input APIs. Gnash can use it
883
878
          as a GUI and/or as a sound handler. Note that the two usages
884
879
          are independent of each other: you can use it for a task and
885
 
          not for the other if you wish. At time or writing (2007-01-11)
886
 
          the SDL GUI lacks menus and a performant input event
887
 
          architecture; the SDL sound handler is the most feature rich,
888
 
          supporting Video through ffmpeg. 
 
880
          not for the other if you wish.  This version of Gnash does not
 
881
          implement menus in the SDL GUI; the SDL sound handler is the
 
882
          most feature rich, supporting video through ffmpeg. 
889
883
        </p></dd><dt>
890
884
        sound handler
891
885
      </dt><dd><p>
892
886
          The <span class="emphasis"><em>sound handler</em></span> is the part of <span class="application">Gnash</span>
893
887
          which handles both event sounds and streaming sound.  Audio
894
 
          from external sources are also handled through the sound handler
 
888
          from external sources is sent through the sound handler
895
889
          when SDL is used.  The sound handler must be selected during
896
890
          configuration of Gnash when compiling.
897
891
        </p><p>
910
904
        </p></dd><dt>
911
905
        Stage
912
906
      </dt><dd><p>
913
 
          The visible area of a Flash movie. The name derives from a      theater analogy. Graphical elements are referred to as
 
907
          The visible area of a Flash movie. The name derives from a
 
908
          theater analogy. Graphical elements are referred to as
914
909
          characters.  
915
910
        </p></dd><dt>
916
911
        SWF
942
937
        </p></dd></dl></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="authors"></a>Chapter�5.�Authors</h2></div></div></div><p>
943
938
        <span class="application">Gnash</span> is maintained by Rob Savoye. Other active developers
944
939
        are: Sandro Santilli, Bastiaan Jacques, Udo Giacomozzi, Chad
945
 
        Musick, Benjamin Wolsey, and Zou Lunkai. Please send all
946
 
        comments and suggestions to <code class="email">&lt;<a class="email" href="mailto:gnash-dev@gnu.org%0A%09">gnash-dev@gnu.org
947
 
        </a>&gt;</code>. Past and sometimes current developers are Tomas
948
 
        Groth and Markus Gothe.
 
940
        Musick, Benjamin Wolsey, Zou Lunkai, and Russ Nelson. Please
 
941
        send all comments and suggestions to
 
942
        <code class="email">&lt;<a class="email" href="mailto:gnash-dev@gnu.org">gnash-dev@gnu.org</a>&gt;</code>. Past and sometimes current
 
943
        developers are Tomas Groth and Markus Gothe.
949
944
    </p><p>
950
945
        <span class="application">Gnash</span> was initially derived from <span class="application">GameSWF</span>.
951
946
        <span class="application">GameSWF</span> is maintained by