Difference between revisions of "J-Link Installer"

From SEGGER Wiki
Jump to: navigation, search
(Installation options)
 
(9 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
== Installation options ==
 
== Installation options ==
 
This section of the article describes the options that can be set prior to the installation.<br>
 
This section of the article describes the options that can be set prior to the installation.<br>
'''Note:''' This is only valid for version '''6.49a''' and onwards.<br>
+
'''Note:''' This is only valid for version '''7.94''' and on-wards.<br>
 
=== Create entry in start menu ===
 
=== Create entry in start menu ===
 
When checked, a start menu entry of the [[J-Link Software and Documentation Pack]] is created. Is selected by default.
 
When checked, a start menu entry of the [[J-Link Software and Documentation Pack]] is created. Is selected by default.
Line 29: Line 29:
 
The J-Link Installer supports command line usage since version '''6.49a'''. All options selectable in the GUI version of the installer can also be set by command line.
 
The J-Link Installer supports command line usage since version '''6.49a'''. All options selectable in the GUI version of the installer can also be set by command line.
 
=== Available command line options ===
 
=== Available command line options ===
{| class="wikitable"
+
{| class="seggertable"
 
|-
 
|-
! Command line !! Meaning !! Default !! Syntax
+
! Command line !! Meaning !! Default !! Syntax
 
|-
 
|-
| ''-InstAllUsers'' || Install for all users || ''1[[#Notes: Command line options|(*)]]'' || ''-InstAllUsers=<'''1'''/0>''
+
| ''-InstAllUsers'' || Install for all users || ''1<ref name="Admin"/>'' || ''-InstAllUsers=<1/0>''
 
|-
 
|-
| ''-CreateStartMenuEntry'' || Create a start menu entry || ''1'' || ''-CreateStartMenuEntry=<'''1'''/0>''
+
| ''-CreateStartMenuEntry'' || Create a start menu entry || ''1'' || ''-CreateStartMenuEntry=<1/0>''
 
|-
 
|-
| ''-CreateDesktopShortCut'' || Create a desktop shortcut || ''1'' || ''-CreateDesktopShortCut=<'''1'''/0>''
+
| ''-CreateDesktopShortCut'' || Create a desktop shortcut || ''1'' || ''-CreateDesktopShortCut=<1/0>''
 
|-
 
|-
| ''-UpdateExisting'' || Will uninstall the existing J-Link version in install directory prior to installation || ''1'' || ''-UpdateExisting=<'''1'''/0>''
+
| ''-UpdateExisting'' || Will uninstall the existing J-Link version in install directory prior to installation || ''0'' || ''-UpdateExisting=<1/0>''
 
|-
 
|-
| ''-Silent'' || Start installer silent. '''Note:''' DLL updater wont be called if set to ''1'' || ''0'' || ''-Silent=<'''1'''/0>''
+
| ''-Silent'' || Start installer silent. '''Note:''' DLL updater wont be called if set to ''1'' || ''0'' || ''-Silent=<1/0>''
 
|-
 
|-
  +
| ''-UpdateNotificationMode'' || Set update notification mode || ''0''<ref name="UpdateNotifModes"/> || ''-UpdateNotificationMode=<0/1/2/3>''<ref name="UpdateNotifModes"/>
!colspan="4" | The following command lines are ignored, if "-InstAllUsers=0" is set[[#Notes: Command line options|(*)]]
 
 
|-
 
|-
  +
| ''-NotifyOnSecurityUpdate'' || Notify on security updates || ''1'' || ''-NotifyOnSecurityUpdate=<1/0>''
| ''-InstUSBDriver'' || Install USB drivers || ''1'' || ''-InstUSBDriver=<'''1'''/0>''
 
 
|-
 
|-
  +
| ''-StartDLLUpdater'' || Start DLL Updater after installation || ''1'' || ''-StartDLLUpdater=<'''1'''/0>''
 
  +
!colspan="4" | The following command lines are ignored, if "-InstAllUsers=0" is set
  +
|-
  +
| ''-InstUSBDriver'' (depr.) || Install USB drivers<ref name="Admin"/><ref name="LegDrv"/>'' || ''0'' || ''-InstUSBDriver=<1/0>''
  +
|-
  +
| ''-StartDLLUpdater'' || Start DLL Updater after installation<ref name="Admin"/>'' || ''1'' || ''-StartDLLUpdater=<1/0>''
 
|-
 
|-
| ''-InstDir'' || Set the install directory || ''[[#Notes: Command line options|(**)]]'' || ''-InstDir="<Path>"''
+
| ''-InstDir'' || Set the install directory<ref name="Admin"/>'' || ''X<ref name="InstDir"/>'' || ''-InstDir="<Path>"''
 
|}
 
|}
  +
<references>
==== Notes: Command line options ====
 
'''(*)''' Requires admin rights.<br>
+
<ref name="Admin">Requires admin rights.</ref>
  +
<ref name="LegDrv">Deprecated legacy option (see: [[#USB Driver | USB Driver]]).</ref>
'''(**)''' There are 6 defaults for the install path, depending on the installer and the installer options:
 
  +
<ref name="InstDir">There are 6 defaults for the install path, depending on the installer and the installer options:
{| class="wikitable"
 
  +
{| class="seggertable"
 
|-
 
|-
 
! Presets !! 32-bit installer !! 64-bit installer
 
! Presets !! 32-bit installer !! 64-bit installer
Line 66: Line 72:
 
| ''-InstAllUsers='''0''' -UpdateExisting='''0''''' || ''%UserProfile%\SEGGER\JLink_<Version>'' || ''%UserProfile%\SEGGER\JLink_<Version>''
 
| ''-InstAllUsers='''0''' -UpdateExisting='''0''''' || ''%UserProfile%\SEGGER\JLink_<Version>'' || ''%UserProfile%\SEGGER\JLink_<Version>''
 
|}
 
|}
  +
</ref>
  +
<ref name="UpdateNotifModes">
  +
The following values are supported for ''-UpdateNotificationMode'':
  +
{| class="seggertable"
  +
|-
  +
! Value !! Description
  +
|-
  +
| 0 || Do not notify when new version is available
  +
|-
  +
| 1 || Notify when new major version is available
  +
|-
  +
| 2 || Notify when new minor version is available
  +
|-
  +
| 3 || Notify when any new version is available
  +
|}
  +
<br>
  +
{{Note|1=If update notification settings have been set prior to installation (e.g. by a previous installation), the installer will use the existing settings as defaults in order not to change systemwide settings with each installation.}}
  +
  +
</ref>
  +
</references>
  +
  +
== USB Driver ==
  +
The option to install the USB driver is not selected by default.
  +
This is because all SEGGER probes in maintenance period are using WinUSB drivers per default.
  +
The USB driver is only required for legacy probes which are out of support & maintenance period.

Latest revision as of 10:24, 27 February 2024

J-Link Installer options page

The J-Link Installer is an NSIS installer which installs the J-Link Software and Documentation Pack. The J-Link Installer can be installed for "all users" and since Version 6.49a also for "user". The latter does not require admin elevation.

Installation options

This section of the article describes the options that can be set prior to the installation.
Note: This is only valid for version 7.94 and on-wards.

Create entry in start menu

When checked, a start menu entry of the J-Link Software and Documentation Pack is created. Is selected by default.

Add shortcuts to desktop

When checked, a desktop shortcuts for J-Link Commander and J-Flash is created. Is selected by default.

Update DLL in other applications

When checked, the J-Link DLL Updater is started after installation. Requires admin rights. Starts the DLL Updater after installation. Is selected by default. Cannot be set when Install for this user only is selected.

Update existing installation OR Install a new instance

This option sets whether a J-Link Software and Documentation Pack installed prior to the same destination folder is to be uninstalled before the installation or not. By default, "Update existing installation" is selected. Uninstalls the J-Link version found in the Install directory.

Install for all users OR Install for this user only

This option sets whether the J-Link Software and Documentation Pack is installed for all users or for this user only. By default, "Install for all users" is selected.

Destination Folder

This is the folder the J-Link Software and Documentation Pack is to be installed to. It cannot be set when Install for this user only is selected. It can only be chosen whether the folder ends with _<Version> or not, by switching between Update existing and Install a new instance.
For defaults, refer to Command line options notes, (**).

Command line parameters

The J-Link Installer supports command line usage since version 6.49a. All options selectable in the GUI version of the installer can also be set by command line.

Available command line options

Command line Meaning Default Syntax
-InstAllUsers Install for all users 1[1] -InstAllUsers=<1/0>
-CreateStartMenuEntry Create a start menu entry 1 -CreateStartMenuEntry=<1/0>
-CreateDesktopShortCut Create a desktop shortcut 1 -CreateDesktopShortCut=<1/0>
-UpdateExisting Will uninstall the existing J-Link version in install directory prior to installation 0 -UpdateExisting=<1/0>
-Silent Start installer silent. Note: DLL updater wont be called if set to 1 0 -Silent=<1/0>
-UpdateNotificationMode Set update notification mode 0[2] -UpdateNotificationMode=<0/1/2/3>[2]
-NotifyOnSecurityUpdate Notify on security updates 1 -NotifyOnSecurityUpdate=<1/0>
The following command lines are ignored, if "-InstAllUsers=0" is set
-InstUSBDriver (depr.) Install USB drivers[1][3] 0 -InstUSBDriver=<1/0>
-StartDLLUpdater Start DLL Updater after installation[1] 1 -StartDLLUpdater=<1/0>
-InstDir Set the install directory[1] X[4] -InstDir="<Path>"
  1. 1.0 1.1 1.2 1.3 Requires admin rights.
  2. 2.0 2.1 The following values are supported for -UpdateNotificationMode:
    Value Description
    0 Do not notify when new version is available
    1 Notify when new major version is available
    2 Notify when new minor version is available
    3 Notify when any new version is available


    Note:
    If update notification settings have been set prior to installation (e.g. by a previous installation), the installer will use the existing settings as defaults in order not to change systemwide settings with each installation.
  3. Deprecated legacy option (see: USB Driver).
  4. There are 6 defaults for the install path, depending on the installer and the installer options:
    Presets 32-bit installer 64-bit installer
    -InstAllUsers=1 -UpdateExisting=1 %ProgramFiles(x86)%\SEGGER\JLink %ProgramFiles%\SEGGER\JLink
    -InstAllUsers=1 -UpdateExisting=0 %ProgramFiles(x86)%\SEGGER\JLink_<Version> %ProgramFiles%\SEGGER\JLink_<Version>
    -InstAllUsers=0 -UpdateExisting=1 %UserProfile%\SEGGER\JLink %UserProfile%\SEGGER\JLink
    -InstAllUsers=0 -UpdateExisting=0 %UserProfile%\SEGGER\JLink_<Version> %UserProfile%\SEGGER\JLink_<Version>

USB Driver

The option to install the USB driver is not selected by default. This is because all SEGGER probes in maintenance period are using WinUSB drivers per default. The USB driver is only required for legacy probes which are out of support & maintenance period.