id

String

Required. The bundle identifier of the application.

alignment

String

Optional. The alignment used to render the background image. Values: center (default), left, right, top, bottom, topleft, topright, bottomleft, and bottomright.

Only used by the Installer.

file

String

Required. The filename of an image in the distribution package—for example, background.png or ./background.png.

mime-type

String

The standard MIME type of the image.

scaling

String

Optional. The scaling used to render the background image. Values: tofit (default), none, and proportional.

uti

String

The UTI type of the image. This attribute is provided because some file types don’t have a MIME type.

CFBundleShortVersionString

String

Optional. The short version string of the bundle, as defined in its Info.plist file.

CFBundleVersion

String

Optional. The bundle’s version, as defined in its Info.plist file.

id

String

Required. The identifier of the bundle—that is, the value of CFBundleIdentifier in the bundle’s Info.plist file.

path

String

Required. The path at which the bundle is installed, relative to where the package is installed. For example, Applications/Sample.app.

search

Boolean

Optional. Indicates whether to search for the bundle by its identifier if it is not found at the given path. Values: false (default), true.

Only valid when this element is a child of a required-bundles element.

BuildVersion

-

Reserved.

SourceVersion

-

Reserved.

customLocation

Absolute file path

Optional. Specifies the default installation location, within the installation volume, for this choice. Implies that the user can choose a different installation location. If unspecified, the user cannot choose the installation location for this choice.

customLocationAllowAlternateVolumes

Boolean

Optional if customLocation is specified; otherwise, not allowed. Specifies whether the user can choose the installation volume. Values: false (default) indicates that the user can choose a different location than what is given by customLocation but cannot change the volume; true indicates that the user can choose the installation volume and the location on that volume. A value of true is only valid for packages that use the Installer.

description

String, localization key

Required for packages that use the Installer; otherwise, optional. Specifies the description of the installation choice. Localizable.

description-mime-type

String

Optional. The MIME type of the text data in the description attribute. Values: text/plain (default), text/rtf, or text/html.

enabled

Boolean JavaScript expression

Optional. Specifies whether the user can select or deselect this option in the Installer customization pane. If false, or a JavaScript expression that evaluates to false, the choice is dimmed so the user cannot select or deselect it. Re-evaluated as the user interacts with the choice tree, so a choice can be enabled or disabled based on the state of other choices. Default value is true.

id

String

Required. Unique identifier of the installation choice, used to bind this element to the line element that determines its position in the installation-choice hierarchy.

Must match the choice attribute of exactly one line element.

selected

Boolean JavaScript expression

Optional. Specifies whether this option is selected or deselected for installation. If false, or a JavaScript expression that evaluates to false, the choice will not be installed. In general, you should not declare this attribute on a choice that is visible and enabled, because it can interfere with the user’s selections. Default value is true.

start_enabled

Boolean

Optional. Specifies whether this option is initially enabled in the Installer customization pane. Values: true (default), or false.

start_selected

Boolean

Optional. Specifies whether this option is initially selected or deselected for installation. Values: true (default), or false.

start_visible

Boolean

Optional. Specifies whether this option is initially visible in the Installer customization pane. Values: true (default), or false.

title

String, localization key

Required. Specifies the title of the installation choice. Localizable.

visible

Boolean JavaScript expression

Optional. Specifies whether this option is visible in the Installer customization pane. If false, or a JavaScript expression that evaluates to false, the choice is hidden from the user. Default value is true.

Avoid making choices appear and disappear while the user is interacting with the installation process. This provides a poor user experience.

bundle

-

Reserved.

customLocationIsSelfContained

-

Reserved.

tooltip

-

Reserved.

versStr

-

Reserved.

ui

-

Reserved.

file

String

Required. The filename of the conclusion file in the distribution package—for example, conclusion.rtf.

mime-type

String

The MIME-type specifier for the data contained in the file.

uti

String

The UTI-type specifier for the data contained in the file.

language

-

Reserved.

enable_anywhere

Boolean JavaScript expression

