← Back to branch summary

~bwy/+junk/gnash-temp

« back to all changes in this revision

Viewing changes to doc/C/gnash.xml

  • Committer: rsavoye
  • Date: 2005-12-20 20:52:15 UTC
  • Revision ID: cvs-1:rsavoye-20051220205215-2yzssoiy3cxwh18d
Add the initial version of the documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/C/gnash.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
  <!ENTITY legal SYSTEM "legal.xml">
 
5
  <!ENTITY appversion "0.7">
 
6
  <!ENTITY manrevision "0.7">
 
7
  <!ENTITY date "December 2005">
 
8
  <!ENTITY app "<application>Gnash</application>">
 
9
  <!ENTITY appname "Gnash">
 
10
  <!ENTITY version "0.7">
 
11
 ]
 
12
>
 
13
 
 
14
 <!-- =============Document Header ============================= -->
 
15
 <article id="index" lang="en">
 
16
<!-- please do not change the id; for translations, change lang to -->
 
17
<!-- appropriate code -->
 
18
   <articleinfo>
 
19
     <title>&app; Manual V&manrevision;</title>
 
20
     <copyright>
 
21
       <year>2005</year>
 
22
       <holder>Rob Savoye</holder>
 
23
     </copyright>
 
24
<!-- translators: uncomment this:
 
25
 
 
26
  <copyright>
 
27
   <year>2005</year>
 
28
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
 
29
  </copyright>
 
30
 
 
31
   -->
 
32
<!-- An address can be added to the publisher information.  If a role is 
 
33
     not specified, the publisher/author is the same for all versions of the 
 
34
     document.  -->
 
35
    <publisher> 
 
36
      <publishername> GNOME Documentation Project </publishername> 
 
37
    </publisher> 
 
38
 
 
39
<!-- 
 
40
      Copyright (c)  2005, Free Software Foundation, Inc.
 
41
      Permission is granted to copy, distribute and/or modify this document
 
42
      under the terms of the GNU Free Documentation License, Version 1.2
 
43
      or any later version published by the Free Software Foundation;
 
44
      with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
 
45
      Texts.  A copy of the license is included in the section entitled "GNU
 
46
      Free Documentation License".
 
47
-->
 
48
 
 
49
   &legal;
 
50
   <!-- This file  contains link to license for the documentation (GNU FDL), and 
 
51
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
 
52
        any of this. -->
 
53
 
 
54
    <authorgroup> 
 
55
      <author> 
 
56
        <firstname>Rob</firstname> 
 
57
        <surname>Savoye</surname> 
 
58
        <affiliation> 
 
59
          <address>
 
60
            <email>rob@senecass.com</email>
 
61
          </address> 
 
62
        </affiliation> 
 
63
      </author> 
 
64
<!-- This is appropriate place for other contributors: translators,
 
65
      maintainers,  etc. Commented out by default.
 
66
       <othercredit role="translator">
 
67
        <firstname>Latin</firstname> 
 
68
        <surname>Translator 1</surname> 
 
69
        <affiliation> 
 
70
          <orgname>Latin Translation Team</orgname> 
 
71
          <address> <email>translator@gnome.org</email> </address> 
 
72
        </affiliation>
 
73
        <contrib>Latin translation</contrib>
 
74
      </othercredit>
 
75
-->
 
76
    </authorgroup>
 
77
 
 
78
    <revhistory>
 
79
      <revision> 
 
80
        <revnumber>&appname; Manual V&manrevision;</revnumber> 
 
81
        <date>&date;</date> 
 
82
        <revdescription> 
 
83
          <para role="author">Rob Savoye
 
84
            <email>rob@senecass.com</email>
 
85
          </para>
 
86
          <para role="publisher">GNOME Documentation Project</para>
 
87
        </revdescription> 
 
88
      </revision> 
 
89
    </revhistory> 
 
90
 
 
91
    <releaseinfo>This manual describes version &appversion; of &appname;.
 
92
    </releaseinfo>
 
93
   </articleinfo>
 
94
 
 
95
  <indexterm zone="index"> 
 
96
    <primary>Gnash</primary> 
 
97
  </indexterm>
 
98
 
 
99
<!-- ============= Document Body ============================= -->
 
100
 
 
101
<!-- ============= Introduction ============================== -->
 
102
  <sect1 id="intro"> <title>Introduction</title>
 
103
    <para>
 
104
      Gnash is a Free Flash movie player, which works either
 
105
      standalone, or as a firefox plugin.
 
106
    </para>
 
107
 
 
108
    <sect2 id="betterintro">
 
109
      <title>What is &appname; ?</title>
 
