====== Flex Compiler ======

[[http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=compilers_123_24.html|Source]]

===== Options =====

Option
	

Description
accessible=true|false 	

Enables accessibility features when compiling the Flex application or SWC file. The default value is false.

For more information on using the Flex accessibility features, see Creating Accessible Applications in Flex 2 Developer's Guide.
actionscript-file-encoding string 	

Sets the file encoding for ActionScript files.

For more information, see Setting the file encoding.
advanced 	

Lists advanced help options when used with the help option, as the following example shows:
mxmlc -help advanced

This is an advanced option.
allow-source-path-overlap=true|false 	

Checks if a source-path entry is a subdirectory of another source-path entry. It helps make the package names of MXML components unambiguous.

This is an advanced option.
as3=true|false 	

Use the ActionScript 3.0 class-based object model for greater performance and better error reporting. In the class-based object model, most built-in functions are implemented as fixed methods of classes.

The default value is true. If you set this value to false, you must set the es option to true.

This is an advanced option.
benchmark=true|false 	

Prints detailed compile times to the standard output. The default value is true.
context-root context-path 	

Sets the value of the {context.root} token, which is often used in channel definitions in the flex-services.xml file and other settings in the flex-config.xml file. The default value is null.

For more information on using the {context.root} token, see Changing the context root.
contributor name 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
creator name 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
date text 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
debug=true|false 	

Generates a debug SWF file. This file includes line numbers and filenames of all the source files. When a run-time error occurs, the stacktrace shows these line numbers and filenames. This information is also used by the command-line debugger and the Flex Builder debugger. Enabling the debug option generates larger SWF files.

For the mxmlc compiler, the default value is false. For the compc compiler, the default value is true.

For SWC files generated with the compc compiler, set this value to true, unless the target SWC file is an RSL. In that case, set the debug option to false.

For information about the command-line debugger, see Using the Command-Line Debugger.

If you set this option to true, Flex also sets the verbose-stacktraces option to true
debug-password string 	

Lets you engage in remote debugging sessions with the Flash IDE.

This is an advanced option.
default-background-color int 	

Sets the application's background color. You use the 0x notation to set the color, as the following example shows:
-default-background-color=0xCCCCFF

The default value is null. The default background of a Flex application is an image of a gray gradient. You must override this image for the value of the default-background-color option to be visible. For more information, see Editing application settings.

This is an advanced option.
default-frame-rate int 	

Sets the application's frame rate. The default value is 24.

This is an advanced option.
default-script-limits
max-recursion-depth
max-execution-time 	

Defines the application's script execution limits.

The max-recursion-depth value specifies the maximum depth of Adobe Flash Player call stack before Flash Player stops. This is essentially the stack overflow limit. The default value is 1000.

The max-execution-time value specifies the maximum duration, in seconds, that an ActionScript event handler can execute before Flash Player assumes that it is hung, and aborts it. The default value is 60 seconds. You cannot set this value above 60 seconds.

You can override these settings in the application.

This is an advanced option.
default-size width height 	

Defines the default application size, in pixels.

This is an advanced option.
defaults-css-url string 	

Defines the location of the default style sheet. Setting this option overrides the implicit use of the defaults.css style sheet in the framework.swc file.

For more information on the defaults.css file, see Using Styles and Themes in Flex 2 Developer's Guide.

This is an advanced option.
description text 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
dump-config filename 	

Outputs the compiler options in the flex-config.xml file to the target path; for example:
mxmlc -dump-config myapp-config.xml

This is an advanced option.
es=true|false 	

Instructs the compiler to use the ECMAScript edition 3 prototype-based object model to allow dynamic overriding of prototype properties. In the prototype-based object model, built-in functions are implemented as dynamic properties of prototype objects.

The default value is false.

Using the ECMAScript edition 3 prototype-based object model lets you use untyped properties and functions in your application code. As a result, if you set the value of the es compiler option to true, you must set the strict compiler option to false. Otherwise, the compiler will throw errors.

If you set this option to true, you must also set the value of the as3 compiler option to false.

This is an advanced option.
externs symbol [...] 	

