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

<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">

This manual describes version 0.8.3 of Gnash.

</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>

<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.74.3"></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">

This manual describes version 0.8.6 of Gnash.

</p></div><div><p class="copyright">Copyright � 2005, 2006, 2007, 2008, 2009 Free Software Foundation</p></div><div><div class="legalnotice"><a name="legalnotice"></a><p>

Permission is granted to copy, distribute and/or modify this document

under the terms of the <a class="link" href="#fdl" title="Appendix�A.�GNU Free Documentation License"><em class="citetitle">GNU

Free Documentation License</em></a>, Version 1.1 or any later

</p>

<p class="publisher">Open Media Now! Foundation</p>

</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>

</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 Gnash</a></span></dt><dd><dl><dt><span class="sect1"><a href="#options">Gnash Command Line Options</a></span></dt><dt><span class="sect1"><a href="#keys">Gnash 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>

<span class="application">Gnash</span> is a free SWF movie player. It is available as a

stand-alone application or as a plugin for several popular

web browsers. It supports playing media from a disk or streaming

at: <a class="ulink" href="http://www.gnashdev.org/dev_snapshots/" target="_top">

http://www.gnashdev.org/dev_snapshots</a>.

</p><p>

Gnash uses ffmpeg for codecs, so any file supported 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

in a SWF file. Ffmpeg contains the codecs used by the current

in a SWF file. FFmpeg contains the codecs used by the current

SWF defintion, FLV, VP6 (ON2), H.263, H.264, and MP3.

</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>

</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">Gnash Command Line Options</a></span></dt><dt><span class="sect1"><a href="#keys">Gnash Interactive Control Keys</a></span></dt><dt><span class="sect1"><a href="#gnashrc">User Configuration File</a></span></dt></dl></div><p>

When used as a standalone player, you can play any SWF file from

the command line by entering a command of the format:

</p><pre class="programlisting">

375

player when running as a browser plugin. By default, sound

376

is enabled when using <span class="application">Gnash</span> as a browser plugin.</td></tr><tr><td align="left">EnableExtensions</td><td align="left">on/off</td><td align="left">Set to <span class="emphasis"><em>on</em></span> to enable extensions. This option is <span class="emphasis"><em>off</em></span> by default</td></tr><tr><td align="left">StartStopped</td><td align="left">on/off</td><td align="left">Set to <span class="emphasis"><em>on</em></span> to have the GUI start in "stop" mode. This is useful in particular

377

for the plugin, so you have to explicitly start any movie on a webpage. This option is <span class="emphasis"><em>off</em></span> by default.

378

</td></tr><tr><td align="left">flashVersionString</td><td align="left">string</td><td align="left">Set the string returned by $version and System.capabilities.version.

378

</td></tr><tr><td align="left">webcamDevice</td><td align="left">integer</td><td align="left">The integer value (index into vector of video devices) that represents the default webcam.

379

To easily get this entry run utilities/findwebcams (only works with Gstreamer right now)</td></tr><tr><td align="left">microphoneDevice</td><td align="left">integer</td><td align="left">The integer value (index into vector of microphone devices) that represents the default microphone.

380

To easily get this entry run utilities/findmicrophones (only works with Gstreamer right now)</td></tr><tr><td align="left">flashVersionString</td><td align="left">string</td><td align="left">Set the string returned by $version and System.capabilities.version.

379

381

Useful to get around some flash version detection movies.

380

382

Note that the version advertised by the plugin is NOT affected by this setting,

381

383

instead you need to set the GNASH_FLASH_VERSION environment variable for

388

390

certificate could be invalid, may not belong to the host, or both. Equivalent

389

391

to curl --insecure. By default, this option is <span class="emphasis"><em>off</em></span> and

390

392

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

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.

393

they are enabled.</td></tr><tr><td align="left">solLocalDomain</td><td align="left">on/off</td><td align="left">If set to <span class="emphasis"><em>on</em></span>, allow the loading of

394

Shared Objects only on the localhost.</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

395

Fscommands are requests from the playing movie to the operating system or

393

396

user interface: the most common are quit, fullscreen, showmenu and exec. <span class="application">Gnash</span>

394

397

always ignores fscommands when running as a plugin.

401

404

set urlOpenerFormat open %u

402

405

set urlOpenerFormat kfmclient exec %u

403

406

</pre>

407

</td></tr><tr><td align="left">XVideo</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 attempt to render using the X Video Extension, if

408

system support was found during compilation. By default, X Video rendering is disabled.

409

</td></tr><tr><td align="left">quality</td><td align="left">[-1|0|1|2|3]</td><td align="left">

410

Set rendering quality.

411

If set to <span class="emphasis"><em>-1</em></span>, <span class="application">Gnash</span> will use whatever quality set by the movie being run.

412

If set to any value from <span class="emphasis"><em>0</em></span> to <span class="emphasis"><em>3</em></span> <span class="application">Gnash</span> will lock quality to the specified value (0=low, 1=medium, 2=high, 3=best). Defaults to -1.

404

413

</td></tr></tbody></table></div></div><br class="table-break"><p>

405

414

