kscustom.exe


Overview

kscustom.exe is a command line utility that lets you customize the Windows client installer (K2Client.exe or K2Mobile.exe) with pre-configured KeyServer DNS name (or IP address) and other custom settings. Older operating systems (e.g. Windows 95, 98, ME, and NT 4.0) will not be able to take advantage of the customized settings unless they have had MSI support added to the standard operating system - on computers without MSI support, the installer will present its usual setup dialog interface without any benefit from the customization. On Windows 2000, Windows 2003 or Windows XP, it is the embedded MSI component that actually does the install. This MSI component can be extracted as a stand-alone MSI package and used to support various client deployment strategies.

kscustom.exe is located in the \Miscellaneous\Windows Extras\ folder of the K2 image archive. Command line options are documented below along with some comments and the defaults (underlined).

kscustom.exe

Usage: kscustom [option] <msifile>

<msifile> is the file path specifying a client installer (K2Client.exe or K2Mobile.exe) or an extracted MSI file (KSClient.msi)

Command Line Options:

-d
display the msi settings from the specified installer file
-e
extract the embedded MSI package from the specified installer file. The MSI package will be created in the same folder as the specified installer file and it will be named KSClient.msi. If the specified installer file is already an MSI package, this command has no effect.
-q
do not print progress messages
-s {0|1|2|3}
set the user interface level displayed when the MSI installer is run
     0: user can change settings, and choose components to be installed
     1: user can choose components to be installed
     2: user cannot make any changes to the install parameters
     3: silent install (no interface is displayed and user cannot make changes)
-c {yes|no}
install KeyCheckout
     yes: user can choose to install KeyCheckout (default for K2Mobile.exe)
     no: user cannot install KeyCheckout (default for K2Client.exe)
-t {yes|no}
install tools (KeyVerify)
     yes: user can choose to install tools
     no: user cannot install tools
-m {yes|no}
create start menu shortcuts for KeyVerify and KeyCheckout (if installed)
     yes: start menu shortcuts will be created
     no: start menu shortcuts will not be created
-w {yes|no|win9x}
add KeyAccess to Startup folder
     yes: KeyAccess will be added to Startup folder
     no: KeyAccess will not be added to Startup folder
     win9x: KeyAccess will be added to Startup folder on Win9x
-j {yes|no}
install control panel
     yes: control panel will be installed
     no: control panel will not be installed
-g {yes|no}
add logon Run command to registry
     yes: KeyAccess will be added to Run command
     no: KeyAccess will not be added to Run command
-r {yes|no}
run KeyAccess after install
     yes: KeyAccess will be launched after install
     no: KeyAccess will not be launched by installer
-k {yes|no}
exit from running client programs
     yes: KeyAccess client programs will exit
     no: KeyAccess client programs will not exit
-n {yes|no} *
install as NT service (note: Win9x doesn't support services)
     yes: KeyAccess will be installed as a service
     no: KeyAccess will not be installed as a service
-z {user|comp}
source of value used as login name
     user: KeyAccess will use user name as login name
     comp: KeyAccess will use computer name as login name
-i {user|machine|auto}
install type
     user: per-user install
     machine: per-machine install
     auto: automatically determine install type
-x {yes|no}
add/remove visibility
     yes: display in Add/Remove Programs
     no: do not display in Add/Remove Programs
-b {yes|no|auto}
reboot after install
     yes: always prompt for a reboot after install
     no: never reboot after install
     auto: reboot if installer deems it necessary
-u {ini|hkcu|hklm}
location of preference settings
     ini: settings are stored in KEYACC.INI
     hkcu: settings are stored in HKEY_CURRENT_USER
     hklm: settings are stored in HKEY_LOCAL_MACHINE
-v name[=value]
set a specific named INI or registry preference to a custom initial value
     name is the preference name (e.g., 'minimize')
     value is the preference value ('1' if omitted)
-h <keyserver_host>
KeyServer host name or IP address (default DNS name: keyserver)
-p {udp|ipx}
udp protocol is used by default for client/keyserver connections
-y {yes|no|name:pass}
create scheduled task for server audits
     yes: create scheduled task (prompt at install time for the name and password)
     no: do not create scheduled task
     name:pass: create task using supplied name and password

*  if -n ("Install as a Service") is set to yes, the -g switch ("add logon Run command to Registry") should also be set to yes. Otherwise all usage will be reported under the single username SYSTEM.

The "-g yes" option should be sufficient to start KeyAccess on Windows 9.x computers (which don't support services). If you prefer "-g no" when installing as a service, then use the "-w win9x" option so KeyAccess will still startup on Windows 9.x computers.

Consider installing KeyAccess as a service on NT (or later) computers except in the following two cases:

  • KeyAccess cannot be installed as a service on a thin-client server (since only one instance of a service can run at a given time)
  • KeyAccess should not be installed as a service when Fast User Switching is used (so usage for distinct user sessions will be reported separately)

Help Index 2005.05.18

Related Topics

K2 Getting Started
   - Installation


Client Deployment
K2ClientConfig(Mac)
Server Audits

Help Index
?