Sets a list of symbols to exclude from linking when compiling a SWF file.

This option provides compile-time link checking for external references that are dynamically linked.

For more information about dynamic linking, see About linking.

This is an advanced option.
external-library-path path-element [...] 	

Specifies a list of SWC files or directories to exclude from linking when compiling a SWF file. This option provides compile-time link checking for external components that are dynamically linked.

For more information about dynamic linking, see About linking.

You can use the += operator to append the new SWC file to the list of external libraries.
file-specs path-element 	

Specifies the source file to compile. This is the default option for the mxmlc compiler.

<< THIS OPTION IS NOW HIDDEN>>
fonts.flash-type=true|false 	

Sets the default value that determines whether embedded fonts use the FlashType rendering engine.

Setting the value of the flashType property in a style sheet overrides this value.

The default value is false.

For more information about using FlashType, see Using Fonts in Flex 2 Developer's Guide.
fonts.languages.language-range lang range 	

Specifies the range of Unicode settings for that language. For more information, see Using Styles and Themes in Flex 2 Developer's Guide.

This is an advanced option.
fonts.local-fonts-snapshot path_to_file 	

Sets the location of the local font snapshot file. The file contains system font data.

This is an advanced option.
fonts.managers manager-class [...] 	

Defines the font manager. The default is flash.fonts.JREFontManager. You can also use the flash.fonts.BatikFontManager. For more information, see Using Styles and Themes in Flex 2 Developer's Guide.

This is an advanced option.
fonts.max-cached-fonts string 	

Sets the maximum number of fonts to keep in the server cache. For more information, see Caching fonts and glyphs.

This is an advanced option.
fonts.max-glyphs-per-face string 	

Sets the maximum number of character glyph-outlines to keep in the server cache for each font face. For more information, see Caching fonts and glyphs.

This is an advanced option.
frames.frame label class_name [...] 	

Specifies a SWF file frame label with a sequence of class names that are linked onto the frame.

This option lets you add asset factories that stream in after the application that then publish their interfaces with the ModuleManager class. The advantage to doing this is that the application starts faster than it would have if the assets had been included in the code, but does not require moving the assets to an external SWF file.

This is an advanced option.
generate-frame-loader=true|false 	

Toggles the generation of an IFlexBootstrap-derived loader class.

This is an advanced option.
headless-server=true|false 	

Enables the headless implementation of the Flex compiler. This sets the following:
System.setProperty("java.awt.headless", "true")

The headless setting (java.awt.headless=true) is required to use fonts and SVG on UNIX systems without X Windows.

This is an advanced option.
help [-list [advanced]] 	

Prints usage information to the standard output. For more information, see Command-line syntax.
include-libraries library [...] 	

Links all classes inside a SWC file to the resulting application SWF file, regardless of whether or not they are used.

Contrast this option with the library-path option that includes only those classes that are referenced at compile time.

To link one or more classes whether or not they are used and not an entire SWC file, use the includes option.

This option is commonly used to specify resource bundles.
includes class [...] 	

Links one or more classes to the resulting application SWF file, whether or not those classes are required at compile time.

To link an entire SWC file rather than individual classes, use the include-libraries option.
incremental=true|false 	

Enables incremental compilation. For more information, see About incremental compilation.

This option is true by default for the Flex Builder application compiler. For the command-line compiler, the default is false. The web-tier compiler does not support incremental compilation.
keep-as3-metadata=class_name [...] 	

Specifies metadata that you want to keep.

By default, the compiler keeps the following metadata:

    * Bindable
    * Managed
    * ChangeEvent
    * NonCommittingChangeEvent
    * Transient

If you want to preserve the default metadata, you should use the += operator to append your new metadata, rather than the = operator which replaces the default metadata.

This is an advanced option.

keep-all-type-selectors=true|false
	

Instructs the compiler to keep a style sheet's type selector in a SWF file, even if that type (the class) is not used in the application. This is useful when you have a modular application that loads other applications. For example, the loading SWF file might define a type selector for a type used in the loaded (or, target) SWF file. If you set this option to true when compiling the loading SWF file, then the target SWF file will have access to that type selector when it is loaded. If you set this option to false, the compiler will not include that type selector in the loading SWF file at compile time. As a result, the styles will not be available to the target SWF file.