The following example <code class="filename">.gnashrc</code> file allows a user to only play Flash files saved locally to the machine on which <span class="application">Gnash</span> is running. It also specifically forbids content from doubleclick.com and mochibot.com. <span class="application">Gnash</span>'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.

406

415

</p><pre class="programlisting">

503

512

</td></tr><tr><td align="left">Darwin (MacOS X)

504

513

</td><td align="left">PowerPC and x86-32

505

514

</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>

506

The 0.8.3 release of Gnash has been designed to run on

515

The 0.8.6 release of Gnash has been designed to run on

507

516

UNIX/Linux variants, and has been run on most of the free ones.

508

517

However, Gnash has successfully run on Windows, Darwin (Mac OS X),

509

518

Irix, Solaris, BeOs, OS/2, and Haiku. Gnash has also run on the

645

654

ActionScript

646

655

</dt><dd><p>

647

656

<span class="emphasis"><em>ActionScript</em></span>, or "AS", is the scripting

648

language for <span class="emphasis"><em>Flash</em></span>

657

language for <span class="emphasis"><em>SWF</em></span>

649

658

applications. It is compiled to bytecode, which is a subset of

650

659

the <span class="emphasis"><em>SWF</em></span> format.

651

660

</p></dd><dt>

659

668

AMF

660

669

</dt><dd><p>

661

670

662

is the object format used by <span class="emphasis"><em>Flash</em></span>

671

is the object format used by <span class="emphasis"><em>SWF</em></span>

663

672

for shared objects and streaming video.

664

673

</p></dd><dt>

665

674

as_environment

703

712

</dt><dd><p>

704

713

A <span class="application">Gnash</span> <span class="emphasis"><em>extension</em></span> is a plugin (not a

705

714

browser plugin) which implements additional functionality

706

beyond what is covered by <span class="emphasis"><em>Flash</em></span>

715

beyond what is covered by the <span class="emphasis"><em>SWF</em></span>

707

716

specification. These are shared libraries which are loaded

708

717

at runtime.

709

718

</p></dd></dl></div><div class="glossdiv"><h3 class="title">F</h3><dl><dt>

710

ffmpeg

719

FFmpeg

711

720

</dt><dd><p>

712

ffmpeg is an audio and video decoding library which can be

721

FFmpeg is an audio and video decoding library which can be

713

722

used by Gnash to decode mp3, FLV and other media types.

714

723

</p></dd><dt>

715

724

Flash

716

725

</dt><dd><p>

717

726

The term <span class="emphasis"><em>Flash</em></span> is used to describe both the

718

727

Adobe IDE for creating <span class="emphasis"><em>SWF</em></span>

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

files, and Adobe's player. Flash is a registered trademark

729

belonging to Adobe.

724

730

</p></dd><dt>

725

731

FLV

726

732

</dt><dd><p>

783

789

</dt><dd><p>

784

790

<span class="emphasis"><em>Kparts</em></span> is a plugin for Konqueror which is

785

791

enabled with the configuration option --enable-kparts.

786

</p></dd></dl></div><div class="glossdiv"><h3 class="title">L</h3><dl><dt>

787

libmad

788

</dt><dd><p>

789

libmad is a mp3-decoding library, which used to be an option for Gnash

790

handling of sound (dropped since 0.8.2).

791

792

</p></dd></dl></div><div class="glossdiv"><h3 class="title">M</h3><dl><dt>

792

793

Mesa

793

794

</dt><dd><p>

797

798

</p></dd><dt>

798

799

Ming

799

800

</dt><dd><p>

800

Ming is a C library for generating SWF ("Flash") format

801

Ming is a C library for generating <span class="emphasis"><em>SWF</em></span> format

801

802

movies, plus a set of wrappers for using the library. It is

802

803

used by the Gnash project for generating testcases.

803

804

</p></dd></dl></div><div class="glossdiv"><h3 class="title">N</h3><dl><dt>

879

880

are independent of each other: you can use it for a task and

880

881

not for the other if you wish. This version of Gnash does not

881

882

implement menus in the SDL GUI; the SDL sound handler is the

882

most feature rich, supporting video through ffmpeg.

883

most feature rich, supporting video through FFmpeg.

883

884

</p></dd><dt>

884

885

sound handler

885

886

</dt><dd><p>

890

891

configuration of Gnash when compiling.

891

892

</p><p>

892

893

There are currently two sound handlers available in <span class="application">Gnash</span>:

893

ffmpeg and Gstreamer. The ffmpeg sound handler uses SDL for

894

FFmpeg and Gstreamer. The ffmpeg sound handler uses SDL for

894

895

mixing.

895

896

The Gstreamer-sound handler uses the available

896

897

plugins to decode the audio, so it might not work if some

910

911

</p></dd><dt>

911

912

SWF

912

913

</dt><dd><p>

913

<span class="emphasis"><em>SWF</em></span> is the file format for

914

<span class="emphasis"><em>SWF</em></span> is the generic name for

914

915

<span class="emphasis"><em>Flash</em></span> movies.

915

916

</p></dd></dl></div><div class="glossdiv"><h3 class="title">T</h3><dl><dt>

916

917

Tamarin

Older »