[Gnash-commit] gnash/doc/C dumpshm.man-xml gnash.man-xml gproc...

[Rob Savoye]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Rob Savoye <rsavoye>    08/02/16 23:32:22

Added files:
        doc/C          : dumpshm.man-xml gnash.man-xml 
                         gprocessor.man-xml soldumper.man-xml 

Log message:
        Oops, forgot to actually check in renamed versions of the man pages.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/dumpshm.man-xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnash.man-xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gprocessor.man-xml?cvsroot=gnash&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/soldumper.man-xml?cvsroot=gnash&rev=1.1

Patches:
Index: dumpshm.man-xml
===================================================================
RCS file: dumpshm.man-xml
diff -N dumpshm.man-xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ dumpshm.man-xml     16 Feb 2008 23:32:22 -0000      1.1
@@ -0,0 +1,92 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";
+[
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!ENTITY appversion "0.8">
+  <!ENTITY manrevision "0.1">
+  <!ENTITY date "Feb 2008">
+  <!ENTITY app "<application>Dumpshm</application>">
+  <!ENTITY appname "Dumpshm">
+  <!ENTITY version "0.8">
+]
+>
+
+<refentry id="dumpshm">
+<refmeta>
+<refentrytitle>dumpshm</refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<!-- the refname becomes the output name of the man page -->
+<refnamediv>
+<refname>dumpshm</refname>
+<refpurpose>Gnash LocalConnection memory Dumper</refpurpose>
+</refnamediv>
+
+
+<refsynopsisdiv><title>Synopsis</title>
+<synopsis>
+dumpshm (options)... (file)...
+</synopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+  Dump information about the shared memory segment used by the
+  LocalConnection ActionScript class. This memory segment is comprised
+  of a header, and a collection of SWF AMF Objects, normally not
+  viewable by the user.
+</para>
+
+<variablelist>
+  <varlistentry>
+    <term>-h</term>
+    <listitem>
+      <para>
+       Print usage info.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-i</term>
+    <listitem>
+      <para>
+       Find the key for an existing memory segment.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-r</term>
+    <listitem>
+      <para>
+       Dump memory segment to the terminal.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-c</term>
+    <listitem>
+      <para>
+       Dump memory segment to a disk file, segment.raw.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-v</term>
+    <listitem>
+      <para>
+       Verbose output.
+      </para>
+    </listitem>
+  </varlistentry>
+
+
+</variablelist>
+
+</refsect1>
+</refentry>
+

