Run-Time Options

InstallShield 11 Universal » Command Line Options

The following command line options, listed alphabetically, can be used when running an installation/uninstallation. You can use these options whether you invoke the wizard directly through a Java command, or execute it using an installation launcher—the launcher passes these arguments to the wizard. When you execute the wizard using an installation launcher, additional command line options are available (see Installation Launcher Options).

Note

To add a classpath to the JAR file at run time, enter the following command:

java -cp <additionalClass> setup.jar run

where additionalClass is the file name of the class that you want to add to setup.jar when it executes, for example, myLib.zip. To add more than one classpath, separate each with a semicolon (";") if you are developing on Windows, or with a colon (":") if you are developing on UNIX, with no spaces between each classpath.

Option Purpose Example Usage
-awt Specifies to use the AWT interface mode when displaying the dialogs. This option only applies to 5.x project types; otherwise, it has no effect.
./setup.bin -awt
-condenser
(Premier Only)
Enables you to launch a project that can be condensed in condenser mode. You can specify which locales and/or platforms to include, include/exclude specific features, and specify the type of output. Both defined and custom platforms and locales can be specified.

This command contains the following options:
  • -G condenserLocales=<Java locale code>
    Multiple locale specifications are delimited with a semicolon (";")
  • -G condenserPlatforms="@@displayName=<value>;
    name=<value>;version=<value>;arch=<value>;
    parent=<display name of parent platform>"

    Platform specifications are preceded with "@@", all five properties of the platform must be specified and each is separated by a semicolon, and the platform's entire definition (the right side of the equal sign) is enclosed within double-quotes
  • -P <featureBeanID>.active=<true/false>
    Features are specified by typing their Bean ID property, and setting their Active property to either true or false to determine whether the feature should be included in the condensed, rebuilt project
  • -G condenserOutput="Single JAR"
    --OR--
    -G condenserOutput="Directory"
    Specifies whether the condensed output should be a single JAR file or directory structure

Specifying Platforms

Procedures

To determine the values of defined platform specifications:

  1. Select a feature or component in the Installation Design view Explorer window.
  2. Select its Advanced/Platform property in the Properties window.
  3. Select the platform you want to specify in the Predefined tab.
  4. Click the Custom tab—The selected platform's display name, name, version, architecture ("arch"), and parent platform values display.

    If there is optional extended information for the platform, click Extended Info in the Platform dialog box to view it. Specify that information on the command line preceded with double exclamation marks ("!!"), separating multiple ones with semicolons, as follows:
    !!<name>=<expectedValue>

    You would put them all together as follows:
    -G condenserPlatforms= "@@displayName=<value>;name=<value>;version=<value>;arch=<value>;parent=<display name of parent platform>!!<name1>=<expectedValue1>;<name2>=<expectedValue2>"
Specifying Custom Locales

To specify a custom locale, separate the language, country, and optional variant with underscores ("_"). For example:
-G condenserLocales=<language>_<country>_<variant>
To define the following (the "!!" extended information indicator is optional if the platform does not contain any Extended Info):
  • The supported Spanish and French locales
  • The AIX Power and HP-UX 11i platforms, both of which do not have any extended information
  • Exclude Feature22
java -cp setup.jar run -condenser
 -G condenserLocales=es;fr
 -G condenserPlatforms=
"@@displayName=AIX Power Platform;
name=AIX;version=.;
arch=POWER_RS\|POWER_PC\|ppc;
parent=AIX Platform!!
@@displayName=HP-UX 11i;
name=HP-UX;
version=.\.11\.11;arch=PA.RISC!!"
 -P Feature22.active=false
-console
(Premier Only)
Specifies to use the console interface mode, where messages during installation are displayed on the Java console and the wizard is run in console mode. This option overrides the Distributions' Show Console property if it is "False" and automatically includes the
-is:javaconsole Java option. This option is required to run a distribution that was set up to use a console distribution, for example, "Win32 Console Launcher" and "Windows IA64 Console Launcher."
java -cp setup.jar run -console
setupwin32Console.exe -console
-G <globalWizardProperty>="<value>" Enables you to set a "global" wizard property on the command line or in a response/options file.
java -cp setup.jar run -G replaceExistingResponse="yesToAll"
-goto <beanID> Forces the wizard to jump or "go to" the specified bean upon startup. An example of this is when the system reboots during installation and the wizard is restarted automatically. This command can only be specified once, and it takes only one argument.
java -cp setup.jar run -goto bean45
-log #
!<filename>
@<event-type>;
<event-type>
Initializes logging for the wizard. The parameters for this option have the following definitions:
  • #
    Echoes the display to standard output.
  • !<filename>
    The name of a file to save the log information in. If you specify "!" without a file name, the default log file name is used.
  • @<event-type>;<event-type>
    A list of the events to log. "ALL" enables the logging of all events; "NONE" disables logging and clears the log file.

Note