This is an advanced option.
keep-generated-actionscript=true|false 	

Determines whether to keep the generated ActionScript class files.

The generated class files include stubs and classes that are generated by the compiler and used to build the SWF file.

When using the application compiler, the default location of the files is the /generated subdirectory, which is directly below the target MXML file. If the /generated directory does not exist, the compiler creates one. When using the compc component compiler, the default location of the /generated directory is relative to the output of the SWC file. When using Flex Builder, the default location of the generated files is the /bin/generated directory.

The default names of the primary generated class files are filename-generated.as and filename-interface.as.

The default value is false.

This is an advanced option.
language code 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
lazy-init=true|false 	

Enables ABC bytecode lazy initialization.

The default value is false.

This is an advanced option.

<<THIS OPTION IS NOW HIDDEN>>
library-path path-element [...] 	

Links SWC files to the resulting application SWF file. The compiler only links in those classes for the SWC file that are required.

The default value of the library-path option includes all SWC files in the libs directory and the current locale. These are required.

To point to individual classes or packages rather than entire SWC files, use the source-path option.

If you set the value of the library-path as an option of the command-line compiler, you must also explicitly add the framework.swc and locale SWC files. Your new entry is not appended to the library-path but replaces it, unless you use the += operator.

On the command line, you use the += operator to append the new argument to the list of existing SWC files.

In a configuration file, you can set the append attribute of the library-path tag to true to indicate that the values should be appended to the library path rather than replace existing default entries.
license product_name license_key 	

Defines the license key to use when compiling. Valid values for product_name include fds, charting, and flexbuilder.
link-report filename 	

Prints linking information to the specified output file. This file is an XML file that contains <def>, <pre>, and <ext> symbols showing linker dependencies in the final SWF file.

The file format output by this command can be used to write a file for input to the load-externs option.

For more information on the report, see Examining linker dependencies.

This is an advanced option.
load-config filename 	

Specifies the location of the configuration file that defines compiler options.

If you specify a configuration file, you can override individual options by setting them on the command line.

All relative paths in the configuration file are relative to the location of the configuration file itself.

Use the += operator to chain this configuration file to other configuration files.

For more information on using configuration files to provide options to the command-line compilers, see About configuration files.
load-externs filename [...] 	

Specifies the location of an XML file that contains <def>, <pre>, and <ext> symbols to omit from linking when compiling a SWF file. The XML file uses the same syntax as the one produced by the link-report option. For more information on the report, see Examining linker dependencies.

This option provides compile-time link checking for external components that are dynamically linked.

For more information about dynamic linking, see About linking.

This is an advanced option.
locale string 	

Specifies the locale that should be packaged in the SWF file (for example, en_EN). You run the mxmlc compiler multiple times to create SWF files for more than one locale, with only the locale option changing.

You must also include the parent directory of the individual locale directories, plus the token {locale}, in the source-path; for example:
mxmlc -locale en_EN -source-path locale/{locale} MainApp.mxml

For more information, see Localizing Flex Applicationsin Flex 2 Developer's Guide.
localized-description text lang 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
localized-title text lang 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
namespaces.namespace uri manifest 	

Specifies a namespace for the MXML file. You must include a URI and the location of the manifest file that defines the contents of this namespace. This path is relative to the MXML file.

For more information about manifest files, see About manifest files.
optimize=true|false 	

Enables the ActionScript optimizer. This optimizer reduces file size and increases performance by optimizing the SWF file's bytecode.

The default value is false.
output filename 	

Specifies the output path and filename for the resulting file. If you omit this option, the compiler saves the SWF file to the directory where the target file is located.

The default SWF filename matches the target filename, but with a SWF file extension.

If you use a relative path to define the filename, it is always relative to the current working directory, not the target MXML application root.

The compiler creates extra directories based on the specified filename if those directories are not present.

When using this option with the component compiler, the output is a SWC file rather than a SWF file.
publisher name 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
raw-metadata XML_string 	