Required. If true, or a JavaScript expression that evaluates to true, the product can be installed at the root of any volume, including nonsystem volumes. Otherwise, it cannot be installed at the root of a volume.

enable_currentUserHome

Boolean JavaScript expression

Required. If true, or a JavaScript expression that evaluates to true, the product can be installed into the current user’s home directory. Otherwise, it cannot be installed in the current user’s home directory.

A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory. You should enable this only if the product can be installed in the user’s home directory and be completely functional from that location.

enable_localSystem

Boolean JavaScript expression

Required. If true, or a JavaScript expression that evaluates to true, the product can be installed into the root directory. This attribute should usually be true unless the product can be installed only to the user’s home directory.

script

Boolean JavaScript expression

Optional. Specifies whether the requirements are met. If true (default), or a Boolean JavaScript expression that evaluates to true, the installation proceeds, subject to the other checks.

If the script evaluates to false, it must also set my.result.type and my.result.message to indicate the severity of the problem and provide a message to display. If my.result.type is Warning, the installation may be allowed to proceed after informing the user.

minSpecVersion

Integer

Required. The schema version of a distribution file. Use 1 for the version used prior to OS X v10.6.6, or 2 after that.

maxSpecVersion

-

Reserved.

verifiedSpecVersion

-

Reserved.

file

String

Required. The filename of the welcome file in the distribution package—for example, welcome.rtf.

mime-type

String

The MIME-type specifier for the data contained in the file.

uti

String

The UTI-type specifier for the data contained in the file.

auto

-

Reserved.

language

-

Reserved.

sla

-

Reserved.

choice

String

Required. Identifies the installation choice associated with this node of the installation-choice hierarchy of a distribution package. The value must match the ID of a choice element. See choice.

Do not reference the same ID from more than one line element, not even from different installation-choice hierarchies; if you do so, the behavior is undefined.

allow-external-scripts

Boolean

Optional. Specifies whether the run and runOnce JavaScript functions can be executed. Values: false (default) or true. For information about these functions, see System in Installer JavaScript Reference.

customize

String

Optional. Specifies whether the user can customize the installation by selecting or deselecting installation choices. Values:

allow (default) gives the user an opportunity to customize the installation, always presents the customization view automatically.

never does not provide access to the customization view.

hostArchitectures

String

Optional. A comma-separated list of supported architecture codes. Valid codes are i386, x86_64, and ppc. Note that i386 matches both 32-bit and 64-bit systems, but x86_64 matches only 64-bit systems.

mpkg

String

Optional. Identifies a package (pkg-ref element) whose installation operations must be performed as part of the installation of this distribution.

Deprecated.

require-scripts

Boolean

Optional. Indicates whether the distribution uses JavaScript code. Values: true (default) or false. If this value is false, all attributes whose value may be a JavaScript expression must be set to either true or false.

Available in OS X v10.6.6 and later.

rootVolumeOnly

Boolean

Optional. Specifies whether the user can choose an installation volume other than the boot volume. Values: true or false.

Deprecated. Use domains instead.

type

-

Reserved.

visibleOnlyForPredicate

-

Reserved.

before

String

Optional. The maximum allowed version (exclusive). If the OS version is greater than or equal to this version, installation will be disallowed (unless the OS falls in the range of another os-version element). If no value is given, there is no upper bound on the range—any version newer than the minimum is allowed.

min

String

Required. The minimum allowed version (inclusive). If the OS is less than this version, installation will be disallowed (unless the OS falls in the range of another os-version element).

active

Boolean JavaScript expression

Optional. Indicates whether the package is installed. Values: true (default), false.

If false, or a JavaScript expression that evaluates to false, the package is not installed, even if its associated choice was selected.

This provides an additional way to activate and deactivate packages. It overrides the setting on the parent element.

auth

String

Defines the authorization level needed to install this package. Values: none or root.

Deprecated. The installation domain determines the necessary authorization level.

id

String

Required. Uniquely identifies a component package within a distribution package—for example, com.apple.TextEdit.pkg. The value of this attribute is usually the same as the component package’s identifier, but it is not required to be the same.

