doc/C/soldumper.man-xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   2                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   3 [
   4   <!ENTITY legal SYSTEM "legal.xml">
   5   <!ENTITY appversion "0.8.9">
   6   <!ENTITY manrevision "0.1">
   7   <!ENTITY date "Feb 2011">
   8   <!ENTITY app "<application>Soldumper</application>">
   9   <!ENTITY appname "Soldumper">
  10   <!ENTITY version "0.8">
  11 ]
  12 >
  13
  14 <refentry id="soldumper">
  15 <refmeta>
  16 <refentrytitle>soldumper</refentrytitle>
  17 <manvolnum>1</manvolnum>
  18 </refmeta>
  19
  20 <!-- the refname becomes the output name of the man page -->
  21 <refnamediv>
  22 <refname>soldumper</refname>
  23 <refpurpose>Gnash Local Shared Object (LSO) File Dumper</refpurpose>
  24 </refnamediv>
  25
  26
  27 <refsynopsisdiv><title>Synopsis</title>
  28 <synopsis>
  29 soldumper (options)... (file)...
  30 </synopsis>
  31 </refsynopsisdiv>
  32
  33 <refsect1><title>Description</title>
  34 <para>
  35   Dump information about the .sol files used by the SharedObject
  36   ActionScript class.
  37 </para>
  38
  39 <para>
  40   When a SWF player, including Gnash, plays a SWF "movie",
  41   the movie can contain
  42   scripts.  These scripts can call ActionScript classes.  One such class
  43   is SharedObject.  SharedObject creates shared objects, which end up
  44   stored in your computer's file system.  For example, a SWF game might
  45   store its score file in a SharedObject; or a privacy-invading SWF
  46   movie might store "cookies" in a SharedObject.  Before soldumper was
  47   written, these bits of stored information were hard for users to
  48   notice or investigate.
  49
  50   Soldumper prints these files,
  51   which are comprised of a header, and a
  52   collection of SWF AMF Objects that the movie has written in the shared
  53   object file.
  54 </para>
  55
  56 <variablelist>
  57   <varlistentry>
  58     <term>-h</term>
  59     <listitem>
  60       <para>
  61         Print usage info.
  62       </para>
  63     </listitem>
  64   </varlistentry>
  65
  66   <varlistentry>
  67     <term>-l</term>
  68     <listitem>
  69       <para>
  70         List all the .sol files in the default path.
  71       </para>
  72     </listitem>
  73   </varlistentry>
  74
  75   <varlistentry>
  76     <term>-f</term>
  77     <listitem>
  78       <para>
  79         Ignore the global setting, use the current directory for files.
  80       </para>
  81     </listitem>
  82   </varlistentry>
  83
  84
  85   <varlistentry>
  86     <term>-v</term>
  87     <listitem>
  88       <para>
  89         Verbose output.
  90       </para>
  91     </listitem>
  92   </varlistentry>
  93
  94
  95 </variablelist>
  96
  97 </refsect1>
  98 </refentry>
  99