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 .SH DESCRIPTION
   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 all into a big
  16 movie. swfcombine can be used to perform the latter.
  17 .SH OPTIONS
  18 .TP
  19 \fB\-h\fR, \fB\-\-help\fR
  20 Print short help message and exit
  21 .TP
  22 \fB\-V\fR, \fB\-\-version\fR
  23 Print version info and exit
  24 .TP
  25 \fB\-o\fR, \fB\-\-output\fR \fIfilename\fR
  26 Explicitly specify output file. (otherwise, output.swf will be used)
  27 .TP
  28 \fB\-l\fR, \fB\-\-overlay\fR
  29 Don't remove any master objects, only overlay new objects.
  30 .TP
  31 \fB\-c\fR, \fB\-\-clip\fR
  32 Clip the slave objects by the corresponding master objects.
  33 .TP
  34 \fB\-d\fR, \fB\-\-dummy\fR
  35 Don't require the presence of slave objects. Usually used together with \fB\-X\fR, \fB\-Y\fR or \fB\-r\fR.
  36 .TP
  37 \fB\-v\fR, \fB\-\-verbose\fR
  38 Be verbose. Use more than one -v for greater effect.
  39 .TP
  40 \fB\-t\fR, \fB\-\-stack\fR
  41 Don't assume the first file is a master file. Instead, store each
  42 file in a seperate frame.
  43 .TP
  44 \fB\-X\fR, \fB\-\-width\fR \fIwidth\fR
  45 Force the output to width \fIwidth\fR. (Otherwise, the width of the master file will be used)
  46 .TP
  47 \fB\-Y\fR, \fB\-\-height\fR \fIheight\fR
  48 Force the output to height \fIheight\fR. (Otherwise, the height of the master file will be used)
  49 .TP
  50 \fB\-r\fR, \fB\-\-rate\fR \fIrate\fR
  51 Force the output to have the framerate \fIrate\fR. (Otherwise, the framerate of the master file will be used)
  52 .TP
  53 \fB\-x\fR, \fB\-\-xpos\fR \fIxpos\fR
  54 (move x) Adjust position of slave by xpos twips (1/20 pixel).
  55 .TP
  56 \fB\-y\fR, \fB\-\-ypos\fR \fIypos\fR
  57 (move y) Adjust position of slave by ypos twips (1/20 pixel).
  58 .TP
  59 \fB\-s\fR, \fB\-\-scale\fR \fIscale\fR
  60 (scale) Adjust size of slave by scale%
  61 .PP
  62 .SH Combining two or more .swf files using a master file
  63 Of the flash files to be combined, all except one will be packed into a sprite
  64 structure (Movieclip) which will then be inserted into the master .swf file.
  65 This means that, in terms of trees, when combining several flash files,
  66 one will form the root of the tree, while the others will be
  67 appended to the root as a subnode.
  68 The user has to specify which of the files will become the root
  69 of the tree ("master") and which will be the appended nodes ("slaves").
  70 The slave files must all have a name, which is then used to determine
  71 their exact position inside the master file.
  72 The slave files will then be converted into sprites, inserted into the
  73 master file, and all PlaceObject tags in the master file which match the
  74 name of the slave file will be updated to correctly display the slave sprite.
  75 .SH Combining (stacking) one or more .swf files without a master
  76 The flash files will be inserted in seperate frames. They will still be
  77 packed into Movieclips, therefore the outputfile will have exactly as many
  78 frames as there were inputfiles. Also, the files don't need to have names.
  79 If you want to access the Movieclips, their names are frameXX, where XX is
  80 the decimal number of the file, starting by zero (00).
  81
  82 .SH EXAMPLES
  83
  84 Create two flash movies. Insert some rectangle into one of them, and give
  85 it a name. (E.g. "foo") Now call
  86
  87 swfcombine -o combined.swf master.swf foo=slave.swf
  88
  89 As a result, the slave movie should be visible inside the master movie
  90 at the position where the rectangle used to be.
  91
  92 .SH AUTHOR
  93
  94 Matthias Kramm <kramm@quiss.org>
  95