Application Information
Previous Topic  Next Topic 

Application Information


Application ID

A unique identifier for this application.


The Application ID is defined when the project is first created and is used to identify the application on subsequent installs to the same machine and during uninstallation.  The Application ID can be accessed with the <%ApplicationID%> vitrual text.


Application Name

The name of the application you are installing.


This name will be used throughout the install when the application name is used. It can be accessed by using the virtual text <%AppName%>.


Application URL

This is the main web address for information about your application.  This is used for information to tell users where they can find your application on the web.  The application URL can be accessed by using the <%ApplicationURL%> virtual text.


Company

Your company name.


This field can be used throughout the install as an easy way to retrieve the name of the company producing the application. By default, InstallJammer uses the company in its default install location. The company name can be accessed by using the virtual text <%Company%>.


Copyright

This property specifies your copyright notice, if any.  This will be included in the Copyright field in the resources of a Windows executable.  The copyright can be accessed by using the <%Copyright%> virtual text.


Install Icon

The icon used throughout the install.  If the icon path given is a relative path, InstallJammer will first attempt to locate the image file in the project's own directory and then in InstallJammer's root directory.


By default, all panes within the install that contain an icon use this icon, but most install themes will allow you to change the icon for each pane. If the pane is not modified, this icon will be used when applicable. The install icon can be accessed by using the virtual text <%Icon%>.


Install Image

The main image used throughout the install.  If the image path given is a relative path, InstallJammer will first attempt to locate the image file in the project's own directory and then in InstallJammer's root directory.


By default, all panes within the install that contain an image use this image, but most install themes will allow you to change the image for each pane. If the pane is not modified, this image will be used when applicable. The install image can be accessed by using the virtual text <%Image%>.


Install Version

A numeric version used by InstallJammer for your application.


Install versions are used during installation to determine what version files within the install are. This is useful for when you want to overwrite certain files that may already exist but only if the install has a higher version. The version can be accessed by using the virtual text <%InstallVersion%>.


Short Application Name

A shortened name for your application.  This is usually all lowercase and contains no spaces and is used on UNIX systems in the installation directory.  Even though most all modern UNIX systems support spaces in file and directory names, it's usually considered bad form.  The short application name can be accessed by using the virtual text <%ShortAppName%>.


Upgrade Application ID

If this property is not null, it specifies the Application ID of another install project that this project is meant to upgrade.  An upgrade installer is one that skips some of the procedures of a regular installer and adds its information to the uninstall of the previously-installed application.  This upgrade application ID can be accessed by using the <%UpgradeApplicationID%> virtual text.


Version String

The version of the application.


The version string is for you to identify the release version of your application.  InstallJammer does not use this version for anything, so it can be anything you like.  The version string can be accessed by using the virtual text <%Version%>.



Install Features


Allow Language Selection

If this property is true, the user will be allowed to select the language to use for messages during installation.  If it is false, the Default Language is always used.


Cancelled Install Action

What InstallJammer should do if an install is cancelled.


If the user cancels an install after the main installation of files has already begun, some of the application is already copied onto the system. This option lets the installer rollback any modifications that have been made by the installer since it started running.


Default Language

This property specifies the default language to use when installing.  InstallJammer will attempt to determine the best language based on the user's system settings, but if no settings can be found, this language will be the default in the language selection.  If no language selection is allowed, this default language will always be used.


Default to System Language

If this property is true, the installer will use the default language on the target system if that language has been compiled into the installer.  If the system language is not part of the installer or if this property is false, the Default Language will be used.


Enable Response File

If this property is true it will enable the --response-file and --save-response-file command-line options in your installer.  This allows a user to pass --save-response-file when running an installer and save their responses to an output file that can then be read back in during later installs using the --response-file option.  This is very handy for users who need to run an installer on multiple machines or for multiple people where it should all be run the same way.  Read more about what virtual text is included in a response file in the Add Response File Info action.


Extract Solid Archives on Startup

If this property is true, and the installer includes any solid archives, they will be extracted as soon as the installer starts up.  The user will be shown a progress bar as the archives are extracted.  This option is only useful if you need your files extracted before you begin the actual installation process.  By default, InstallJammer will extract the solid archives just before it begins the actual file installation.