110
 
 
111
      <para>
 
112
      </para>
 
113
 
 
114
    </sect2>    
 
115
  </sect1>
 
116
 
 
117
  <sect1 id="Gnash Overview">
 
118
    <title>Gnash Overview</title>
 
119
 
 
120
    <para>
 
121
    </para>
 
122
 
 
123
  </sect1>
 
124
 
 
125
  <sect1 id="Gnash Usage">
 
126
    <title>Gnash Usage</title>
 
127
 
 
128
    <para>
 
129
    </para>
 
130
 
 
131
    <variablelist>
 
132
      <varlistentry>
 
133
        <term>-h</term>
 
134
        <listitem>
 
135
          <para>
 
136
            Print usage info.
 
137
          </para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
      
 
141
      <varlistentry>
 
142
        <term>-s factor</term>
 
143
        <listitem>
 
144
          <para>
 
145
            Scale the movie up/down by the specified factor.
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>
 
149
      
 
150
      <varlistentry>
 
151
        <term>-c</term>
 
152
        <listitem>
 
153
          <para>
 
154
            Produce a core file instead of letting SDL trap it
 
155
          </para>
 
156
        </listitem>
 
157
      </varlistentry>
 
158
      
 
159
      <varlistentry>
 
160
        <term>-d num</term>
 
161
        <listitem>
 
162
          <para>
 
163
            Number of milli-seconds to delay in main loop
 
164
          </para>
 
165
        </listitem>
 
166
      </varlistentry>
 
167
      
 
168
      <varlistentry>
 
169
        <term>-a</term>
 
170
        <listitem>
 
171
          <para>
 
172
            Turn antialiasing on/off.  (obsolete)
 
173
          </para>
 
174
        </listitem>
 
175
      </varlistentry>
 
176
      
 
177
      <varlistentry>
 
178
        <term>-v</term>
 
179
        <listitem>
 
180
          <para>
 
181
            Be verbose; i.e. print log messages to stdout
 
182
          </para>
 
183
        </listitem>
 
184
      </varlistentry>
 
185
      
 
186
      <varlistentry>
 
187
        <term>-va</term>
 
188
        <listitem>
 
189
          <para>
 
190
            Be verbose about movie Actions
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>
 
194
      
 
195
      <varlistentry>
 
196
        <term>-vp</term>
 
197
        <listitem>
 
198
          <para>
 
199
            Be verbose about parsing the movie
 
200
          </para>
 
201
        </listitem>
 
202
      </varlistentry>
 
203
      
 
204
      <varlistentry>
 
205
        <term>-ml bias</term>
 
206
        <listitem>
 
207
          <para>
 
208
            Specify the texture LOD bias (float, default is -1)
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
 
214
        <term>-p</term>
 
215
        <listitem>
 
216
          <para>
 
217
            Run full speed (no sleep) and log frame rate
 
218
          </para>
 
219
        </listitem>
 
220
      </varlistentry>
 
221
      
 
222
      <varlistentry>
 
223
        <term>-e</term>
 
224
        <listitem>
 
225
          <para>
 
226
            Use SDL Event thread
 
227
          </para>
 
228
        </listitem>
 
229
      </varlistentry>
 
230
      
 
231
      <varlistentry>
 
232
        <term>-1</term>
 
233
        <listitem>
 
234
          <para>
 
235
            Play once; exit when/if movie reaches the last frame
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term>-r [0|1|2]</term>
 
242
        <listitem>
 
243
          <para>
 
244
            0 disables renderering and sound (good for batch tests)
 
245
          </para>
 
246
          <para>
 
247
            1 enables rendering and sound (default setting)
 
248
          </para>
 
249
          <para>
 
250
            2 enables rendering and disables sound
 
251
          </para>
 
252
        </listitem>
 
253
      </varlistentry>
 
254
      
 
255
      <varlistentry>
 
256
        <term>-t sec</term>
 
257
        <listitem>
 
258
          <para>
 
259
            Timeout and exit after the specified number of seconds
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term>-b bits</term>
 
266
        <listitem>
 
267
          <para>
 
268
            Bit depth of output window (16 or 32, default is 16)
 
269
          </para>
 
270
        </listitem>
 
271
      </varlistentry>
 
272
      
 
273
    </variablelist>
 
274
    
 
275
    <!-- FIXME: add title -->
 
276
 
 
277
    <variablelist>
 
278
      <varlistentry>
 
279
        <term>CTRL-Q</term>
 
280
        <listitem>
 
281
          <para>
 
282
            Quit/Exit
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
 
288
        <term>CTRL-W</term>
 
289
        <listitem>
 
290
          <para>
 
