Installing the Klocwork User package on Unix

From current

Installation > Installing the Klocwork User package on Unix

Contents

Before you begin

  • Before installing a new version of the Klocwork User package, uninstall the previous version.
  • Check the System requirements.
  • To control permissions when you are installing Klocwork Insight, change the value of umask.
  • To change the permissions on an existing installation, use chmod.
  • Install Klocwork software as a non-root user.
  • Linux only: There are separate installation packages for 32-bit and 64-bit Java. Make sure you select the one that matches your operating system.

Installing Klocwork User on Unix

Run the following command: 

kw-user-installer-9.5.x.x.<platform>.sh [options] <install_directory> [component ...]

where

  • <platform> is either solaris or linux
  • [<options>] are any of the options listed in Command-line options for the User package on Unix.
    Note: If you want to install the Klocwork Desktop Java Plug-in for IntelliJ IDEA, you must use the --idea-dir option.
  • <install_directory> specifies the directory in which you want to install Klocwork Insight. Note that if the chosen directory is not empty, you will not be able to continue with the installation.
  • [component ...] is any of the arguments from Arguments for User components on Unix. Separate multiple components with spaces. If you do not specify one or more components, the entire package will be installed. You can also see a list of arguments for the various components with the --list option. Note that an asterisk in the returned output means the component is already installed.

Example 1: Installing the entire Klocwork User package on Solaris

kw-user-installer-9.5.1.1.solaris.sh -a /home/jlee/klocwork

where

  • -a means that you agree to the terms of the Klocwork license
  • /home/jlee/klocwork specifies where Klocwork Insight will be installed

Example 2: Installing the Command Line Tools component on Linux

kw-user-installer.9.5.1.1.linux.sh -a /home/jlee/klocwork CommandLineTools

The example above uses:

  • -a to agree to the license without displaying the license agreement
  • /home/jlee/klocwork specifies where Klocwork Insight will be installed
  • CommandLineTools argument to install only the command-line feature from the User package.

Tip: You can specify the Klocwork Server (if you will be connecting to a server project) or the License Server (for standalone projects) during installation by using the appropriate Unix installer command-line options.

Example 3: Installing Klocwork Desktop Plug-in for Eclipse on Linux

kw-user-installer-9.5.1.1.linux.sh -a /home/jlee/ Eclipse

where

  • -a means that you agree to the terms of the Klocwork license
  • /home/jlee/Klocwork specifies where Klocwork Insight will be installed
  • Eclipse indicates that only Klocwork for Eclipse feature is to be installed

Example 4: Installing Klocwork Desktop Plug-in for IntelliJ IDEA on Linux

kw-user-installer-9.5.1.1.linux.sh -a --idea-dir "/home/jlee/JetBrains/IntelliJ IDEA 9.0" "/opt/klocwork/user 9.5" KJ_IDEA

where

  • -a means that you agree to the terms of the Klocwork license
  • "/home/jlee/JetBrains/IntelliJ IDEA 9.0" specifies where IntelliJ IDEA is installed on your machine
  • "/opt/klocwork/user 9.5" is the path to the Klocwork user install directory
  • KJ_IDEA indicates that only the Klocwork Desktop Java Plug-in for IntelliJ IDEA is to be installed

Command-line options for the User package on Unix

Name Short name Description
--agree -a agree to license terms and do not display license agreement
--force -f install without integrity checks
--help -h display this help and exit
--idea-dir   specify the directory where IntelliJ IDEA is installed (applicable only if you are installing Klocwork Insight Java Plug-in for IntelliJ IDEA)
--klocwork-server <host>[:<port>]   specify the Klocwork Server host name and port number. Default: localhost:8080.
--language <language>   specify the installation language. This affects the language of the installation package and of the help topics for reported issues. Currently, only English (United States) and Japanese are supported. The default is the current system locale; if the current system locale is not supported by Klocwork, English (United States) will be used. Note that you must install all of your Server and User packages in the same language. To specify Japanese, use ja.
To specify English, use en.
--license-server <host>[:<port>]   specify the License Server host name and port number. Default: localhost:27000
--list -l list available features (components)
--use-ssl   use a secure Klocwork Server connection
--version -v display the version of Klocwork software and exit

Arguments for User components on Unix

To install this User component (feature)... ...enter the argument...
Klocwork Architect Architect
Klocwork command line tools (for developers) CommandLineTools
Klocwork for Eclipse Eclipse
Klocwork for Java in IntelliJ IDEA (Linux only) KJ_IDEA

Installation troubleshooting for the User package

See also

Retrieved from "http://www.klocwork.com/products/documentation/current/Installing_the_Klocwork_User_package_on_Unix"