Wizard Height

Specifies the height of the installer and uninstaller wizard window.  Defaults to whatever is the default for the chosen installer theme.


Wizard Width

Specifies the width of the installer and uninstaller wizard window.  Defaults to whatever is the default for the chosen installer theme.



Project Preferences


Command Line Failure Action

What InstallJammer should do if a file is missing from an install when building from the command-line.


When InstallJammer is building from the command-line (by passing a -b option), the user doesn't have the ability to recognize problems and correct them. This option specifically deals with the case that a file that should be part of the install is missing, and InstallJammer needs to know what to do.


Compression Level

Define the compression level to use when packing files.


This tells InstallJammer what level of compression to use when packing files in an installer.  1 means lower compression levels but a faster rate of packing and unpacking.  9 means higher compression but sometimes slower unpacking.  The default level is 6.


Compression Method

This specifies the default compression method to use when packing files into the installer.  The choices are:


A solid archive is when all of the files to be packaged are actually packed into a single file before they are compressed into the installer.  This has the advantage of a much higher rate of compression since the entire file is compressed at once instead of a bunch of little files compressed separately.


Solid archives cannot be read directly from within the installer though, so they must first be extracted to a temporary location before they can be installed.  This will require the target system to have a temporary location that is big enough to hold your entire, uncompressed archive before installation begins.


Technical Detail

ZLIB is the default compression method because it is fast, efficient, and it doesn't require a separate extraction step.


LZMA can be a much better compression method in some cases, but it is highly recommended that you not use lzma compression unless it is a solid archive.  LZMA compression is very slow and doesn't gain much on most files over ZLIB, but it can be a big win when using solid archives.


If you have a larger file that would benefit from LZMA compression, you can always compress just that one file by specifying the Compression Method in the file group tree.  InstallJammer can easily compress every single file in an installer with a different compression method if you want.



Default Directory Location

If this property is set, it specifies the default Location to use for all files and directories that are direct descendants of a file group if their own Location property is not set.  This allows a project to specify that every file or directory in a project should be located in a particular place on the system or relative to the project file, for example.  If a file or directory specifies its own Location, it overrides this default value.


Include Install Debugging Options

Include command-line debugging options in the install.


During testing, InstallJammer includes a small set of debugging options that can be passed to installs on the command-line. These options allow the install builder to debug their install while it is running.


Note

Debugging options should be turned off before distributing a release of your installer.  This can be done by disabling this option or by building your installs for final release.


Preserve UNIX File Permissions

If this property is true, InstallJammer will record the current file permissions on each file and directory stored in the installer and restore them when they are installed.  Any permissions which have been set for a file or directory in the project will override these permissions, but by default, the permissions recorded on the build system will be restored on the target install system.


Preserve Windows File Attributes

If this property is true, InstallJammer will remember the file attributes on each file and directory stored in the installer and restore them when they are installed.  Any attributes which have been set for a file or directory in the project will override these attributes, but by default, the attributes recorded on the build system will be restored on the target install system.


Refresh File List Before Building

If this property is true, InstallJammer will automatically search for new and deleted files in directories before building any installers.  This will automatically pick up any changes made to the directories in your installer before the new installers are built.


Save Only Toplevel Directories

This option tells InstallJammer that you only want to save the files and directories that are a direct child of a file group.  This means that directories in a file group will not be saved recursively.  This option is useful for building projects dynamically using command-line tools where you don't want the GUI builder to save the files for you.


File Groups and Directories in a project have a Save Files property which basically acts as a finer-grained version of this property.  You can set that a particular File Group or directory should not save its files instead of the entire project.


Note

Saving only toplevel directories should be used with caution.  Any change you make to any file or directory that is not a toplevel will be lost since it will not be saved in the install project.



Skip Unused File Groups

If this property is true, it means that InstallJammer will skip any file groups it finds that are not being used by a component.  This can be an easy way of disabling an entire file group without removing it from the project.  If this property is false, all file groups will be included in the installer regardless of whether they are used.