Defines the metadata for the resulting SWF file. The value of this option overrides any metadata.* compiler options (such as contributor, creator, date, and description).

This is an advanced option.
resource-bundle-list filename 	

Prints a list of resource bundles to input to the compc compiler to create a resource bundle SWC file. The filename argument is the name of the file that contains the list of bundles.

For more information, see Localizing Flex Applications in Flex 2 Developer's Guide.
runtime-shared-libraries url [...] 	

Specifies a list of run-time shared libraries (RSLs) to use for this application. RSLs are dynamically-linked at run time.

You specify the location of the SWF file relative to the deployment location of the application. For example, if you store a file named library.swf file in the web_root/libraries directory on the web server, and the application in the web root, you specify libraries/library.swf.

For more information about RSLs, see Using Runtime Shared Libraries.
services filename 	

Specifies the location of the services-config.xml file. This file is used by Flex Data Services.
show-binding-warnings=true|false 	

Shows a warning when Flash Player cannot detect changes to a bound property.

The default value is true.

For more information about compiler warnings, see Using SWC files.
show-actionscript-warnings=true|false 	

Shows warnings for ActionScript classes.

The default value is true.

For more information about viewing warnings and errors, see Viewing warnings and errors.
show-deprecation-warnings=true|false 	

Shows deprecation warnings for Flex components. To see warnings for ActionScript classes, use the show-actionscript-warnings option.

The default value is true.

For more information about viewing warnings and errors, see Viewing warnings and errors.
show-unused-type-selector-warnings=true|false 	

Shows warnings when a type selector in a style sheet or <mx:Style> block is not used by any components in the application.
source-path path-element [...] 	

Adds directories or files to the source path. The Flex compiler searches directories in the source path for MXML or AS source files that are used in your Flex applications and includes those that are required at compile time.

You can use wildcards to include all files and subdirectories of a directory.

To link an entire library SWC file and not individual classes or directories, use the library-path option.

The source path is also used as the search path for the component compiler's include-classes and include-resource-bundles options.

You can also use the += operator to append the new argument to the list of existing source path entries.

This option has the following default behavior:

    * If source-path is empty, the target file's directory will be added to source-path.
    * If source-path is not empty and if the target file's directory is a subdirectory of one of the directories in source-path, source-path remains unchanged.
    * If source-path is not empty and if the target file's directory is not a subdirectory of any one of the directories in source-path, the target file's directory is pre-pended to source-path.

strict=true|false 	

Prints undefined property and function calls; also performs compile-time type checking on assignments and options supplied to method calls.

The default value is true.

For more information about viewing warnings and errors, see Viewing warnings and errors.
theme filename [...] 	

Specifies a list of theme files to use with this application. Theme files can be SWC files with CSS files inside them or CSS files.

For information on compiling a SWC theme file, see Using Styles and Themes in Flex 2 Developer's Guide.
title text 	

Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files.
use-network=true|false 	

Specifies that the current application uses network services.

The default value is true.

When the use-network property is set to false, the application can access the local filesystem (for example, use the XML.load() method with file: URLs) but not network services. In most circumstances, the value of this property should be true.

For more information about the use-network property, see Applying Flex Security.
use-resource-bundle-metadata=true|false 	

Enables resource bundles. Set to true to instruct the compiler to process the contents of the [ResourceBundle] metadata tag.

The default value is true.

For more information, see Localizing Flex Applications in Flex 2 Developer's Guide.

This is an advanced option.
verbose-stacktraces=true|false 	

Generates source code that includes line numbers. When a run-time error occurs, the stacktrace shows these line numbers.

Enabling this option generates larger SWF files.

Enabling this option does not generate a debug SWF file. To do that, you must set the debug option to true.

The default value is false.
version 	

Returns the version number of the MXML compiler. If you are using a trial or Beta version of Flex, the version option also returns the number of days remaining in the trial period and the expiration date.
warn-warning_type=true|false 	

Enables specified warnings. For more information, see Viewing warnings and errors.
warnings=true|false 	

Enables all warnings. Set to false to disable all warnings. This option overrides the warn-warning_type options.

The default value is true.