~ubuntu-branches/ubuntu/karmic/gnash/karmic

« back to all changes in this revision

Viewing changes to doc/C/usermanual/usage.xml

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Sack
  • Date: 2008-10-13 14:29:49 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20081013142949-f6qdvnu4mn05ltdc
Tags: 0.8.4~~bzr9980-0ubuntu1
* new upstream release 0.8.4 (LP: #240325)
* ship new lib usr/lib/gnash/libmozsdk.so.* in mozilla-plugin-gnash
  - update debian/mozilla-plugin-gnash.install
* ship new lib usr/lib/gnash/libgnashnet.so.* in gnash-common
  - update debian/gnash-common.install
* add basic debian/build_head script to build latest CVS head packages.
  - add debian/build_head
* new sound architecture requires build depend on libsdl1.2-dev
  - update debian/control
* head build script now has been completely migrated to bzr (upstream +
  ubuntu)
  - update debian/build_head
* disable kde gui until klash/qt4 has been fixed; keep kde packages as empty
  packages for now.
  - update debian/rules
  - debian/klash.install
  - debian/klash.links
  - debian/klash.manpages
  - debian/konqueror-plugin-gnash.install
* drop libkonq5-dev build dependency accordingly
  - update debian/control
* don't install headers manually anymore. gnash doesnt provide a -dev
  package after all
  - update debian/rules
* update libs installed in gnash-common; libgnashserver-*.so is not available
  anymore (removed); in turn we add the new libgnashcore-*.so
  - update debian/gnash-common.install
* use -Os for optimization and properly pass CXXFLAGS=$(CFLAGS) to configure
  - update debian/rules
* touch firefox .autoreg in postinst of mozilla plugin
  - update debian/mozilla-plugin-gnash.postinst
* link gnash in ubufox plugins directory for the plugin alternative switcher
  - add debian/mozilla-plugin-gnash.links
* suggest ubufox accordingly
  - update debian/control
* add new required build-depends on libgif-dev
  - update debian/control
* add Xb-Npp-Description and Xb-Npp-File as new plugin database meta data
  - update debian/control

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
      gnash <replaceable>&lt;option&gt; &lt;flashfile.swf&gt;</replaceable>
9
9
    </programlisting>
10
10
    The only required argument is the name (and location) of the file
11
 
    to be played.
 
11
    to be played. 
12
12
  </para>
13
13
  
14
14
  <para>
25
25
    files.  They are located in the
26
26
    <filename>testsuite/samples/</filename> directory of the &app;
27
27
    source directory.  If you have installed &app; correctly, issuing
28
 
    the a command similar to the following plays a short animation of
 
28
    a command similar to the following plays a short animation of
29
29
    a car swerving and crashing: 
30
30
    <programlisting>
31
31
      gnash
76
76
        </thead>
77
77
        <tbody>
78
78
          <row>
79
 
            <entry><option>-h</option></entry>
 
79
            <entry><option>-h, --help</option></entry>
80
80
            <entry>
81
81
              Print usage information.
82
82
            </entry>
83
83
          </row>
84
84
          <row>
85
85
            <entry>
86
 
              <option>-s factor</option>
 
86
              <option>-s, --scale</option> <replaceable>&lt;factor&gt;</replaceable>
87
87
            </entry>
88
88
            <entry>
89
89
              Scale the movie up/down by the specified factor.
101
101
          </row>
102
102
          <row>
103
103
            <entry>
104
 
              <option>-d num</option>
 
104
              <option>-d, --delay</option> <replaceable>&lt;num&gt;</replaceable>
105
105
            </entry>
106
106
            <entry>
107
107
              Number of milliseconds to delay in main loop. The main
114
114
          </row>
115
115
          <row>
116
116
            <entry>
117
 
              <option>-v</option>
 
117
              <option>-v, --verbose</option>
118
118
            </entry>
119
119
            <entry>
120
120
              Be verbose; i.e. print important messages to stdout.
133
133
              <option>-va</option>
134
134
            </entry>
135
135
            <entry>
136
 
              Be verbose about movie actions (for ActionScript debugging). This
 
136
              Be verbose about movie actions (for ActionScript debugging). This usually
137
137
              generates very large amounts of text and will affect &app;'s performance.
138
138
            </entry>
139
139
          </row>
142
142
              <option>-vp</option>
143
143
            </entry>
144
144
            <entry>
145
 
              Be verbose about parsing the movie. Warning: this can
146
 
              generate a lot of text, and can affect the performance of
147
 
              the movie you are playing.
148
 
            </entry>
149
 
          </row>
150
 
          <row>
151
 
            <entry>
152
 
              <option>-ml bias</option>
153
 
            </entry>
154
 
            <entry>
155
 
              Specify the texture LOD bias (float, default is -1) This
156
 
              affects the fuzziness of small objects, especially small
157
 
              text.
158
 
            </entry>
159
 
          </row>
160
 
          <row>
161
 
            <entry>
162
 
              <option>-w</option>
163
 
            </entry>
164
 
            <entry>
165
 
              Write a debug log called gnash-dbg.log. This will 
166
 
              record of all the debug messages whether they are printed
167
 
              to the screen or not.
168
 
            </entry>
169
 
          </row>
170
 
          <row>
171
 
            <entry>
172
 
              <option>-j</option>
173
 
            </entry>
174
 
            <entry>
175
 
              Specify the width of the window. This is mostly used
176
 
              only by the plugin.
177
 
            </entry>
178
 
          </row>
179
 
          <row>
180
 
            <entry>
181
 
              <option>-k</option>
182
 
            </entry>
183
 
            <entry>
184
 
              Specify the height of the window. This is mostly used
185
 
              only by the plugin.
186
 
            </entry>
187
 
          </row>
188
 
          <row>
 
145
              Be verbose about parsing the movie. This generates a fairly large
 
146
              amount of text, and is likely to affect &app;'s performance.
 
147
            </entry>
 
148
          </row>
 
149
          <row>
 
150
            <entry>
 
151
              <option>-A</option> <replaceable>&lt;file&gt;</replaceable>
 
152
            </entry>
 
153
            <entry>
 
154
              Write the audio output to a wave format file.
 
155
            </entry>
 
156
          </row>
 
157
          <row>
 
158
            <entry>
 
159
              <option>-D</option> <replaceable>&lt;file&gt;</replaceable>
 
160
            </entry>
 
161
            <entry>
 
162
              Write the video output to a raw video file.  This option
 
163
              is only valid with dump-gnash.
 
164
            </entry>
 
165
          </row>
 
166
          <row>
 
167
            <entry>
 
168
              <option>-w, --writelog</option>
 
169
            </entry>
 
170
            <entry>
 
171
              Write the log messages to disk using the file specified in the gnashrc file.
 
172
              The default is gnash-dbg.log.
 
173
            </entry>
 
174
          </row>
 
175
          <row>
 
176
            <entry>
 
177
              <option>-j, --width</option> <replaceable>&lt;num&gt;</replaceable>
 
178
            </entry>
 
179
            <entry>
 
180
              Specify the starting width of the window. This is mostly used
 
181
              only by the plugin.
 
182
            </entry>
 
183
          </row>
 
184
          <row>
 
185
            <entry>
 
186
              <option>-k, --height</option> <replaceable>&lt;num&gt;</replaceable>
 
187
            </entry>
 
188
            <entry>
 
189
              Specify the starting height of the window. This is mostly used
 
190
              only by the plugin.
 
191
            </entry>
 
192
          </row>
189
193
            <!--        
 
194
              <row>
190
195
                <entry>
191
196
                <option>-e</option>
192
197
                </entry>
196
201
                improve performance for some types of movies.
197
202
                </entry>
198
203
                </row>
199
 
                <row>
200
204
            -->
 
205
          <row>
201
206
            <entry>
202
 
              <option>-1</option>
 
207
              <option>-1, --once</option>
203
208
            </entry>
204
209
            <entry>
205
 
              Play once; exit when/if movie reaches the last
 
210
              Play once; exit if or when the movie reaches the last
206
211
              frame.
207
212
            </entry>
208
213
          </row>
209
214
          <row>
210
215
            <entry>
211
 
              <option>-r [0|1|2|3]</option>
 
216
              <option>-r, --render-mode</option> <replaceable>&lt;0|1|2|3&gt;</replaceable>
212
217
            </entry>
213
218
            <entry>
214
219
              <itemizedlist>
219
224
                </listitem>
220
225
                <listitem>
221
226
                  <para>
222
 
                    1 enables rendering and disables sound (default setting).
 
227
                    1 enables rendering and disables sound.
223
228
                  </para>
224
229
                </listitem>
225
230
                <listitem>
229
234
                </listitem>
230
235
                <listitem>
231
236
                  <para>
232
 
                    3 enables rendering and sound.
 
237
                    3 enables rendering and sound (default).
233
238
                  </para>
234
239
                </listitem>
235
240
              </itemizedlist>
237
242
          </row>
238
243
          <row>
239
244
            <entry>
240
 
              <option>-t sec</option>
 
245
              <option>-t, --timeout</option> <replaceable>&lt;sec&gt;</replaceable>
241
246
            </entry>
242
247
            <entry>
243
248
              Timeout and exit after the specified number of
247
252
          </row>
248
253
          <row>
249
254
            <entry>
250
 
              <option>-g</option>
 
255
              <option>-g, --debugger</option>
251
256
            </entry>
252
257
            <entry>
253
258
              Start &app; with a Flash debugger console so one can set
256
261
          </row>
257
262
          <row>
258
263
            <entry>
259
 
              <option>-x id</option>
 
264
              <option>-x, --xid</option> <replaceable>&lt;ID&gt;</replaceable>
260
265
            </entry>
261
266
            <entry>
262
267
              This specifies the X11 window ID to display
276
281
-->
277
282
          <row>
278
283
            <entry>
279
 
              <option>-u url</option>
 
284
              <option>-u, --real-url</option> <replaceable>&lt;URL&gt;</replaceable>
280
285
            </entry>
281
286
            <entry>
282
287
              Set the _url member of the root movie. This is useful 
286
291
          </row>
287
292
          <row>
288
293
            <entry>
289
 
              <option>-U baseurl</option>
 
294
              <option>-U, --base-url</option> <replaceable>&lt;URL&gt;</replaceable>
290
295
            </entry>
291
296
            <entry>
292
297
              Set base URL for this run. URLs are resolved relative to 
293
 
              this base. If omitted defaults to the _url member of the 
 
298
              this base. If omitted or empty, it defaults to the _url member of the 
294
299
              top-level movie (see the -u switch).
295
300
            </entry>
296
301
          </row>
297
302
          <row>
298
303
            <entry>
299
 
              <option>-P parameter</option>
 
304
              <option>-P, --param</option> <replaceable>&lt;parameter&gt;</replaceable>
300
305
            </entry>
301
306
            <entry>
302
307
              Parameters are given in the syntax &quot;ParamName=Value&quot; and are mostly 
308
313
          </row>
309
314
          <row>
310
315
            <entry>
311
 
              <option>-F filedescriptor</option>
 
316
              <option>-F, --fd</option> <replaceable>&lt;filedescriptor&gt;</replaceable>
312
317
            </entry>
313
318
            <entry>
314
319
              Use the given filedescriptor to send requests to the host
318
323
              support javascript and target windows in geturl requests.
319
324
            </entry>
320
325
          </row>
 
326
          <row>
 
327
            <entry>
 
328
              <option>--max-advances</option> <replaceable>&lt;num&gt;</replaceable>
 
329
            </entry>
 
330
            <entry>
 
331
          Exit after the specified number of frame advances.
 
332
            </entry>
 
333
          </row>          
 
334
          <row>
 
335
            <entry>
 
336
              <option>--fullscreen</option>
 
337
            </entry>
 
338
            <entry>
 
339
          Start &app; in fullscreen mode as long as the GUI and window
 
340
          manager support this. 
 
341
            </entry>
 
342
          </row>        
 
343
 
321
344
        </tbody>
322
345
      </tgroup>
323
346
    </table>