[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash/doc/C/usermanual usage.xml
|
From: |
Melissa Goldin |
|
Subject: |
[Gnash-commit] gnash/doc/C/usermanual usage.xml |
|
Date: |
Thu, 16 Aug 2007 14:25:26 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Melissa Goldin <mushi> 07/08/16 14:25:26
Modified files:
doc/C/usermanual: usage.xml
Log message:
Text improvements and changing <variablelist>s over to <table>s - where
there's that much information, they're easier to read.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/usage.xml?cvsroot=gnash&r1=1.3&r2=1.4
Patches:
Index: usage.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/usage.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- usage.xml 1 Aug 2007 05:00:08 -0000 1.3
+++ usage.xml 16 Aug 2007 14:25:26 -0000 1.4
@@ -2,292 +2,296 @@
<title>Using &app;</title>
<para>
- &app; can be used as a standalone player or as a plugin. Using it
- as a standalone player, you
- can execute any flash movie from the command line by just
- supplying the file name. No command line options are required to
- just play the movie using the default actions. So if you type:
+When used as a standalone player, you can play any Flash file from the command
line by entering a command of the format:
+<programlisting>
+gnash <replaceable><option> <flashfile.swf></replaceable>
+</programlisting>
+The only required argument is the name (and location)of the file to be played.
</para>
<para>
- <emphasis>gnash samples/car_smash.swf</emphasis>
+ The available options are listed in the following section, or you may
view them in the terminal window by executing the following at the command line:
+<programlisting>
+gnash --help |less
+</programlisting>
</para>
- <para>
- It will create a window and play the movie. In this case it's a
- simple animation of a car driving, swerving, and finally
- crashing.
+<para>
+The source code download of &app; includes several example .SWF files. They
are located in the <filename>testsuite/samples/</filename> directory of the
&app; source directory. If you have installed &app; correctly, issuing the a
command similar to the following plays a short animation of a car swerving and
crashing:
+<programlisting>
+gnash
/home/<replaceable><username></replaceable>/gnash/testsuite/car_smash.swf
+</programlisting>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/car_crash.png"/>
</imageobject>
</mediaobject>
-
</para>
+<para>
+The above is useful for playing Flash files downloaded to your local system.
It is also possible to play Flash files directly from the web. To do so, use
the <option>-u</option> option along with the URL of the desired file.
+<programlisting>
+gnash -u http://example.domain.com/flashfile.swf
+</programlisting>
+Note that this will not work with every website; some embedded Flash files are
difficult to play.
+</para>
+
<sect1 id="options">
<title>&app; Command Line Options</title>
<para>
- While by default no options are necessary, there are options
- that can be used to change <emphasis>&app;'s</emphasis> basic
- behavior.
- </para>
-
- <para>
- gnash [options] file
+ No options are required for &app;'s default behavior. However, there
are many options that can be used to that behavior.
</para>
- <variablelist>
- <varlistentry>
- <term>-h</term>
- <listitem>
<para>
+<programlisting>
+ gnash <replaceable><options></replaceable>
<filename>filename.swf</filename>
+</programlisting>
+ </para>
+
+ <table id="tb-command-line-options">
+<title>Gnash Command Line Options</title>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<colspec colname='Option' />
+<colspec colname='Function' />
+<thead>
+<row>
+<entry>Option</entry>
+<entry>Function</entry>
+</row>
+</thead>
+<tbody>
+<row>
+ <entry><option>-h</option></entry>
+ <entry>
Print usage information.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-s factor</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-s factor</option>
+ </entry>
+ <entry>
Scale the movie up/down by the specified factor.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-c</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-c</option>
+ </entry>
+ <entry>
Produce a core file instead of letting SDL trap it. By
default, SDL traps all signals, but sometimes a core file
is desired to assist with debugging.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-d num</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-d num</option>
+ </entry>
+ <entry>
Number of milliseconds to delay in main loop. The main
loop polls continuously with a delay to adjust how long
<emphasis>&app;</emphasis> sleeps between iterations of the
loop. The smaller the number, the higher the CPU load
gets, and of course, the more iterations of the main
command loop.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-p</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-p</option>
+ </entry>
+ <entry>
Run full speed (no sleep) and log frame rate.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-a</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-a</option>
+ </entry>
+ <entry>
Enable Actionscript debugging.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-v</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-v</option>
+ </entry>
+ <entry>
Be verbose; i.e. print debug messages to stdout.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-va</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-va</option>
+ </entry>
+ <entry>
Be verbose about movie Actions.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-vp</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+<row>
+ <entry>
+ <option>-vp</option>
+ </entry>
+ <entry>
Be verbose about parsing the movie. Warning: this can
generate a lot of text, and can affect the performance of
the movie you are playing.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-ml bias</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-ml bias</option>
+ </entry>
+ <entry>
Specify the texture LOD bias (float, default is -1) This
affects the fuzziness of small objects, especially small
text.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-w</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-w</option>
+ </entry>
+ <entry>
Write a debug log called gnash-dbg.log. This will
record of all the debug messages whether they are printed
to the screen or not.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-j</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-j</option>
+ </entry>
+ <entry>
Specify the width of the window. This is mostly used
only by the plugin.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>-k</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-k</option>
+ </entry>
+ <entry>
Specify the height of the window. This is mostly used
only by the plugin.
- </para>
- </listitem>
- </varlistentry>
+ </entry>
+ </row>
+ <row>
<!--
- <varlistentry>
- <term>-e</term>
- <listitem>
- <para>
- Use SDL Event thread. This uses a separate thread to make
+ <entry>
+ <option>-e</option>
+ </entry>
+ <entry>
+ Use SDL Event thread. This uses a seentryte thread to make
the event loop more event driven than polling. This can
improve performance for some types of movies.
- </para>
- </listitem>
- </varlistentry>
+ </entry>
+ </row>
+ <row>
-->
- <varlistentry>
- <term>-1</term>
- <listitem>
- <para>
+ <entry>
+ <option>-1</option>
+ </entry>
+ <entry>
Play once; exit when/if movie reaches the last
frame. This is the default.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-r [0|1|2|3]</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-r [0|1|2|3]</option>
+ </entry>
+ <entry>
0 disables rendering and sound (good for batch tests).
- </para>
- <para>
+ </entry>
+ <entry>
1 enables rendering and disables sound (default setting).
- </para>
- <para>
+ </entry>
+ <entry>
2 enables sound and disables rendering.
- </para>
- <para>
+ </entry>
+ <entry>
3 enables rendering and sound.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-t sec</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-t sec</option>
+ </entry>
+ <entry>
Timeout and exit after the specified number of
seconds. This is useful for movies which repeat
themselves.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-g</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-g</option>
+ </entry>
+ <entry>
Start &app; with a Flash debugger console so one can set
break points or watchpoints.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-x id</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-x id</option>
+ </entry>
+ <entry>
This specifies the X11 window ID to display
in; this is mainly used by plugins.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-b bits</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-b bits</option>
+ </entry>
+ <entry>
Bit depth of output window (for example, 16 or 32). Appropriate
bit depths depend on the renderer and GUI library used.
<!--
TODO: add information about which depths are suitable for each
renderer.
-->
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-u url</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+<entry>
+ <option>-u url</option>
+ </entry>
+ <entry>
Set the _url member of the root movie. This is useful
when you download a movie and play it from a different
location. See also the -U switch.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-U baseurl</term>
- <listitem>
- <para>
- Set base url for this run. URLs are resolved relative to
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-U baseurl</option>
+ </entry>
+ <entry>
+ Set base URL for this run. URLs are resolved relative to
this base. If omitted defaults to the _url member of the
top-level movie (see the -u switch).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>-P parameter</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>-P entrymeter</option>
+ </entry>
+ <entry>
Parameters are given in ParamName=Value syntax and are mostly
useful to the plugin to honour EMBED tags attributes
or explicit OBJECT PARAM tags. A common use for -P
is to provide FlashVars
(ie: -P "FlashVars=home=http://www.gnu.org";).
- </para>
- </listitem>
- </varlistentry>
-
- </variablelist>
+ </entry>
+ </row>
+</tbody>
+</tgroup>
+ </table>
</sect1>
@@ -300,117 +304,119 @@
playing, and control other actions.
</para>
- <variablelist>
- <varlistentry>
- <term>CTRL-Q</term>
- <listitem>
- <para>
+ <table id="tb-control-keys">
+<title>Gnash Interactive Control Keys</title>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<colspec colname='Key Combination' />
+<colspec colname='Function' />
+<thead>
+<row>
+<entry>Key Combination</entry>
+<entry>Function</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry>
+ <option>CTRL-Q</option>
+ </entry>
+ <entry>
Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-W</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-W</option>
+ </entry>
+ <entry>
Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>ESC</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>ESC</option>
+ </entry>
+ <entry>
Quit/Exit.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-P</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-P</option>
+ </entry>
+ <entry>
Toggle Pause.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-R </term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-R </option>
+ </entry>
+ <entry>
Restart the movie.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-[ or kp-</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-[ or kp-</option>
+ </entry>
+ <entry>
Step back one frame.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-] or kp+</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-] or kp+</option>
+ </entry>
+ <entry>
Step forward one frame.
- </para>
- </listitem>
- </varlistentry>
-
+ </entry>
+ </row>
+ <row>
<!--
- <varlistentry>
- <term>CTRL-A</term>
- <listitem>
- <para>
+ <entry>
+ <option>CTRL-A</option>
+ </entry>
+ <entry>
Toggle anti-aliasing (doesn't work).
- </para>
- </listitem>
- </varlistentry>
+ </entry>
+ </row>
+ <row>
-->
-
- <varlistentry>
- <term>CTRL-T</term>
- <listitem>
- <para>
+ <entry>
+ <option>CTRL-T</option>
+ </entry>
+ <entry>
Debug. Test the set_variable() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-G</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-G</option>
+ </entry>
+ <entry>
Debug. Test the get_variable() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-M</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-M</option>
+ </entry>
+ <entry>
Debug. Test the call_method() function.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>CTRL-B</term>
- <listitem>
- <para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>CTRL-B</option>
+ </entry>
+ <entry>
Toggle the background color.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ </entry>
+ </row>
+</tbody>
+</tgroup>
+ </table>
</sect1>
&gnashrc;