doc/C/gnash.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.4">
   7   <!ENTITY date "Feb 2011">
   8   <!ENTITY app "<application>Gnash</application>">
   9   <!ENTITY appname "Gnash">
  10   <!ENTITY version "0.8">
  11 ]
  12 >
  13
  14 <refentry id="gnash">
  15 <refmeta>
  16 <refentrytitle>gnash</refentrytitle>
  17 <manvolnum>1</manvolnum>
  18 </refmeta>
  19
  20 <!-- the refname becomes the output name of the man page -->
  21 <refnamediv>
  22 <refname>gnash</refname>
  23 <refname>gtk-gnash</refname>
  24 <refname>kde4-gnash</refname>
  25 <refpurpose>GNU Flash (SWF) Player</refpurpose>
  26 </refnamediv>
  27
  28
  29 <refsynopsisdiv><title>Synopsis</title>
  30 <synopsis>
  31 gnash [option]... [URL]
  32 </synopsis>
  33 </refsynopsisdiv>
  34
  35 <refsect1><title>Description</title>
  36 <para>
  37   Run the SWF movie player.
  38 </para>
  39
  40 <variablelist>
  41   <varlistentry>
  42     <term>-h</term>
  43     <term>--help</term>
  44     <listitem>
  45       <para>
  46         Print usage info.
  47       </para>
  48     </listitem>
  49   </varlistentry>
  50
  51   <varlistentry>
  52     <term>-V</term>
  53     <term>--version</term>
  54     <listitem>
  55       <para>
  56         Print the version number, and the configuration, of the
  57         Gnash player. Please provide this information when submitting bug
  58         reports.
  59       </para>
  60     </listitem>
  61   </varlistentry>
  62
  63   <varlistentry>
  64     <term>-s factor</term>
  65     <term>--scale factor</term>
  66     <listitem>
  67       <para>
  68             Scale the movie up/down by the specified factor.
  69       </para>
  70     </listitem>
  71   </varlistentry>
  72
  73   <varlistentry>
  74     <term>-c</term>
  75     <listitem>
  76       <para>
  77         Produce a core file instead of letting SDL trap it
  78       </para>
  79     </listitem>
  80   </varlistentry>
  81
  82   <varlistentry>
  83     <term>-d num</term>
  84     <term>--delay num</term>
  85     <listitem>
  86       <para>
  87         Number of milliseconds to delay in main loop.
  88       </para>
  89     </listitem>
  90   </varlistentry>
  91
  92   <varlistentry>
  93     <term>-v</term>
  94     <term>--verbose</term>
  95     <listitem>
  96       <para>
  97           Be verbose; i.e. print log messages to stdout.
  98       </para>
  99     </listitem>
 100   </varlistentry>
 101
 102   <varlistentry>
 103     <term>-a</term>
 104     <listitem>
 105       <para>
 106         Be very verbose about movie action execution. Must be used in
 107         conjunction with -v.
 108       </para>
 109     </listitem>
 110   </varlistentry>
 111
 112   <varlistentry>
 113     <term>-p</term>
 114     <listitem>
 115       <para>
 116         Be very verbose about parsing. Must be used in conjunction with -v.
 117       </para>
 118     </listitem>
 119   </varlistentry>
 120
 121   <varlistentry>
 122     <term>-A file</term>
 123     <listitem>
 124       <para>
 125         Audio dump file (wave format).
 126       </para>
 127     </listitem>
 128   </varlistentry>
 129
 130   <varlistentry>
 131     <term>--hwaccel none|vaapi|xv</term>
 132     <listitem>
 133       <para>
 134         Hardware Video Accelerator to use none|vaapi|xv|omap (default: none)
 135       </para>
 136     </listitem>
 137   </varlistentry>
 138
 139   <varlistentry>
 140     <term>-x xid</term>
 141     <term>--xid xid</term>
 142     <listitem>
 143       <para>
 144             The XID of the parent window Gnash should use instead of
 145             creating a new one.  This is only used when embedding the player
 146             into another window.
 147       </para>
 148     </listitem>
 149   </varlistentry>
 150
 151   <varlistentry>
 152     <term>-w</term>
 153     <term>--writelog</term>
 154     <listitem>
 155       <para>
 156         Write the gnash-dbg.log debug log to disk. By default the
 157         plugin writes its log in your home directory when using a
 158         launcher from GNOME or KDE.
 159       </para>
 160     </listitem>
 161   </varlistentry>
 162
 163   <varlistentry>
 164     <term>-j width</term>
 165     <term>--width width</term>
 166     <listitem>
 167       <para>
 168             Set the width of the window. This is only used when embedding
 169             the player into another window.
 170       </para>
 171     </listitem>
 172   </varlistentry>
 173
 174   <varlistentry>
 175     <term>-k height</term>
 176     <term>--height height</term>
 177     <listitem>
 178       <para>
 179         Set the height of the window. This is only used when embedding
 180         the player into another window.
 181       </para>
 182     </listitem>
 183   </varlistentry>
 184
 185   <varlistentry>
 186     <term>-X x-pos</term>
 187     <term>--x-pos x-pos</term>
 188     <listitem>
 189       <para>
 190         Set window x position.
 191       </para>
 192     </listitem>
 193   </varlistentry>
 194
 195   <varlistentry>
 196     <term>-Y y-pos</term>
 197     <term>--y-pos y-pos</term>
 198     <listitem>
 199       <para>
 200         Set window y position.
 201       </para>
 202     </listitem>
 203   </varlistentry>
 204
 205   <varlistentry>
 206     <term>-1</term>
 207     <term>--once</term>
 208     <listitem>
 209       <para>
 210         Play once; exit when/if movie reaches the last frame.
 211       </para>
 212     </listitem>
 213   </varlistentry>
 214
 215   <varlistentry>
 216     <term>-g</term>
 217     <listitem>
 218       <para>
 219           Start Gnash with a Flash debugger console so one can set
 220           breakpoints or watchpoints.
 221       </para>
 222     </listitem>
 223   </varlistentry>
 224
 225   <varlistentry>
 226     <term>-r [0|1|2|3]</term>
 227     <listitem>
 228       <para>
 229         0 disables rendering and sound (good for batch tests).
 230       </para>
 231       <para>
 232         1 enables rendering, disable sound.
 233       </para>
 234       <para>
 235         2 disables rendering, enable sound.
 236       </para>
 237       <para>
 238         3 enables rendering and sound (default setting).
 239       </para>
 240     </listitem>
 241   </varlistentry>
 242
 243   <varlistentry>
 244     <term>-M ffmpeg|gst</term>
 245     <term>--media ffmpeg|gst</term>
 246     <listitem>
 247       <para>
 248         The media handler to use (default: ffmpeg).
 249       </para>
 250     </listitem>
 251   </varlistentry>
 252
 253   <varlistentry>
 254     <term>-R agg|cairo|opengl</term>
 255     <term>--renderer agg|cairo|opengl</term>
 256     <listitem>
 257       <para>
 258         The renderer to use (default: agg).
 259       </para>
 260     </listitem>
 261   </varlistentry>
 262
 263   <varlistentry>
 264     <term>-t sec</term>
 265     <term>--timeout sec</term>
 266     <listitem>
 267       <para>
 268         Timeout and exit after the specified number of seconds.
 269       </para>
 270     </listitem>
 271   </varlistentry>
 272
 273   <varlistentry>
 274     <term>-u url</term>
 275     <term>--real-url url</term>
 276     <listitem>
 277       <para>
 278         Set "real" url of the movie (useful for downloaded movies).
 279       </para>
 280     </listitem>
 281   </varlistentry>
 282
 283   <varlistentry>
 284     <term>-U url</term>
 285     <term>--base-url url</term>
 286     <listitem>
 287       <para>
 288         Set "base" url for this run (used to resolve relative urls,
 289         defaults to movie url)
 290       </para>
 291     </listitem>
 292   </varlistentry>
 293
 294   <varlistentry>
 295     <term>-P param</term>
 296     <term>--param param</term>
 297     <listitem>
 298       <para>
 299         Set parameter (ie. "FlashVars=A=1&amp;b=2")
 300       </para>
 301     </listitem>
 302   </varlistentry>
 303
 304   <varlistentry>
 305     <term>-F x:y</term>
 306     <term>--fd x:y</term>
 307     <listitem>
 308       <para>
 309         Set file descriptors to use for external communications. x is
 310         use by the player to send commands to the plugin, y is used
 311         by the plugin to send commands to the standalone player.
 312       </para>
 313     </listitem>
 314   </varlistentry>
 315
 316   <varlistentry>
 317     <term>--max-advances num</term>
 318     <listitem>
 319       <para>
 320         Exit after specified number of frame advances.
 321       </para>
 322     </listitem>
 323   </varlistentry>
 324
 325   <varlistentry>
 326     <term>--fullscreen</term>
 327     <listitem>
 328       <para>
 329         Start in fullscreen mode.
 330       </para>
 331     </listitem>
 332   </varlistentry>
 333
 334   <varlistentry>
 335     <term>--hide-menubar</term>
 336     <listitem>
 337       <para>
 338         Start without displaying the menu bar.
 339       </para>
 340     </listitem>
 341   </varlistentry>
 342
 343   <varlistentry>
 344     <term>--screenshot list</term>
 345     <listitem>
 346       <para>
 347         Set a list of frame advances to be saved as screenshots. The list
 348         must be comma-separated. Valid values are integers and the phrase
 349         &quot;last&quot;. If &quot;last&quot; is specified, the final
 350         frame before exit is saved. Invalid values are ignored. Frame numbers
 351         apply to the sequence of frames as the SWF is executed, not the
 352         frame sequence defined in the SWF. Use in combination with
 353         --screenshot-file to specify output filename.
 354       </para>
 355     </listitem>
 356   </varlistentry>
 357
 358   <varlistentry>
 359     <term>--screenshot-file file</term>
 360     <listitem>
 361       <para>
 362         Specify the output pattern for screenshot filenames. The token %f
 363         in a pattern will be replaced with a frame identifier. If you specify
 364         multiple frames and do not use %f, the file will be overwritten for
 365         each screenshot. If this option is not specified but screenshots
 366         are requested, a default filename will be used.
 367       </para>
 368     </listitem>
 369   </varlistentry>
 370
 371 </variablelist>
 372
 373 <refsect2><title>Keys</title>
 374
 375 <variablelist>
 376   <varlistentry>
 377     <term>CTRL-Q</term>
 378     <listitem>
 379       <para>
 380           Quit/Exit.
 381       </para>
 382     </listitem>
 383   </varlistentry>
 384
 385   <varlistentry>
 386     <term>CTRL-W</term>
 387     <listitem>
 388       <para>
 389           Quit/Exit.
 390       </para>
 391     </listitem>
 392   </varlistentry>
 393
 394   <varlistentry>
 395     <term>CTRL-P</term>
 396     <listitem>
 397       <para>
 398           Toggle pause.
 399       </para>
 400     </listitem>
 401   </varlistentry>
 402
 403   <varlistentry>
 404     <term>CTRL-R   </term>
 405     <listitem>
 406       <para>
 407           Restart the movie.
 408       </para>
 409     </listitem>
 410   </varlistentry>
 411
 412   <varlistentry>
 413     <term>CTRL-L   </term>
 414     <listitem>
 415       <para>
 416           Force immediate redraw.
 417       </para>
 418     </listitem>
 419   </varlistentry>
 420
 421   <varlistentry>
 422     <term>CTRL-F   </term>
 423     <listitem>
 424       <para>
 425         Toggle fullscreen. ESC also exits fullscreen.
 426       </para>
 427     </listitem>
 428   </varlistentry>
 429
 430   <varlistentry>
 431     <term>CTRL-O </term>
 432     <listitem>
 433       <para>
 434         Save a spontaneous screenshot. If no screenshots were requested
 435         from the command line, a default filename is used. Otherwise, the
 436         same filename pattern is used for requested and spontaneous
 437         screenshots.
 438       </para>
 439     </listitem>
 440   </varlistentry>
 441 </variablelist>
 442 <para>
 443 Flash is a registered trademark of Adobe Corporation.
 444 </para>
 445
 446 </refsect2>
 447 </refsect1>
 448 </refentry>
 449