updated/corrected documentation
[swftools.git] / src / png2swf.1
1 .TH png2swf "1" "February 2004" "png2swf" "swftools"
2 .SH NAME
3 png2swf - Takes a number of png files and converts them to a swf movie, one
4 picture per frame.
5
6 .SH Synopsis
7 .B png2swf [-X width] [-Y height] [-o file.swf] [-r rate] file1.png [file2.png...]
8
9 .SH DESCRIPTION
10 This tools converts png image files into an SWF animation. It takes any
11 number of input pictures, and converts them to SWF one-by-one, where every
12 converted picture is a seperate frame in the target SWF. 
13 .PP
14 The way the
15 images are encoded in SWF is very similar to PNG (in that a zlib-based, lossless
16 compression algorithm is used). Under special circumstances, when the image
17 is 32 bpp with alpha information, it is converted to (lossy) jpeg compression
18 though, to preserve the alpha, which can't be encoded in any other way in the SWF.
19
20 .SH OPTIONS
21 .TP
22 \fB\-r\fR, \fB\-\-rate\fR \fIframerate\fR
23     Set movie framerate (frames per second)
24 .TP
25 \fB\-o\fR, \fB\-\-output\fR \fIfilename\fR
26     Explicitly specify output file. (Otherwise, output will go to stdout / output.swf)
27 .TP
28 \fB\-X\fR, \fB\-\-pixel\fR \fIwidth\fR
29     Force movie width to \fIwidth\fR (default: autodetect)
30 .TP
31 \fB\-Y\fR, \fB\-\-pixel\fR \fIheight\fR
32     Force movie height to \fIheight\fR (default: autodetect)
33 .TP
34 \fB\-v\fR, \fB\-\-verbose\fR \fIlevel\fR
35     Set verbose level (0=quiet, 1=default, 2=debug)
36 .TP
37 \fB\-C\fR, \fB\-\-cgi\fR 
38     For use as CGI- prepend http header, write to stdout
39 .TP
40 \fB\-V\fR, \fB\-\-version\fR 
41     Print version information and exit