added swfrender dependency
[swftools.git] / src / swfcombine.doc
1 Usage: %s [-rXYomlcv] [-f] masterfile [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
2 OR:    %s [-rXYomv] --stack[1] [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
3 OR:    %s [-rXYov] --cat [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
4 OR:    %s [-rXYomlcv] --dummy [-xys] [file]
5
6 a tool for combining swf (flash) files
7
8 Take two or more SWF files, and combine them into a new SWF. SWFs can either
9 be stacked (no masterfile is present) or inserted (into the masterfile).
10 .PP
11 SWF files are animation files which can be displayed in Web Browsers using
12 the Flash Plugin.
13 .LP
14 For template mechanisms, it's often convenient to separate the processes
15 of generating small animation fragments and merging them into a big
16 movie. swfcombine can be used to perform the latter.
17
18 -o  --output  <outputfile>  
19     explicitly specify output file. (otherwise, output.swf will be used)
20 -t  --stack                 
21     place each slave in a seperate frame (no master movie)
22     Don't assume the first file is a master file. Instead, store each
23     file in a seperate frame.
24 -T  --stack1                
25     place each slave in the first frame (no master movie)
26 -m  --merge                 
27     Don't store the slaves in Sprites/MovieClips
28     Do not store the slave files in a sprite/MovieClip. Instead, merge the files frame by frame.
29 -a  --cat                   
30     concatenate all slave files (no master movie)
31 -l  --overlay               
32     Don't remove any master objects, only overlay new objects
33 -c  --clip                  
34     Clip the slave objects by the corresponding master objects
35 -v  --verbose               
36     Be verbose. Use more than one -v for greater effect 
37 -d  --dummy                 
38     Don't require slave objects (for changing movie attributes)
39     Don't require the presence of slave objects. Usually used together with \fB\-X\fR, \fB\-Y\fR or \fB\-r\fR.
40 -f  --frame                 
41     The following identifier is a frame or framelabel, not an id or objectname
42     The next slave replaces a frame, not an object. Therefore the slave identifier is a
43     frame number (#frame=) or frame label (framelabel=).
44 -x  --movex   <xpos>        
45     x Adjust position of slave by <xpos> pixels
46 -y  --movey   <ypos>        
47     y Adjust position of slave by <ypos> pixels
48 -s  --scale   <scale>       
49     Adjust size of slave by <scale> percent (e.g. 100% = original size)
50 -r  --rate    <fps>   
51     Set movie framerate to <fps> (frames/sec)
52     Force the output to have the framerate <fps>. (Otherwise, the framerate of the master file will be used)
53 -X  --width   <width>       
54     Force movie bbox width to <width> (default: use master width (not with -t))
55 -Y  --height  <height>      
56     Force movie bbox height to <height> (default: use master height (not with -t))
57 -z  --zlib    <zlib>        
58     Enable Flash 6 (MX) Zlib Compression
59     Use Flash MX (SWF 6) Zlib encoding for the output. The resulting SWF will be
60     smaller, but not playable in Flash Plugins of Version 5 and below.
61
62 .PP
63 .SH Combining two or more .swf files using a master file
64 Of the flash files to be combined, all except one will be packed into a sprite
65 structure (Movieclip) which will then be inserted into the master .swf file.
66 This means that, in terms of trees, when combining several flash files,
67 one will form the root of the tree, while the others will be
68 appended to the root as a subnode.
69 The user has to specify which of the files will become the root
70 of the tree ("master") and which will be the appended nodes ("slaves").
71 The slave files must all have a name, which is then used to determine
72 their exact position inside the master file.
73 The slave files will then be converted into sprites, inserted into the
74 master file, and all PlaceObject tags in the master file which match the
75 name of the slave file will be updated to correctly display the slave sprite.
76 The slave name may also be the object id, preceded by '#', in which case 
77 the object to be replaced is referenced by id and not by instance name.
78 .SH Combining (stacking) one or more .swf files without a master
79 The flash files will be inserted in seperate frames. They will still be
80 packed into Movieclips, therefore the outputfile will have exactly as many
81 frames as there were inputfiles. Also, the files don't need to have names.
82 If you want to access the Movieclips, their names are frameXX, where XX is
83 the decimal number of the file, starting by zero (00).
84
85 .SH EXAMPLES
86
87 Create two flash movies. Insert some rectangle into one of them, and give
88 it a name. (E.g. "foo") Now call
89
90 swfcombine -o combined.swf master.swf foo=slave.swf
91
92 As a result, the slave movie should be visible inside the master movie
93 at the position where the rectangle used to be.
94