If there are multiple pkg-ref elements with the same ID, their attributes will be collapsed together as if they were specified with a single element. In particular, a pkg-ref element with only an ID can be used inside of a choice element to bind that choice to a pkg-ref that is more fully defined elsewhere in the distribution file.

installKBytes

Integer

Optional. Specifies the size of the package’s payload in kilobytes.

You typically omit this attribute because productbuild sets it from the actual package when the product archive is created.

onConclusion

String

Optional. Specifies the action to take after the installation has finished. Values, from lowest to highest: None (default), RequireLogout, RequireRestart, or RequireShutdown.

The Installer takes the highest value from all enabled packages and requires the associated action.

onConclusionScript

String

Optional. A JavaScript expression that evaluates to one of the string values expected for onConclusion. If this attribute is present, any onConclusion attribute is ignored.

Available in OS X v10.7 and later.

version

String

Required. Specifies the version of the package’s payload.

You typically omit this attribute because productbuild will set it from the actual package when the product archive is created.

archiveKBytes

-

Reserved.

packageIdentifier

-

Reserved.

id

String

Required. The top-level product identifier. The value should be the same as the bundle identifier of the contained application.

version

String

Required. The version string for the top-level product. The value should be the same as the short version string of the contained application.

min-gb

String

Required. The minimum required RAM in gigabytes.

(Consistent with how sizes are displayed in OS X v10.6 and later, a gigabyte is defined as 10⁹ bytes, not 2³⁰ bytes.)

file

String

Required. The filename of the readme file in the distribution package. For example, readme.rtf.

mime-type

String

The MIME-type specifier for the data contained in the file.

uti

String

The UTI-type specifier for the data contained in the file.

language

-

Reserved.

search-id

String

Required. Specifies the ID of the search element whose results are applied to the bundle that is this element’s child element.

If the search returns false, the relocate does nothing. If the search returns an array of results, the first result is used.

all

Boolean

Optional. Values: true (default) to require all of the specified bundles, or false to require at least one of them.

description

String, localization key

Optional. A description of the required bundles, displayed to the user if the requirement is not met.

description

String, localization key

Optional. A description of the graphics requirement. Localizable.

If no description is specified, a generic message is used. It is generally best to use the generic message unless the requirements are very straightforward.

single-device

Boolean

Optional. Values: false (default) to allow the OpenCL and OpenGL requirements to be met by different devices, or true to require a single device to simultaneously meet both requirements.

language

-

Reserved.

id

String

Required. Uniquely identifies the search; used in the search-id attribute of other elements to reference this search.

script

String

Required if type is script; otherwise, not allowed.

A JavaScript expression that evaluates to false, a path as a string, or an array of paths. If it returns an array of paths, the first one is the preferred path.

This expression can be a function call, but the called function must be defined in the child script element.

search-id

String

Optional if type is component; otherwise, not allowed.

The ID of another search. The other search is performed, and its results further filtered by removing those results that don’t match the version strings given by the child bundle element. This allows the other search to be qualified for certain values of CFBundleShortVersionStrings or CFBundleVersions.

search-path

String

Optional if type is component; otherwise, not allowed.

A path to a bundle. If there is a bundle at this path that matches the version string of this element’s child bundle element, then the path is used as the search result.

type

String

Required. Indicates the type of the search. Valid values are:

component Search for a bundle on disk that matches the identifier and version strings given by the child bundle element. By default, the Installer uses Launches Services to perform the search, and it searches only the volume that the user selected as the installation target. The search-id and search-path attributes modify this behavior.

script Search by evaluating the JavaScript code contained in the script attribute.

script

Boolean JavaScript expression

Required. Specifies whether the requirements for installing on a particular volume are met.

If the script evaluates to false, it must also set my.result.type and my.result.message to indicate the severity of the problem and provide a message to display.

The property my.target.mountpoint contains the mount point of the volume being checked.

file

String

Required. The filename of the welcome file in the distribution package—for example, welcome.rtf.

mime-type

String

The MIME-type specifier for the data contained in the file.

uti

String

The UTI-type specifier for the data contained in the file.

language

-

Reserved.