www.pudn.com > sswf-1.7.4-src.zip > sswf.1

.\"
.\" MAN PAGE COMMENTS
.\"
.\" Written by Alexis Wilke for Made to Order Software, Ltd. (c) 2002-2006
.\"
.if \n(zZ=1 .ig zZ
.if \n(zY=1 .ig zY
.TH SSWF 1 "2005 Jan 13" "SSWF-1.7.2"
.de }1
.  ds ]X \&\\*(]B\\
.  nr )E 0
.  if !"\\$1"" .nr )I \\$1n
.  }f
.  ll \\n(LLu
.  in \\n()Ru+\\n(INu+\\n()Iu
.  ti \\n(INu
.  ie !\\n()Iu+\\n()Ru-\w\\*(]Xu-3p \{\\*(]X
.  br\}
.  el \\*(]X\h|\\n()Iu+\\n()Ru\c
.  }f
..
.\"
.\" File Name macro.  This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
.\"
.de FN
\fI\|\\$1\|\fP
..
.SH NAME
sswf \- Compiler of the Scripting SWF Flash movies language
.SH SYNOPSIS
.B sswf
[options]
file ...
.SH DESCRIPTION
.B sswf
is a compiler which reads an
.IR "sswf script"
from one or more files
and generates a Flash movie (a .swf file).
.PP
This manual page only gives you the option flags and some other
useful information about \fIsswf\fP. It is best to read the
\fISSWF Reference\fP to understand how to write an SSWF
script. It is always up to date since I often write it at the
same time I'm adding new tags, actions, etc.
.SH OPTIONS
The following options are understood by \fBsswf\fR. It is likely
to change in the future though.
.TP
.BR \-\^c " or " \-\-compress
Request that the output movie be compressed as defined in v6.x
specifications. This is equivalent to setting the compress variable
to true in the "main" sequence.
.TP
.BR \-\^D "\fIvarname\fP[=\fIvalue\fP]"
Sets the variable \fIvarname\fP to \fIvalue\fP. When \fIvalue\fP
isn't specified, sets the variable to 1.
.TP
.BR \-\-\^debug-memory
A lot of work has been done on memory management. It should all
be freed properly on exit. If you use this option with the DEBUG
version it will force a free at the end (it takes time so you
really don't have to do it!) If it works (no crash) then you
know that the memory was properly used while \fBsswf\fP was running
and got all cleaned up. This option only appears in the
DEBUG version.
.TP
.BR \-\^e " \fIname\fP or " \-\-encoding=\fIname\fP
Defines the name of the encoding to use whenever the output
file is being generated. Note that this is ignored if the output
movie is a version 6 or more since such versions support UTF-8.
The problem of older versions (1 through 5) is that the encoding
is not specified. The best in these versions is to put the fonts
in the output file just to make sure that it works on the target
machines.
However, whenever you need to include an edit text for users to
enter some data, you probably want to specify a system font. In
that case, the strings have to have the correct encoding. This
is what this command line option is for. Of course, if you can
use a version 6 or better animation, do so! (NOTE: this option
doesn't define the encoding of input files.)
.TP
.BR \-\^h " or " \-\-help
Prints out a quick help screen about all the options supported
by \fBsswf\fP.
.TP
.BR \-\^I " [\fIpath\fP]"
Specify one or more paths to search for .sswf script files. When
used without a path, then the options requests that the internally
defined paths be ignored. Watchout, a lone \fI-I\fP should always be
followed by another option to work properly or use \fI-I-\fP instead.
.TP
.BR \-\-\^lib-version
Prints out the \fIsswf library\fP version and exit with an error.
The library version may differ from the version of the \fIsswf\fP
tool since the library is created as a shared object.
.TP
.BR \-\^o " \fIoutput\fP or " \-\-output "=\fIoutput\fP"
Defines the name of the output file. When no name is specified,
the default
.IR a.swf
is used.
.TP
.BR \-\-protect
When this is used, the output movie includes a TagProtect
tag. The movie should therefore not be editable by SWF editors.
This is not a guarantee (it is mainly for compliant editors).
This is the default. This is equivalent to setting the protect
variable to true in the "main" sequence.
.TP
.BR \-\-\^show-bounds
When you specify this flag, it asks the compiler to add a
red rectangle to draw the bounding box of each shape. This
is useful if you are guessing where to put the bounding
box and want to make sure it is at the right place.
.TP
.BR \-\-\^show-input-filenames
It can at times be useful to know exactly which files are
being loaded by a compiler. This option will print out the
filename of each of the files sswf loads as input. Files
such as the colors.sswf can be in a different directory
than the current directory (such as /usr/include/sswf/script)
and this option gives you the opportunity to know that
exact path.
.TP
.BR \-\-\^show-input-search
This option can be used to see in which directories the
input files are being searched and in which order these
paths are used. You can change the order by adding the
default path on the command line with the -I option.
.TP
.BR \-\-\^show-origin
If you need to rotate a shape, you most certainly want to
know where it's origin (center) is located. You can then
translate the shape in a sprite so you can rotate the
sprite and give the effect that the shape is rotating
properly. This flag will force all shapes to have an
origin drawn to help you place them as required.
.BR
.BR \-\-\^show-output
This flag is mainly for lower level debug purposes of \fIsswf\fP.
It will print out each node after it has been executed. I suggest
you avoid using this flag since it generates thousand of pages of
output.
.TP
.BR \-\-\^show-step "[=\fIlevel\fP]"
As the sswf compiler runs it prints out where it is at in the
compilation process. You can specify a level (1 by default) to
get more or less information. Set the level to 0 to avoid
output.
.TP
.BR \-\-uncompress
Request that the output movie be uncompressed. This is the default.
This is equivalent to setting the compress variable to false in the
"main" sequence.
.TP
.BR \-\-unprotect
When this is used, the output movie won't include a TagProtect
tag so the movie can be edited by any SWF editor. This is
equivalent in setting the protect variable to false in the
"main" sequence.
.TP
.BR \-\-\^version
Prints out the \fIsswf\fP version and exit with an error.
.SH ARGUMENTS
All the arguments which don't start with a dash (-) are taken as
file names. At this time, because
there isn't a way to #include another script within a script, the
only way to include another script is to write its name on the
command line. Thus all the necessary scripts will be named on the
command line as a long list of file names. This will very certainly
change in the future.
.SH FILES
.PD 0
.TP
.FN /bin/a.swf
When \fBsswf\fP is used without the
.BI -o
option, the system automatically saves the result in the file named
.IR a.swf .
.TP
.FN /usr/share/sswf/fonts/maps/*
Whenever it is necessary to know how to handle a font map, files in
this directory will be used. Note that these files are also used by
the ft2sswf tool. NOTE: I think the iconv library will be used
instead.
.PD
.SH "FILES"
.TP
The default include paths are (see \fB-I\fP for more info):
.br
/usr/include/sswf/scripts
.br
/usr/share/sswf/scripts
.br
/usr/share/sswf/include/scripts
.br
/usr/local/share/sswf/scripts
.br
/usr/local/share/sswf/include/scripts
.br
/sw/local/share/sswf/scripts
.br
/sw/local/share/sswf/include/scripts
.br
/opt/sswf/scripts
.br
/opt/sswf/include/scripts
.SH "SEE ALSO"
\fIAlexis' SWF Reference\fP, Alexis Wilke (\fIhttp://sswf.sourceforge.net/SWFalexref.html\fP)
.PP
\fISSWF Reference Manual\fP, Alexis Wilke (\fIhttp://sswf.sourceforge.net/ScriptSWF.html\fP)
.PP
swf_dump(1), ft2sswf(1), jpg2swf(1)
.SH BUGS
.TP
You are welcome to report bugs to me at: alexis_wilke@users.sourceforge.net
.B "Thank you in advance for the info!"
.PP
There should be an instruction used to include other scripts from a
script.
.PP
Any error output should always include a filename and line number.
.PP
Many assert()'s should be if()'s instead and return an error instead
of stopping the whole process.
.PP
Functions should return an error code instead of -1.
.SH "VERSION"
.PP
This manual page is part of version  of SSWF.
.PP
This file was last updated on .
.SH COPYRIGHT
.if n sswf is Copyright (c) 2002-2006 by Made to Order Software, Ltd.
.if t sswf is Copyright \(co 2002-2006 by Made to Order Software, Ltd.
.PP
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and
associated documentation files (the "Software"), to
deal in the Software without restriction, including
without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the
following conditions:
.PP
The above copyright notice and this permission notice
shall be included in all copies or substantial
portions of the Software.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.zZ
.zY