[Gnash-commit] gnash ChangeLog doc/C/cygnal.man-xml doc/C/dump...

[John Gilmore]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     John Gilmore <jgilmore> 08/03/01 00:53:55

Modified files:
        .              : ChangeLog 
        doc/C          : cygnal.man-xml dumpshm.man-xml gnash.man-xml 
                         gprocessor.man-xml soldumper.man-xml 

Log message:
        * doc/C/cygnal.man-xml, doc/C/dumpshm.man-xml, doc/C/gnash.man-xml,
          doc/C/gprocessor.man-xml, doc/C/soldumper.man-xml:  Edit & improve.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.5763&r2=1.5764
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/cygnal.man-xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/dumpshm.man-xml?cvsroot=gnash&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gnash.man-xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/gprocessor.man-xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/soldumper.man-xml?cvsroot=gnash&r1=1.2&r2=1.3

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.5763
retrieving revision 1.5764
diff -u -b -r1.5763 -r1.5764
--- ChangeLog   29 Feb 2008 22:20:07 -0000      1.5763
+++ ChangeLog   1 Mar 2008 00:53:53 -0000       1.5764
@@ -1,5 +1,7 @@
 2008-02-29  John Gilmore  <address@hidden>
 
+       * doc/C/cygnal.man-xml, doc/C/dumpshm.man-xml, doc/C/gnash.man-xml,
+         doc/C/gprocessor.man-xml, doc/C/soldumper.man-xml:  Edit & improve.
        * cygnal/http.cpp, cygnal/cygnal.cpp, cygnal/http.h:  Lint.
 
 2008-02-29 Sandro Santilli <address@hidden>

Index: doc/C/cygnal.man-xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/cygnal.man-xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/cygnal.man-xml        19 Feb 2008 02:12:47 -0000      1.1
+++ doc/C/cygnal.man-xml        1 Mar 2008 00:53:54 -0000       1.2
@@ -34,8 +34,8 @@
 <para>
   Cygnal is a multimedia media server for streaming audio, video, and
   video conferencing. Cygnal supports several protocols used by SWF
-  file players, including RTMP, RTMPTS, and RTMPT, while encouring the
-  use of patent free codecs.
+  file players, including RTMP, RTMPTS, and RTMPT, while encouraging the
+  use of patent-free codecs.
 </para>
 
 <variablelist>

Index: doc/C/dumpshm.man-xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/dumpshm.man-xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/dumpshm.man-xml       19 Feb 2008 02:13:22 -0000      1.2
+++ doc/C/dumpshm.man-xml       1 Mar 2008 00:53:55 -0000       1.3
@@ -32,10 +32,18 @@
 
 <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.
+  When any Flash player, including the Gnash player,
+  plays a Flash "movie", the movie can contain
+  scripts.  These scripts can call ActionScript classes.  One such class
+  is LocalConnection.  LocalConnection passes objects from one movie to
+  another, via your computer's shared memory system.
+</para>
+
+<para>
+  Dumpshm prints these shared memory segments, which are comprised of
+  a header, and a collection of SWF AMF Objects created by the movie.
+  It is used for debugging (or understanding the operation of) a Flash 
+  movie.
 </para>
 
 <variablelist>

Index: doc/C/gnash.man-xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/gnash.man-xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/gnash.man-xml 16 Feb 2008 23:32:22 -0000      1.1
+++ doc/C/gnash.man-xml 1 Mar 2008 00:53:55 -0000       1.2
@@ -58,7 +58,7 @@
     <term>-c</term>
     <listitem>
       <para>
-       Produce a core file instead of letting SDL trap it.
+       Severe errors produce a core file instead of letting SDL trap them.
       </para>
     </listitem>
   </varlistentry>
@@ -86,7 +86,8 @@
     <listitem>
       <para>
        The XID of the parent window Gnash should use instead of
-       creating a new one.
+       creating a new one.  This is only used when embedding the player
+       into another window.
       </para>
     </listitem>
   </varlistentry>
@@ -151,7 +152,7 @@
     <term>-p</term>
     <listitem>
       <para>
-          Run full speed (no sleep) and log frame rate.
+          Run full speed (without sleeping), and log the frame rate.
       </para>
     </listitem>
   </varlistentry>
@@ -161,7 +162,7 @@
     <listitem>
       <para>
           Start Gnash with a Flash debugger console so one can set
-         break points or watchpoints.
+         breakpoints or watchpoints.
       </para>
     </listitem>
   </varlistentry>
@@ -262,8 +263,8 @@
     <term>--version</term>
     <listitem>
       <para>
-       Print the version number, and the configuration of the
-       Gnash player. Please use this info when submitting bug
+       Print the version number, and the configuration, of the
+       Gnash player. Please provide this information when submitting bug
        reports.
       </para>
     </listitem>

Index: doc/C/gprocessor.man-xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/gprocessor.man-xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/gprocessor.man-xml    16 Feb 2008 23:32:22 -0000      1.1
+++ doc/C/gprocessor.man-xml    1 Mar 2008 00:53:55 -0000       1.2
@@ -32,11 +32,11 @@
 
 <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
+  Gprocessor is a debugging tool for SWF files, a companion to
+  Gnash.  It is most often used for debugging and running testcases,
+  as it 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.
+  who wishes to run the Gnash test cases.
 </para>
 
 <variablelist>
@@ -90,9 +90,8 @@
     <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).
+       Allow the given number of frame advancements.  If 0, keep advancing
+       until some other stop condition is encountered (default).
       </para>
     </listitem>
   </varlistentry>
@@ -101,8 +100,8 @@
     <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
+        Allow the given number of complete runs.  If 0, keep looping
+        indefinitely.  Default is 1 (end as soon as the
         last frame is reached).
       </para>
     </listitem>

Index: doc/C/soldumper.man-xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/soldumper.man-xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- doc/C/soldumper.man-xml     19 Feb 2008 02:13:22 -0000      1.2
+++ doc/C/soldumper.man-xml     1 Mar 2008 00:53:55 -0000       1.3
@@ -33,8 +33,24 @@
 <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.
+  ActionScript class.
+</para>
+
+<para>
+  When a Flash player, including the Gnash player, plays a Flash "movie",
+  the movie can contain
+  scripts.  These scripts can call ActionScript classes.  One such class
+  is SharedObject.  SharedObject creates shared objects, which end up
+  stored in your computer's file system.  For example, a Flash game might
+  store its score file in a SharedObject; or a privacy-invading Flash
+  movie might store "cookies" in a SharedObject.  Before soldumper was
+  written, these bits of stored information were hard for users to 
+  notice or investigate.
+
+  Soldumper prints these files,
+  which are comprised of a header, and a
+  collection of SWF AMF Objects that the movie has written in the shared
+  object file.
 </para>
 
 <variablelist>