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