update release version and regenerate preformatted copies.
[gnash.git] / doc / C / preformatted / gnash.1.in
blobbd393ca38ce107cdbcf292ae3b5143bf42e74a89
1 .\" -*- coding: us-ascii -*-
2 .if \n(.g .ds T< \\FC
3 .if \n(.g .ds T> \\F[\n[.fam]]
4 .de URL
5 \\$2 \(la\\$1\(ra\\$3
6 ..
7 .if \n(.g .mso www.tmac
8 .TH gnash 1 "30 January 2011" "" ""
9 .SH NAME
10 gnash, gtk-gnash, kde4-gnash \- GNU Flash (SWF) Player
11 .SH Synopsis
12 .nf
14 gnash [option]... [URL]
15 .fi
16 .SH DESCRIPTION
17 Run the SWF movie player.
18 .TP 
19 -h, --help
20 Print usage info.
21 .TP 
22 -V, --version
23 Print the version number, and the configuration, of the
24 Gnash player. Please provide this information when submitting bug
25 reports.
26 .TP 
27 -s factor, --scale factor
28 Scale the movie up/down by the specified factor.
29 .TP 
31 Produce a core file instead of letting SDL trap it
32 .TP 
33 -d num, --delay num
34 Number of milliseconds to delay in main loop.
35 .TP 
36 -v, --verbose
37 Be verbose; i.e. print log messages to stdout.
38 .TP 
40 Be very verbose about movie action execution. Must be used in
41 conjunction with -v.
42 .TP 
44 Be very verbose about parsing. Must be used in conjunction with -v.
45 .TP 
46 -A file
47 Audio dump file (wave format).
48 .TP 
49 --hwaccel none|vaapi|xv
50 Hardware Video Accelerator to use none|vaapi|xv|omap (default: none)
51 .TP 
52 -x xid, --xid xid
53 The XID of the parent window Gnash should use instead of
54 creating a new one. This is only used when embedding the player
55 into another window.
56 .TP 
57 -w, --writelog
58 Write the gnash-dbg.log debug log to disk. By default the
59 plugin writes its log in your home directory when using a
60 launcher from GNOME or KDE.
61 .TP 
62 -j width, --width width
63 Set the width of the window. This is only used when embedding
64 the player into another window.
65 .TP 
66 -k height, --height height
67 Set the height of the window. This is only used when embedding
68 the player into another window.
69 .TP 
70 -X x-pos, --x-pos x-pos
71 Set window x position.
72 .TP 
73 -Y y-pos, --y-pos y-pos
74 Set window y position.
75 .TP 
76 -1, --once
77 Play once; exit when/if movie reaches the last frame.
78 .TP 
80 Start Gnash with a Flash debugger console so one can set
81 breakpoints or watchpoints.
82 .TP 
83 -r [0|1|2|3]
84 0 disables rendering and sound (good for batch tests).
86 1 enables rendering, disable sound.
88 2 disables rendering, enable sound.
90 3 enables rendering and sound (default setting).
91 .TP 
92 -M ffmpeg|gst, --media ffmpeg|gst
93 The media handler to use (default: ffmpeg).
94 .TP 
95 -R agg|cairo|opengl, --renderer agg|cairo|opengl
96 The renderer to use (default: agg).
97 .TP 
98 -t sec, --timeout sec
99 Timeout and exit after the specified number of seconds.
100 .TP 
101 -u url, --real-url url
102 Set "real" url of the movie (useful for downloaded movies).
103 .TP 
104 -U url, --base-url url
105 Set "base" url for this run (used to resolve relative urls,
106 defaults to movie url)
107 .TP 
108 -P param, --param param
109 Set parameter (ie. "FlashVars=A=1&b=2")
110 .TP 
111 -F x:y, --fd x:y
112 Set file descriptors to use for external communications. x is
113 use by the player to send commands to the plugin, y is used
114 by the plugin to send commands to the standalone player.
115 .TP 
116 --max-advances num
117 Exit after specified number of frame advances.
118 .TP 
119 --fullscreen
120 Start in fullscreen mode.
121 .TP 
122 --hide-menubar
123 Start without displaying the menu bar.
124 .TP 
125 --screenshot list
126 Set a list of frame advances to be saved as screenshots. The list
127 must be comma-separated. Valid values are integers and the phrase
128 "last". If "last" is specified, the final
129 frame before exit is saved. Invalid values are ignored. Frame numbers
130 apply to the sequence of frames as the SWF is executed, not the
131 frame sequence defined in the SWF. Use in combination with
132 --screenshot-file to specify output filename.
133 .TP 
134 --screenshot-file file
135 Specify the output pattern for screenshot filenames. The token %f
136 in a pattern will be replaced with a frame identifier. If you specify
137 multiple frames and do not use %f, the file will be overwritten for
138 each screenshot. If this option is not specified but screenshots
139 are requested, a default filename will be used.
140 .SS KEYS
141 .TP 
142 CTRL-Q
143 Quit/Exit.
144 .TP 
145 CTRL-W
146 Quit/Exit.
147 .TP 
148 CTRL-P
149 Toggle pause.
150 .TP 
151 CTRL-R 
152 Restart the movie.
153 .TP 
154 CTRL-L 
155 Force immediate redraw.
156 .TP 
157 CTRL-F 
158 Toggle fullscreen. ESC also exits fullscreen.
159 .TP 
160 CTRL-O 
161 Save a spontaneous screenshot. If no screenshots were requested
162 from the command line, a default filename is used. Otherwise, the
163 same filename pattern is used for requested and spontaneous
164 screenshots.
166 Flash is a registered trademark of Adobe Corporation.