Index: gnash.man-xml
===================================================================
RCS file: gnash.man-xml
diff -N gnash.man-xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ gnash.man-xml       16 Feb 2008 23:32:22 -0000      1.1
@@ -0,0 +1,395 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";
+[
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!ENTITY appversion "0.8">
+  <!ENTITY manrevision "0.4">
+  <!ENTITY date "Feb 2008">
+  <!ENTITY app "<application>Gnash</application>">
+  <!ENTITY appname "Gnash">
+  <!ENTITY version "0.8">
+]
+>
+
+<refentry id="gnash">
+<refmeta>
+<refentrytitle>gnash</refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<!-- the refname becomes the output name of the man page -->
+<refnamediv>
+<refname>gnash</refname>
+<refpurpose>GNU Flash (SWF) Player</refpurpose>
+</refnamediv>
+
+
+<refsynopsisdiv><title>Synopsis</title>
+<synopsis>
+gnash (options)... (file)...
+</synopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+  Run the SWF movie player.
+</para>
+
+<variablelist>
+  <varlistentry>
+    <term>-h</term>
+    <listitem>
+      <para>
+       Print usage info.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-s factor</term>
+    <listitem>
+      <para>
+       Scale the movie up/down by the specified factor.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-c</term>
+    <listitem>
+      <para>
+       Produce a core file instead of letting SDL trap it.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-d num</term>
+    <listitem>
+      <para>
+      Number of milliseconds to delay in main loop.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-a</term>
+    <listitem>
+      <para>
+          Enable ActionScript debugging.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-x</term>
+    <listitem>
+      <para>
+       The XID of the parent window Gnash should use instead of
+       creating a new one.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-j</term>
+    <listitem>
+      <para>
+       Set the width of the window. This is only used when embedding
+       the player into another window.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-k</term>
+    <listitem>
+      <para>
+       Set the height of the window. This is only used when embedding
+       the player into another window.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-v</term>
+    <listitem>
+      <para>
+          Be verbose; i.e. print log messages to stdout.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-va</term>
+    <listitem>
+      <para>
+         Be verbose about movie Actions.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-vp</term>
+    <listitem>
+      <para>
+         Be verbose about parsing the movie.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-ml bias</term>
+    <listitem>
+      <para>
+  Specify the texture LOD bias (float, default is -1).
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-p</term>
+    <listitem>
+      <para>
+          Run full speed (no sleep) and log frame rate.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-g</term>
+    <listitem>
+      <para>
+          Start Gnash with a Flash debugger console so one can set
+         break points or watchpoints.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-w</term>
+    <listitem>
+      <para>
+       Write the gnash-dbg.log debug log to disk. By default the
+       plugin writes its log in your home directory when using a
+       launcher from GNOME or KDE.
+      </para>
+    </listitem>
+  </varlistentry>
+
+<!--
+  <varlistentry>
+    <term>-e</term>
+    <listitem>
+      <para>
+          Use SDL Event thread
+      </para>
+    </listitem>
+  </varlistentry>
+-->
+  <varlistentry>
+    <term>-1</term>
+    <listitem>
+      <para>
+       Play once; exit when/if movie reaches the last frame.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-r [0|1|2]</term>
+    <listitem>
+      <para>
+       0 disables rendering and sound (good for batch tests).
+      </para>
+      <para>
+       1 enables rendering and sound (default setting).
+      </para>
+      <para>
+       2 enables rendering and disables sound.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-t sec</term>
+    <listitem>
+      <para>
+       Timeout and exit after the specified number of seconds.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-u</term>
+    <listitem>
+      <para>
+       Set "real" url of the movie (useful for downloaded movies).
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-U</term>
+    <listitem>
+      <para>
+       Set "base" url for this run (used to resolve relative urls,
+       defaults to movie url)
+
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-P</term>
+    <listitem>
+      <para>
+       Set parameter (ie. "FlashVars=A=1&amp;b=2")
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-F</term>
+    <listitem>
+      <para>
+       Set filedescriptor to use for external communications.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>--version</term>
+    <listitem>
+      <para>
+       Print the version number, and the configuration of the
+       Gnash player. Please use this info when submitting bug
+       reports.
+      </para>
+    </listitem>
+  </varlistentry>
+
+</variablelist>
+
+<refsect2><title>Keys</title>
+
+<variablelist>
+  <varlistentry>
+    <term>CTRL-Q</term>
+    <listitem>
+      <para>
+          Quit/Exit.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-W</term>
+    <listitem>
+      <para>
+          Quit/Exit.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>ESC</term>
+    <listitem>
+      <para>
+             Quit/Exit.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-P</term>
+    <listitem>
+      <para>
+          Toggle Pause.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-R   </term>
+    <listitem>
+      <para>
+          Restart the movie.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-[ or kp-</term>
+    <listitem>
+      <para>
+       Step back one frame.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-] or kp+</term>
+    <listitem>
+      <para>
+       Step forward one frame.
+      </para>
+    </listitem>
+  </varlistentry>
+
+<!--
+  <varlistentry>
+    <term>CTRL-A</term>
+    <listitem>
+      <para>
+          Toggle anti-aliasing (doesn't work).
+      </para>
+    </listitem>
+  </varlistentry>
+-->
+
+  <varlistentry>
+    <term>CTRL-T</term>
+    <listitem>
+      <para>
+          Debug.  Test the set_variable() function.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-G</term>
+    <listitem>
+      <para>
+          Debug.  Test the get_variable() function.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-M</term>
+    <listitem>
+      <para>
+          Debug.  Test the call_method() function.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>CTRL-B</term>
+    <listitem>
+      <para>
+          Toggle background color.
+      </para>
+    </listitem>
+  </varlistentry>
+  </variablelist>
+
+<para>
+  Flash is Trademarked by Adobe Corporation.
+</para>
+
+</refsect2>
+</refsect1>
+</refentry>
+

Index: gprocessor.man-xml
===================================================================
RCS file: gprocessor.man-xml
diff -N gprocessor.man-xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ gprocessor.man-xml  16 Feb 2008 23:32:22 -0000      1.1
@@ -0,0 +1,116 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";
+[
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!ENTITY appversion "0.8">
+  <!ENTITY manrevision "0.1">
+  <!ENTITY date "Feb 2008">
+  <!ENTITY app "<application>Gprocessor</application>">
+  <!ENTITY appname "Gprocessor">
+  <!ENTITY version "0.8">
+]
+>
+
+<refentry id="gprocessor">
+<refmeta>
+<refentrytitle>gprocessor</refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<!-- the refname becomes the output name of the man page -->
+<refnamediv>
+<refname>gprocessor</refname>
+<refpurpose>Gnash SWF Processor</refpurpose>
+</refnamediv>
+
+
+<refsynopsisdiv><title>Synopsis</title>
+<synopsis>
+gprocessor (options)... (file)...
+</synopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+  Gprocessor is an debugging tool for SWF files, that is a companion to
+  Gnash. This is most often used for debugging and running testcases,
+  as this tool is equivalant to running Gnash with no graphic
+  output. This tool is primarily used by Gnash developers, or anyone
+  that wishes to run the Gnash test cases.
+</para>
+
+<variablelist>
+  <varlistentry>
+    <term>-h</term>
+    <listitem>
+      <para>
+       Print usage info.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-w</term>
+    <listitem>
+      <para>
+       Write a .gsc file with preprocessed info, for each input file.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-vp</term>
+    <listitem>
+      <para>
+       Be verbose about movie parsing.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-va</term>
+    <listitem>
+      <para>
+       Be verbose about ActionScript.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-d [ms]</term>
+    <listitem>
+      <para>
+       Milliseconds delay between advances (0 by default). If '-1'
+       the delay will be computed from the FPS.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-f [frames]</term>
+    <listitem>
+      <para>
+       Allow the given number of frame advancements. Keep advancing
+       untill any other stop condition is encountered if set to 0
+       (default).
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-r [times]</term>
+    <listitem>
+      <para>
+        Allow the given number of complete runs. Keep looping
+        undefinitely if set to 0. Default is 1 (end as soon as the
+        last frame is reached).
+      </para>
+    </listitem>
+  </varlistentry>
+
+
+</variablelist>
+
+</refsect1>
+</refentry>
+

Index: soldumper.man-xml
===================================================================
RCS file: soldumper.man-xml
diff -N soldumper.man-xml
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ soldumper.man-xml   16 Feb 2008 23:32:22 -0000      1.1
@@ -0,0 +1,83 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";
+[
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!ENTITY appversion "0.8">
+  <!ENTITY manrevision "0.1">
+  <!ENTITY date "Feb 2008">
+  <!ENTITY app "<application>Soldumper</application>">
+  <!ENTITY appname "Soldumper">
+  <!ENTITY version "0.8">
+]
+>
+
+<refentry id="soldumper">
+<refmeta>
+<refentrytitle>soldumper</refentrytitle>
+<manvolnum>1</manvolnum>
+</refmeta>
+
+<!-- the refname becomes the output name of the man page -->
+<refnamediv>
+<refname>soldumper</refname>
+<refpurpose>Gnash Local Shared Object file Dumper</refpurpose>
+</refnamediv>
+
+
+<refsynopsisdiv><title>Synopsis</title>
+<synopsis>
+soldumper (options)... (file)...
+</synopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+  Dump information about the .sol files used by the SharedObject
+  ActionScript class. These files are comprised of a header, and a
+  collection of SWF AMF Objects, normally not viewable by the user.
+</para>
+
+<variablelist>
+  <varlistentry>
+    <term>-h</term>
+    <listitem>
+      <para>
+       Print usage info.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-l</term>
+    <listitem>
+      <para>
+       List all the .sol files in the default path.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>-f</term>
+    <listitem>
+      <para>
+       Ignore the global setting, use the current directory for files.
+      </para>
+    </listitem>
+  </varlistentry>
+
+
+  <varlistentry>
+    <term>-v</term>
+    <listitem>
+      <para>
+       Verbose output.
+      </para>
+    </listitem>
+  </varlistentry>
+
+
+</variablelist>
+
+</refsect1>
+</refentry>
+