In most UNIX shells, the semicolon character (";") has a specific meaning to the OS, and results in an error when used on a command line. This problem can be avoided if the option is surrounded in single quotes (') or another escape character.

For example:

./install.bin -log
'!/home/myprojects/mylog.txt'
'@wrn;msg1'

successfully logs all wrn (warning) and msg1 messages on UNIX platforms to the mylog.txt file.
java -cp setup.jar
-log #
!/opt/projects/logfile
@ALL
run
-media #=<location> For an installation that requires multiple media, this option specifies the particular media number and location, where # represents the media number and <location> represents the path to or mounting point of that piece of media. Multiple location parameters can also be specified. Multiple instances of this command line option would be required if a silent install involved multiple media—the response/options file would contain one or more instances of this option to indicate the location of each piece of media.

Warning

This option only works with the installation JAR file; it does not work with Installation Launcher distributions.

java -cp setup.jar run
-media 1=D:/ 2=E:/ ./setup.jar
-media 1=/usr/mount1
2=/usr/mount2
-options-record <responseFileName> Specifies that Universal should automatically generate a response/options "record" type file for the project after the completion of the installation/uninstallation. There is no space between -options and -record.
java -cp setup.jar run
-options-record
recordFile.txt
-options-template <responseFileName> Specifies that Universal should automatically generate a response/options "options" type file for the project now that can be used to provide user input during an installation. There is no space between -options and -template.
java -cp setup.jar run
-options-template
templateFile.txt
-options <responseFileName> Specifies that a response/options file be used to execute the installation/uninstallation, which contains command line options, one command per line, that set specified properties for the installation. A response/options file is usually used when a silent installation is run (see the next option).
java -cp setup.jar run -options
/opt/projects/responseFile
-P <productBeanID>
.<propertyName>
(.<subproperty name>)
=<value>
Specifies properties for a product bean. The Bean ID property of the product bean is specified first, followed by the property and optional subproperty, and then the new value for the property or subproperty. This option can be specified multiple times, and can be used in Universal Installer and Universal Static Suite project types.
java -cp setup.jar run
-P bean56.displayName=SuperSoftware
-searchpath <paths separated by semicolons> Specifies additional paths to search for assembly data files (assembly.dat), which are then added to the classpath so the referenced assemblies can be found at run time. As a result, you can provide assemblies manually on the command line. If any path could include a space(s), enclose the entire path list in double-quotes, as illustrated in this example.
java –cp setup.jar
–searchpath "X:/Shared/Assemblies;
bin/my assembly directory"
-SP <subinstallerArchiveName>
.<productBeanID>
.<propertyName>
(.<subpropertyName>)=<value>
Specifies properties for a product bean within a Universal Dynamic Suite where subinstallerArchiveName represents the path to the subinstaller within the suite ("assemblies/<uuid>/<version>/assembly.dat"), followed by the Bean ID property of the product bean, followed by the property name and optional subproperty, and then the new value for the property or subproperty. This option can be specified multiple times.
java
run
-SP "assemblies/056d238eeab8af865a18de5b5ab4c72e/1.00.000/assembly.dat"
bean56.active=
false
-silent Specifies to install or uninstall the product in silent mode, where the installation/uninstallation is performed with no user interaction. This option includes the Java -is:silent option, which only prevents the display of the Launcher User Interface (UI). Using -silent results in a totally silent installation.

Note

The -silent switch basically renders all of the dialog logic useless—only the execute() method is called during a silent installation.

java -cp setup.jar run -silent
-SW <subinstallerArchiveName>
.<wizardBeanID>
.<propertyName>
(.<subpropertyName>)=<value>
Specifies properties for a wizard bean within a Universal Dynamic Suite where subinstallerArchiveName represents the path to the subinstaller within the suite ("assemblies/<uuid>/<version>/assembly.dat"), followed by the Bean ID property of the wizard bean, followed by the property name and optional subproperty, and then the new value for the property or subproperty. This option can be specified multiple times.
java
run
-SW "assemblies/056d238eeab8af865a18de5b5ab4c72e/1.00.000/assembly.dat"
bean2.contentType=text
-swing Specifies to use the Java Swing interface mode when displaying the dialogs. This option only applies if the project was built with Swing enabled; otherwise, it has no effect.
setup.exe -swing
./setup.bin -swing
-V <Variable Field Name>
=<value>
Sets the value of a Variable property, for example, a control in a dialog, the exit code and/or output of an Execute Process action, etc.
java -cp setup.jar run -V
myTextFieldVariable="yes"

-vpd <path>
(Premier Only)
Sets the location of the Vital Products Data (VPD) registry on the target machine. A relative or absolute path can be specified. If the path contains a space(s), enclose it within double-quotes. The specified path is appended to the platform-specific location.
java -cp setup.jar run -vpd "/mySoftware/Killer Apps"
-W <beanID>
.<property name>
(.<subproperty name>)
=<value>
Specifies properties for a wizard bean. The Bean ID property is specified first, followed by the property and optional subproperty, and then the new value for that property or subproperty. This option can be specified multiple times in one command.
Warning

When setting a password, the hashed password must be used. For example:

-W <passwordDialogBeanID>
.typedPasswordHash=
"<hashed password>"
java -cp setup.jar run -W bean2.contentType=text

See Also