291
            Quit/Exit
 
292
          </para>
 
293
        </listitem>
 
294
      </varlistentry>
 
295
      
 
296
      <varlistentry>
 
297
        <term>ESC</term>
 
298
        <listitem>
 
299
          <para>
 
300
            Quit/Exit
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term>CTRL-P</term>
 
307
        <listitem>
 
308
          <para>
 
309
            Toggle Pause
 
310
          </para>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
 
314
      <varlistentry>
 
315
        <term>CTRL-R   </term>
 
316
        <listitem>
 
317
          <para>
 
318
            Restart the movie
 
319
          </para>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term>CTRL-[ or kp-</term>
 
325
        <listitem>
 
326
          <para>
 
327
            Step back one frame
 
328
          </para>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
332
      <varlistentry>
 
333
        <term>CTRL-] or kp+</term>
 
334
        <listitem>
 
335
          <para>
 
336
            Step forward one frame
 
337
          </para>
 
338
        </listitem>
 
339
      </varlistentry>
 
340
      
 
341
      <varlistentry>
 
342
        <term>CTRL-A</term>
 
343
        <listitem>
 
344
          <para>
 
345
            Toggle antialiasing (doesn't work)
 
346
          </para>
 
347
        </listitem>
 
348
      </varlistentry>
 
349
      
 
350
      <varlistentry>
 
351
        <term>CTRL-T</term>
 
352
        <listitem>
 
353
          <para>
 
354
            Debug.  Test the set_variable() function
 
355
          </para>
 
356
        </listitem>
 
357
      </varlistentry>
 
358
      
 
359
      <varlistentry>
 
360
        <term>CTRL-G</term>
 
361
        <listitem>
 
362
          <para>
 
363
            Debug.  Test the get_variable() function
 
364
          </para>
 
365
        </listitem>
 
366
      </varlistentry>
 
367
      
 
368
      <varlistentry>
 
369
        <term>CTRL-M</term>
 
370
        <listitem>
 
371
          <para>
 
372
            Debug.  Test the call_method() function
 
373
          </para>
 
374
        </listitem>
 
375
      </varlistentry>
 
376
      
 
377
      <varlistentry>
 
378
        <term>CTRL-B</term>
 
379
        <listitem>
 
380
          <para>
 
381
            Toggle background color
 
382
          </para>
 
383
        </listitem>
 
384
      </varlistentry>
 
385
    </variablelist>
 
386
  </sect1>
 
387
 
 
388
<!-- ============= Authors ================================ -->
 
389
 
 
390
  <sect1 id="authors">
 
391
    <title>Authors</title>
 
392
    <para>
 
393
      <application>Gnash</application> was written by Rob Savoye
 
394
      (<email>rob@senecass.com</email>).  Please send all comments,
 
395
      suggestions, and bug reports to <email>rob@senecass.com</email>. 
 
396
      I am available for consulting on a variety of renewable energy
 
397
      and open source technologies. More details at <ulink type="http"
 
398
      url="http://www.senecass.com">http://www.senecass.com</ulink>
 
399
   </para>
 
400
 
 
401
  </sect1>
 
402
 
 
403
  <!-- ============= Application License ============================= -->
 
404
 
 
405
  <sect1 id="license">
 
406
   <title>License</title>
 
407
   <para>
 
408
    This program is free software; you can redistribute it and/or
 
409
    modify it under the terms of the <citetitle>GNU General Public
 
410
    License</citetitle> as published by the Free Software Foundation;
 
411
    either version 2 of the License, or (at your option) any later
 
412
    version.
 
413
   </para>
 
414
   <para>
 
415
    This program is distributed in the hope that it will be useful, but
 
416
    WITHOUT ANY WARRANTY; without even the implied warranty of
 
417
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
418
    <citetitle>GNU General Public License</citetitle> for more details.
 
419
   </para>
 
420
   <para>
 
421
    A copy of the <citetitle>GNU General Public License</citetitle> is
 
422
    included as an appendix to the <citetitle>GNOME Users
 
423
    Guide</citetitle>.  You may also obtain a copy of the
 
424
    <citetitle>GNU General Public License</citetitle> from the Free
 
425
    Software Foundation by visiting <ulink type="http"
 
426
    url="http://www.fsf.org">their Web site</ulink> or by writing to
 
427
    <address>
 
428
     Free Software Foundation, Inc.
 
429
     <street>51 Franklin St, Fifth Floor</street>
 
430
     <city>Boston</city>, <state>MA</state> <postcode>02111-1301</postcode>
 
431
     <country>USA</country>
 
432
    </address>
 
433
   </para>
 
434
  </sect1>
 
435
</article>