src/swfcombine.1

   1 .TH swfcombine "1" "October 2001" "swfcombine" "swftools"
   2 .SH NAME
   3 swfcombine - a tool for combining swf (flash) files
   4 .SH Synopsis
   5 .B swfcombine
   6 [\fIoptions\fR] [\fImasterfile.swf\fR] [\fIslavename1=\fR][\fIslavefile1.swf\fR] ... [\fIslavenameN=\fR][\fIslavefileN.swf\fR]
   7
   8 .B swfcombine
   9 [\fIoptions\fR] [\fImasterfile.swf\fR] [\fI#id1=\fR][\fIslavefile1.swf\fR] ... [\fI#idN=\fR][\fIslavefileN.swf\fR]
  10
  11 .B swfcombine
  12 [\fIoptions\fR] --stack [\fIslavename1=\fR][\fIslavefile1.swf\fR] ... [\fIslavenameN=\fR][\fIslavefileN.swf\fR]
  13
  14 .B swfcombine
  15 [\fIoptions\fR] --cat [\fIslavename1=\fR][\fIslavefile1.swf\fR] ... [\fIslavenameN=\fR][\fIslavefileN.swf\fR]
  16
  17 .B swfcombine
  18 [\fIoptions\fR] --dummy [\fIfile.swf\fR]
  19 .SH DESCRIPTION
  20 Take two or more SWF files, and combine them into a new SWF. SWFs can either
  21 be stacked (no masterfile is present) or inserted (into the masterfile).
  22 .PP
  23 SWF files are animation files which can be displayed in Web Browsers using
  24 the Flash Plugin.
  25 .LP
  26 For template mechanisms, it's often convenient to separate the processes
  27 of generating small animation fragments and merging them into a big
  28 movie. swfcombine can be used to perform the latter.
  29 .SH OPTIONS
  30 .TP
  31 \fB\-h\fR, \fB\-\-help\fR
  32 Print short help message and exit
  33 .TP
  34 \fB\-V\fR, \fB\-\-version\fR
  35 Print version info and exit
  36 .TP
  37 \fB\-o\fR, \fB\-\-output\fR \fIfilename\fR
  38 Explicitly specify output file. (otherwise, output.swf will be used)
  39 .TP
  40 \fB\-z\fR, \fB\-\-zlib\fR
  41 Use Flash MX (SWF 6) Zlib encoding for the output. The resulting SWF will be
  42 smaller, but not playable in Flash Plugins of Version 5 and below.
  43 .TP
  44 \fB\-l\fR, \fB\-\-overlay\fR
  45 Don't remove any master objects, only overlay new objects.
  46 .TP
  47 \fB\-c\fR, \fB\-\-clip\fR
  48 Clip the slave objects by the corresponding master objects.
  49 .TP
  50 \fB\-m\fR, \fB\-\-merge\fR
  51 Do not store the slave files in a sprite/MovieClip. Instead, merge the files frame by frame.
  52 .TP
  53 \fB\-d\fR, \fB\-\-dummy\fR
  54 Don't require the presence of slave objects. Usually used together with \fB\-X\fR, \fB\-Y\fR or \fB\-r\fR.
  55 .TP
  56 \fB\-v\fR, \fB\-\-verbose\fR
  57 Be verbose. Use more than one -v for greater effect.
  58 .TP
  59 \fB\-t\fR, \fB\-\-stack\fR
  60 Don't assume the first file is a master file. Instead, store each
  61 file in a seperate frame.
  62 .TP
  63 \fB\-a\fR, \fB\-\-cat\fR
  64 Like -t, but concatenate the files.
  65 .TP
  66 \fB\-X\fR, \fB\-\-width\fR \fIwidth\fR
  67 Force the output to width \fIwidth\fR. (Otherwise, the width of the master file will be used)
  68 .TP
  69 \fB\-Y\fR, \fB\-\-height\fR \fIheight\fR
  70 Force the output to height \fIheight\fR. (Otherwise, the height of the master file will be used)
  71 .TP
  72 \fB\-r\fR, \fB\-\-rate\fR \fIrate\fR
  73 Force the output to have the framerate \fIrate\fR. (Otherwise, the framerate of the master file will be used)
  74 .TP
  75 \fB\-f\fR, \fB\-\-frame\fR
  76 The next slave replaces a frame, not an object. Therefore the slave identifier is a
  77 frame number (#frame=) or frame label (framelabel=).
  78 .TP
  79 \fB\-x\fR, \fB\-\-xpos\fR \fIxpos\fR
  80 (move x) Adjust position of slave by xpos twips (1/20 pixel).
  81 .TP
  82 \fB\-y\fR, \fB\-\-ypos\fR \fIypos\fR
  83 (move y) Adjust position of slave by ypos twips (1/20 pixel).
  84 .TP
  85 \fB\-s\fR, \fB\-\-scale\fR \fIscale\fR
  86 (scale) Adjust size of slave by scale%
  87 .PP
  88 .SH Combining two or more .swf files using a master file
  89 Of the flash files to be combined, all except one will be packed into a sprite
  90 structure (Movieclip) which will then be inserted into the master .swf file.
  91 This means that, in terms of trees, when combining several flash files,
  92 one will form the root of the tree, while the others will be
  93 appended to the root as a subnode.
  94 The user has to specify which of the files will become the root
  95 of the tree ("master") and which will be the appended nodes ("slaves").
  96 The slave files must all have a name, which is then used to determine
  97 their exact position inside the master file.
  98 The slave files will then be converted into sprites, inserted into the
  99 master file, and all PlaceObject tags in the master file which match the
 100 name of the slave file will be updated to correctly display the slave sprite.
 101 The slave name may also be the object id, preceded by '#', in which case
 102 the object to be replaced is referenced by id and not by instance name.
 103 .SH Combining (stacking) one or more .swf files without a master
 104 The flash files will be inserted in seperate frames. They will still be
 105 packed into Movieclips, therefore the outputfile will have exactly as many
 106 frames as there were inputfiles. Also, the files don't need to have names.
 107 If you want to access the Movieclips, their names are frameXX, where XX is
 108 the decimal number of the file, starting by zero (00).
 109
 110 .SH EXAMPLES
 111
 112 Create two flash movies. Insert some rectangle into one of them, and give
 113 it a name. (E.g. "foo") Now call
 114
 115 swfcombine -o combined.swf master.swf foo=slave.swf
 116
 117 As a result, the slave movie should be visible inside the master movie
 118 at the position where the rectangle used to be.
 119
 120 .SH AUTHOR
 121
 122 Matthias Kramm <kramm@quiss.org>
 123