Platform Information
Previous Topic  Next Topic 

Platform options describe options that are specific to each platform in an install project. When an install is built, these options are saved only in the installer for that platform.


Active

Whether or not this platform is active.


When a platform is inactive, nothing in InstallJammer will use it or affect it. Mainly this means that an installer for the inactive platform will not be built, but several other things are also disabled when a platform is inactive.  All of the properties for the platform will still be saved with your project, so a platform can easily be enabled again at a later time.


You should mark a platform as inactive if you don't plan to distribute your application for that platform.


Build Separate Archives

If this property is true, the installer for this platform will be built in separate archive files instead of being built as a single executable file.  This is useful for splitting up larger files for when installation will be done from a CD or DVD.


Default Destination Directory

The default destination directory for your application.


This is where your application will default to installing on the target system if the user does not modify the directory (or is not given the option to modify the directory).


Default Directory Permission Mask (UNIX only)

The default permission mask to use when installing directories.


When a directory is created on the target system during installation, this option tells InstallJammer the default permission mask to use when creating.  If a separate permission has been set for the directory, it will override the default permission.


Default File Permission Mask (UNIX only)

The default permission mask to use when installing files.


When a file is installed on the target system during installation, this option tells InstallJammer the default permission mask to use when installing.  If a separate permission has been set for the file, it will override the default permission.


Default Install Mode

This property sets the default install mode for the installer if the user has not specified a different mode on the command-line or if the user is not given the option to specify the mode.  This allows you to make a console or silent only installer that the user cannot use any other way.


Default Program Folder (Windows only)

The default Program Folder name under the user's menu.


This is the default Program Folder to store your application's shortcuts in on the Windows platform. If you create shortcuts in the <%ProgramFolder%> directory, this is the default name for that folder.


Default Setup Type

The default setup type chosen during installation.


If the user is allowed to change the setup type during installation, this will be the default one chosen. If the user is not allowed to change the setup type, this will be the setup type that is installed by default.


Fall Back to Console Mode (UNIX only)

This property tells InstallJammer that the (un)installer should fall back to the console mode of installation if the GUI mode fails to initialize for some reason.  This means that if the user chooses a GUI mode (or is defaulted to one), but they do not have a GUI environment, the installer will automatically detect and launch into the console install.


Include Windows API Extension (Windows only)

Whether or not to pack the TWAPI extension into your installer.


The Tcl Windows API Extension provides commands at the Tcl scripting level to some of the internal Windows APIs.  This provides the ability for you to script Windows-specific features into your installer (like services, user account commands, etc...) that would not normally be available.


Install Executable Description (Windows only)

This property describes the text to be used in the File Description field of a Windows install executable.  The default is "<%AppName%> <%Version%> Setup".


Install Executable Name

The name of your installer executable.


This is the file that InstallJammer will create when it builds your installer. The installer will be built in the build subdirectory of your project directory.


Install Program Folder for All Users (Windows only)

If this option is true, InstallJammer will create the Program Folder under the Start menu for all users of the system and not just the user installing the application.


Program Executable

The main executable for your application.


This field contains the main executable for your application. It is used throughout the install for things like creating shortcuts to your application and starting your application when the install is complete.


If your program does not have an actual program entry point, you can just leave this blank.


Program License

The LICENSE file for your application.


Your application is not required to contain a LICENSE file, but some do. If you have one, this value tells InstallJammer where to look for it when offering the user the ability to read it.


It is also appropriate, in most cases, to create a shortcut to your LICENSE file in your Program Folder.


Program Readme

The README file for your application.


Your application is not required to contain a README file, but some do. If you have one, this value tells InstallJammer where to look for it when offering the user the ability to read it.


It is also appropriate, in most cases, to create a shortcut to your README file in your Program Folder.


Prompt for Root Password

If this property is true, and Require Root User is true, the user will be asked to specify their root password to continue instead of just getting a failure message and the installer exiting.  When the user enters their root password, the installer will be restarted with the same options.


Technical Detail

InstallJammer attempts to use the given tools for the current desktop environment if available.  KDE will use kdesu.  Gnome will use gksu or gnomesu if found.  All other environments will attempt to use one of the previously-mentioned tools if found.  Finally, if none of these tools can be found, the user will either get an xterm if they are not running from a console, or it will simply ask for the password in the console if they are.


Require Administrator (Windows only)

If this property is true, the resulting installer will only work if the user is an administrator on the target Windows system.  For Vista and beyond, this means the installer is built as an executable that requires administrator privileges, and the user will be asked for an administrator password before the install is executed.  On earlier versions of Windows, the installer will check to see if the current user is in the Administrators group and will show an error message and exit if the user is not an administrator.


Require Root User (UNIX only)

Whether or not the user must install this application as root.


Some applications require a root user to install on a UNIX system.  This option tells InstallJammer that the user cannot run the install unless it is run as root.  InstallJammer will check the username during install initialization and fail with an error message if the user is not root.


Root Destination Directory (UNIX only)

The default destination directory when a user is installing as root.


In most cases, an application can either install in a system location if the user is root or into the user's home directory if the user is not root.  The root destination directory tells InstallJammer where the application should be installed if the user is installing as root.  If the user is not root, or this option is left blank, InstallJammer will fall back to the Default Destination Directory for all installs.


Note

This option does not need Require Root User.  The default destination will be adjusted if the user is root even if you don't require them to be root (unless it is blank).


Use Uncompressed Binaries (Windows only)

If this property is true, the Windows installers will be built as uncompressed binaries.  Installers built with InstallJammer are compressed using varying compression technologies for each platform.  This is an attempt to keep the installers smaller at the cost of a slight increase in startup time.  Some anti-virus software can mistakenly mark a compressed binary as having a virus when they actually don't.  For this reason, it is sometimes best to build with the original, uncompressed binaries on Windows platforms.  If you do build with uncompressed binaries, your installers will be several megabytes larger than the compressed versions.


Windows File Icon (Windows only)

The .ico to associate with your installer.  If the icon path given is a relative path, InstallJammer will first attempt to locate the .ico file in the project's own directory and then in InstallJammer's root directory.


If specified, the icon shown on Windows in the Explorer and as the main icon in the title bar of your installer will use the values in this file. You must specify an icon file that contains all of the possible size / color combinations for an icon.


A default icon is associated with installers on Windows, and some icons have been provided that meet the specifications.