documentation file
authorkramm <kramm>
Fri, 6 Feb 2004 15:57:36 +0000 (15:57 +0000)
committerkramm <kramm>
Fri, 6 Feb 2004 15:57:36 +0000 (15:57 +0000)
src/font2swf.doc [new file with mode: 0644]
src/jpeg2swf.doc [new file with mode: 0644]
src/png2swf.doc [new file with mode: 0644]
src/swfbbox.doc [new file with mode: 0644]
src/swfc.doc [new file with mode: 0644]
src/swfcombine.doc [new file with mode: 0644]
src/swfdump.doc [new file with mode: 0644]
src/wav2swf.doc [new file with mode: 0644]

diff --git a/src/font2swf.doc b/src/font2swf.doc
new file mode 100644 (file)
index 0000000..eb043a9
--- /dev/null
@@ -0,0 +1,23 @@
+Usage: %s <fontfile>
+
+Converts a font to SWF.
+
+Takes a font file (.ttf, .afm, .pfa, .pfb and all other types
+supported by FreeType) and converts it into a SWF file.
+.PP
+The SWF will contain the Font in SWF format (that is, a
+DefineFont2 Tag) as well as a textfield containing all the
+characters the font has. This means the resulting SWF will
+be viewable.
+
+-h, --help
+    Print short help message and exit
+-v, --verbose
+    Be verbose. Use more than one -v for greater effect.
+-o, --output <filename>
+    Write output to file <filename>.
+    Write output to file <filename>. (If not given, the output will go
+    to a file called "output.swf")
+-V, --version
+    Print version info and exit
+
diff --git a/src/jpeg2swf.doc b/src/jpeg2swf.doc
new file mode 100644 (file)
index 0000000..a2ecb82
--- /dev/null
@@ -0,0 +1,33 @@
+Usage: %s [-options [value]] imagefiles[.jpg]|[.jpeg] [...]
+
+Converts jpeg images to SWF.
+
+This tools converts jpeg image files into an SWF animation. It takes any
+number of input pictures, and converts them to SWF one-by-one, where every
+converted picture is a seperate frame in the target SWF.
+
+-o --output <outputfile>
+    Explicitly specify output file. (otherwise, output.swf will be used)
+    Explicitly specify output file. (Otherwise, output will go to stdout / output.swf)
+-m --mx         
+    Use Flash MX H.263 compression (use for correlated images)
+-q --quality <quality>
+    Set compression quality (1-100, 1=worst, 100=best)
+    Set compression quality (1-100, 1=worst, 100=best).
+    This option can be set independently for each image.
+-r --rate <framerate>     
+    Set movie framerate (frames per second)
+-X --width <width>   
+    Force movie width to <width> (default: autodetect)
+-Y --height <height>  
+    Force movie height to <height> (default: autodetect)
+-v --verbose <level> 
+    Set verbose level to <level> (0=quiet, 1=default, 2=debug)
+-V --version  
+    Print version information and exit
+
+.SH AUTHORS
+
+Rainer B√∂hme <rfxswf@reflex-studio.de>
+.TP
+Matthias Kramm
diff --git a/src/png2swf.doc b/src/png2swf.doc
new file mode 100644 (file)
index 0000000..dc2a572
--- /dev/null
@@ -0,0 +1,31 @@
+Usage: %s [-X width] [-Y height] [-o file.swf] [-r rate] file1.png [file2.png...]
+
+Takes a number of png files and converts them to a swf movie, one
+picture per frame.
+
+This tools converts png image files into an SWF animation. It takes any
+number of input pictures, and converts them to SWF one-by-one, where every
+converted picture is a seperate frame in the target SWF. 
+.PP
+The way the
+images are encoded in SWF is very similar to PNG (in that a zlib-based, lossless
+compression algorithm is used). Under special circumstances, when the image
+is 32 bpp with alpha information, it is converted to (lossy) jpeg compression
+though, to preserve the alpha, which can't be encoded in any other way in the SWF.
+
+-r, --rate <framerate>
+    Set movie framerate (frames per second)
+-o, --output <filename>
+    Set name for SWF output file.
+    Explicitly specify output file. (Otherwise, output will go to stdout / output.swf)
+-X, --pixel <width>
+    Force movie width to <width> (default: autodetect)
+-Y, --pixel <height>
+    Force movie height to <height> (default: autodetect)
+-v, --verbose <level>
+    Set verbose level (0=quiet, 1=default, 2=debug)
+-C, --cgi
+    For use as CGI- prepend http header, write to stdout
+-V, --version
+    Print version information and exit
+
diff --git a/src/swfbbox.doc b/src/swfbbox.doc
new file mode 100644 (file)
index 0000000..be44d72
--- /dev/null
@@ -0,0 +1,22 @@
+Usage: %s [-OS] file.swf
+
+Tool for playing around with SWF bounding boxes.
+
+This tool can, among others, recalculate some bounding boxes of SWFs
+in order to speed them up or make them smaller.
+.PP
+It can also dump the corners of the bounding boxes of all frames of a movie.
+
+-h, --help 
+    Print help and exit
+-O, --optimize 
+    Recalculate bounding boxes
+-S, --swifty
+    Print out transformed bounding boxes
+-o, --output <filename>
+    Set output filename to <filename> (for -O)
+-v, --verbose
+    Be more verbose
+-V, --version
+    Print program version and exit
+
diff --git a/src/swfc.doc b/src/swfc.doc
new file mode 100644 (file)
index 0000000..829fbd7
--- /dev/null
@@ -0,0 +1,19 @@
+Usage: %s [-o file.swf] file.sc
+
+compile .sc files to swf.
+
+Compiles a file written in sc (SWF Script) into a number of SWF files.
+
+-h, --help
+    Print short help message and exit
+-V, --version
+    Print version info and exit
+-v, --verbose
+    Increase verbosity. 
+    Increase verbosity. Use more than one \fB-v\fR for greater effect.
+-o, --output <filename>
+    Set output file to <filename>.
+    Specify output file (Default: output.swf). 
+    This affects only the parts of the .sc file which haven't
+    specified an output file themselves. 
+
diff --git a/src/swfcombine.doc b/src/swfcombine.doc
new file mode 100644 (file)
index 0000000..44ba1a5
--- /dev/null
@@ -0,0 +1,94 @@
+Usage: %s [-rXYomlcv] [-f] masterfile [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
+OR:    %s [-rXYomv] --stack[1] [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
+OR:    %s [-rXYov] --cat [-xysf] [(name1|#id1)=]slavefile1 .. [-xysf] [(nameN|#idN)=]slavefileN
+OR:    %s [-rXYomlcv] --dummy [-xys] [file]
+
+a tool for combining swf (flash) files
+
+Take two or more SWF files, and combine them into a new SWF. SWFs can either
+be stacked (no masterfile is present) or inserted (into the masterfile).
+.PP
+SWF files are animation files which can be displayed in Web Browsers using
+the Flash Plugin.
+.LP
+For template mechanisms, it's often convenient to separate the processes
+of generating small animation fragments and merging them into a big
+movie. swfcombine can be used to perform the latter.
+
+-o  --output  <outputfile>  
+    explicitly specify output file. (otherwise, output.swf will be used)
+-t  --stack                 
+    place each slave in a seperate frame (no master movie)
+    Don't assume the first file is a master file. Instead, store each
+    file in a seperate frame.
+-T  --stack1                
+    place each slave in the first frame (no master movie)
+-m  --merge                 
+    Don't store the slaves in Sprites/MovieClips
+    Do not store the slave files in a sprite/MovieClip. Instead, merge the files frame by frame.
+-a  --cat                   
+    concatenate all slave files (no master movie)
+-l  --overlay               
+    Don't remove any master objects, only overlay new objects
+-c  --clip                  
+    Clip the slave objects by the corresponding master objects
+-v  --verbose               
+    Be verbose. Use more than one -v for greater effect 
+-d  --dummy                 
+    Don't require slave objects (for changing movie attributes)
+    Don't require the presence of slave objects. Usually used together with \fB\-X\fR, \fB\-Y\fR or \fB\-r\fR.
+-f  --frame                 
+    The following identifier is a frame or framelabel, not an id or objectname
+    The next slave replaces a frame, not an object. Therefore the slave identifier is a
+    frame number (#frame=) or frame label (framelabel=).
+-x  --movex   <xpos>        
+    x Adjust position of slave by <xpos> pixels
+-y  --movey   <ypos>        
+    y Adjust position of slave by <ypos> pixels
+-s  --scale   <scale>       
+    Adjust size of slave by <scale> percent (e.g. 100% = original size)
+-r  --rate    <fps>   
+    Set movie framerate to <fps> (frames/sec)
+    Force the output to have the framerate <fps>. (Otherwise, the framerate of the master file will be used)
+-X  --width   <width>       
+    Force movie bbox width to <width> (default: use master width (not with -t))
+-Y  --height  <height>      
+    Force movie bbox height to <height> (default: use master height (not with -t))
+-z  --zlib    <zlib>        
+    Enable Flash 6 (MX) Zlib Compression
+    Use Flash MX (SWF 6) Zlib encoding for the output. The resulting SWF will be
+    smaller, but not playable in Flash Plugins of Version 5 and below.
+
+.PP
+.SH Combining two or more .swf files using a master file
+Of the flash files to be combined, all except one will be packed into a sprite
+structure (Movieclip) which will then be inserted into the master .swf file.
+This means that, in terms of trees, when combining several flash files,
+one will form the root of the tree, while the others will be
+appended to the root as a subnode.
+The user has to specify which of the files will become the root
+of the tree ("master") and which will be the appended nodes ("slaves").
+The slave files must all have a name, which is then used to determine
+their exact position inside the master file.
+The slave files will then be converted into sprites, inserted into the
+master file, and all PlaceObject tags in the master file which match the
+name of the slave file will be updated to correctly display the slave sprite.
+The slave name may also be the object id, preceded by '#', in which case 
+the object to be replaced is referenced by id and not by instance name.
+.SH Combining (stacking) one or more .swf files without a master
+The flash files will be inserted in seperate frames. They will still be
+packed into Movieclips, therefore the outputfile will have exactly as many
+frames as there were inputfiles. Also, the files don't need to have names.
+If you want to access the Movieclips, their names are frameXX, where XX is
+the decimal number of the file, starting by zero (00).
+
+.SH EXAMPLES
+
+Create two flash movies. Insert some rectangle into one of them, and give
+it a name. (E.g. "foo") Now call
+
+swfcombine -o combined.swf master.swf foo=slave.swf
+
+As a result, the slave movie should be visible inside the master movie
+at the position where the rectangle used to be.
+
diff --git a/src/swfdump.doc b/src/swfdump.doc
new file mode 100644 (file)
index 0000000..3d8ded7
--- /dev/null
@@ -0,0 +1,41 @@
+Usage: %s [-atpdu] file.swf
+
+Display an SWF file's content.
+
+A tool for displaying information about flash files
+.PP
+swfdump shows ids, names and depths of objects defined in the SWF file.
+It can furthermore also disassemble Actionscript, extract texts, and
+display placement information about objects.
+
+-h, --help
+    Print short help message and exit
+-D, --full
+    Show everything. Same as -atp
+-V, --version
+    Print version info and exit
+-e, --html
+    Print out html code for embedding the file
+-a, --action
+    Disassemble action tags
+-t, --text
+    Show text fields (like swfstrings).
+-p, --placements
+    Show placement information
+-X, --width
+    Prints out a string of the form "-X width".
+    Print out the horizontal dimension of the movie, in a string of the form "-X width"
+-Y, --height
+    Prints out a string of the form "-Y height".
+    Print out the vertical dimension of the movie, in a string of the form "-Y height"
+-r, --rate
+    Prints out a string of the form "-r rate".
+    Print out the frame rate of the movie, in a string of the form "-r rate".
+-f, --frames
+    Prints out a string of the form "-f framenum".
+    Print out the number of frames in the movie, in a string of the form "-f frames"
+-d, --hex
+    Print hex output of tag data, too.
+-u, --used
+    Show referred IDs for each Tag.
+
diff --git a/src/wav2swf.doc b/src/wav2swf.doc
new file mode 100644 (file)
index 0000000..7744c56
--- /dev/null
@@ -0,0 +1,49 @@
+Usage: %s [-o filename] file.wav\n
+
+convert a WAV file to an SWF animation.
+
+Takes a wav file and converts it to a swf movie.
+
+-h, --help
+Print short help message and exit
+
+-V, --version
+Print version info and exit
+
+-o, --output <filename>
+Explicitly specify output file. (Otherwise, output will go to output.swf)
+
+-r, --framerate \fIfps
+Set file framerate to \fIfps frames per second.
+    
+-s , --samplerate <sps>
+Set samplerate to sps frames per second (default: 11025).
+
+-b, --bitrate \fIbps
+Set mp3 bitrate to \fIbps.
+
+-d, --definesound
+Generate a DefineSound tag instead of streaming sound.
+Store the sound as DEFINESOUND tag, not as streaming sound. Allows for
+looping.
+
+-l, --loop \fIn
+(Only used with -d)
+Loop the sound n times.
+
+-C --cgi
+For use as CGI- prepend http header, write to stdout.
+    
+-S, --stop 
+Stop the movie at frame 0
+Stop the movie at frame 0, and start the sound at 1, so that the
+sound will not play until a "GotoFrame(1)" is issued.
+(For use with flashsound.js).
+    
+-b --bitrate <bps>
+Set mp3 bitrate to <bps> (default: 32)
+    
+-v --verbose
+Be more verbose
+Be more verbose. (Use more than one -v for greater effect)
+