Initializing help system before first use

Command Prompt Options

There are two tiers of options: the first set are used by the installer, the second are forwarded by the installer to the built-in Windows application msiexec.exe which handles the bulk of the installation process.

Available Options When Using the Installer

Option Description
/? Show all the available options
/x Uninstall the application
/s Suppress the initial UI (For more, see Silent Installations)

Available Options When Using msiexec.exe

Option Description
"/v /?" Show all the available options
"/v /quiet" Silent installation (For more, see Silent Installations)
"/v /L \" path\to\logfile \" " Default logging
"/v /Log \" path\to\logfile \" " More detailed logging
"/v INSTALLDIR=\" path\to\install \dir\" " Override installation directory
"/v ADDLOCAL= Features " Select which features to add (see below)
"/v REMOVE= Features " Select which features to remove
While the various "/v" options can be used separately, and are documented this way in the previous tables, it is best practice to combine them into a single quoted section. For example, a silent install which has detailed logging and an overridden installation location could have the following options:
/s "/v /quiet /Log \"logfile.txt\" INSTALLDIR=\"c:\MyInsight\" "
Note
  • There are many other options available to both the installer and msiexec.exe. Only use the recommended options listed above. Care should be taken when using any other options.

  • Backslashes are only required before a quote; a sequence of backslashes are required immediately before a quote, inside a quoted section. The command-line is split into tokens, when using backslashes and quotes. For more, see the documentation for the Windows API function CommandLineToArgvW.

  • Given the complexity of nested arguments, be aware of your shell or scripting language's rules on variable interpolation, escaping etc to avoid producing a malformed command-line.
  • As with the installer UI, only the destination for the application code can be set via INSTALLDIR=; the application data will be installed to the Common Application Data area, which can be found in the environment variable PROGRAMDATA.

  • On a command-prompt or Windows batch file, the system will not wait for the installer to finish before continuing. To force it to wait in a batch file, place the call directive at the very start of the command-line (before the path to the installer). In this case, the if errorlevel conditional logic and the %errorlevel% pseudo-environment variable can be used with the return code of the installer in the usual manner. Note that the return code might be negative in case of failure.