Complex command line arguments

 

Each command line option is related to a specific event in ISL Light Client. ISL Light Client supports the following events:

  • load (triggered when ISL Light Client is loaded into memory and started),
  • connect (triggered when a connection is established between ISL Light Desk and ISL Light Client),
  • disconnect (triggered when a session is finished).

Note: Join event is only available for ISL Light Desk.

You can connect certain actions with certain events - the syntax of complex command line arguments is:

--on-<event> <action>

 

Action part must be in URL query format and is defined like this:

[destination_module]<name1>=<value1>[&<name2>=<value2...]

 

destination_module can be one of the following (please click on the module name for more information):

  • main (options for main ISL Light Client window and general ISL Light program settings)
  • desktop (commands for the desktop sharing plugin)
  • file_transfer (commands for the file transfer plugin)
  • audio (commands for the audio plugin)
  • video (commands for the video plugin)
  • recording (commands for the recording plugin)
  • customization (customization commands)
  • previews (enable various preview functionalities)

Note: If you omit the destination module, a default value main is used.

 

Main module

expand=(always|manual)
When you use expand=always on connect event, it will instruct ISL Light to always restore its window from minimized/iconized state when a new event occurs, e.g. chat is received.
When you use expand=manual on disconnect event, it will instruct ISL Light not to restore its window from minimized/iconized state when a session is terminated.
smallfootprint
Use this option to force a small footprint GUI instead of the standard ISL Light dialog.
iconize
This command instructs ISL Light to switch into the iconized state.
minimize
This command instructs ISL Light to switch into the minimized state.
logo=<path-to-logo-image>
This command instructs ISL Light to load a logo image from an existing file on the computer or from an URL address.
Important: Logo has to be in .bmp format. Maximal size for the logo is 350*80 px.
pos=([center|lefttop|rightbottom|righttop|leftbottom][(<x>,<y>)])
This command instructs ISL Light to place the main window to a specific position. Parameters x and y represent the offset towards the center of the desktop.
sticky
This command instructs ISL Light to restore the specified position each time the window state changes from minimized or iconized to restored.
open_url=<url>
This command instructs ISL Light to open the specified URL in the default web browser.
priority=(normal|high)
This command sets the ISL Light process priority to normal or high.
topmost=false
This command works for all events (usually it is used on load event so that it is effective immediately when ISL Light starts) and disables the window on top flag for ISL Light.
lock=true
Lock the computer when session ends. Only works in combination with --auto-close parameter.
check-user=true
When check-user is set to true and ISL Light receives the session code the user has to manually click "connect" to establish a session (session does not start automatically).
Example:
ISLLightClient.exe --connect [session code] --check-user true
This is useful if user has an antivirus software which runs the executable in the sandbox environment to make sure its safe. Without setting this parameter the session would be established to the sandbox computer instead of the target one.

 

Desktop sharing module

admin[=restart]
When you use this command on connect event combined with show desktop sharing, it will automatically try to switch desktop streaming to administrative mode.
If you specify admin=restart instead of just admin, it will automatically try to switch desktop streaming to administrative mode and enable the restart and resume functionality.
skip_uac=(true|false)
When you set the value to true, the User Account Control pop-up is skipped when the local user starts streaming his desktop and the streaming begins automatically.
Note: Setting applies only on machines running Windows operating systems.
Note: The streaming side has to have administrative privileges on the local machine.
show
When you use this command on connect event, it will start desktop streaming.
view
This command instructs the ISL Light not to ask the user if he wants to view the remote desktop.
control[=(grant|grantF12|disable)]
When you use this command on connect event, it grants desktop control. The grantF12 parameter is used for granting control in the compatibility (F12) mode. If you omit grant or grantF12 parameter, the default value (grant) is used.
If you specify control=disable, it is not possible to control the remote computer, only view.
topbarpos=(left|top|right|bottom)
This command is used to specify the location of the desktop streaming bar - it can be on the left, top, right or bottom side of the desktop.
Note: Desktop streaming bar can not be at the same location as the Windows task bar (usually it is at the bottom) - if you specify the same location, ISL Light will choose an alternative location. On Windows 95, Windows 98 and Windows Me you cannot set the position of the desktop streaming bar to left or right.
hidetopbar=(true|false)
If set to true, the desktop streaming bar is not shown.
black=(true|false)
This command (when set to true) instructs the ISL Light to enable black screen when desktop is being shared.
disablelocal=(true|false)
If set to true, the local user cannot take control.
leavebackground=(true|false)
If set to true, desktop background is not removed when streaming desktop.
color=64k
Use this option to switch to high quality mode (this means 64k colors, ISSC triple @60%).
events=stream_stop_close
Stops the ISL Light session automatically when desktop sharing is closed.
leave_aero=(true|false)
Windows only. By default we disable AERO composition on Windows machines in order to get better performance. Default value: false
 Example:
--on-connect desktop?leave_aero=true
leave_effects=(true|false)
Windows only. By default we disable effects on Windows in order to get better performance.
 Default value: true
 Example:
--on-connect desktop?leave_effects=true
leave_font_smoothing=(true|false)

Windows only. By default the font smoothing is left enabled
 Example:
--on-connect desktop?leave_font_smoothing=false

Note: Disabling font smoothing might cause unwanted behavior in programs running on the computer that is streaming the desktop as some programs do not deal with font smoothing being turned off while they are running. A notable example of this is Mozilla Firefox which displays a blank window if font smoothing is turned on while the program is running. Changing the browser zoom helps restore Firefox to normal behaviour.

 

File transfer module

location=<path_on_local_computer>
Use this command to change the location where the transferred files should be saved.
transfer=[<file_name1>[;<file_name2>...]]
When you use this command on connect event, the file transfer plugin will start transferring the specified file(s) - separate multiple filenames with semicolons.

 

Audio module

stream
When you use this command on connect event, it will start streaming the local audio recording.

 

Video module

stream
When you use this command on connect event, it will start streaming the local video recording.

 

Recording module

record[=silent,true]
When you use this command on connect event, it will load the recording plugin, start it and ask the remote user if he or she allows recording.
If silent or true is specified, the session will be recorded without user consent.
If silent is specified, the user will not be offered to view the recorded session after the session has finished.
Recording starts even if silent or true are not defined.
location=<path_on_local_computer>
Specify the default location where the recording files will be saved. Environment variables can also be used. Please use the following syntax for environment variables - for variable name variable_name use $[variable_name]
Example for default path with computer name used in the path:
location=x:\\recordings\\$[COMPUTERNAME]
allow_stop=false
This option will disable the user's ability to stop session recording.
name <filename>=$[HOST]-$[TIME]
You can define the file name for the recording. The default is set to Host and Time. This can be changed around depending on what criteria you wish to include in the file name.
Parameters:
$[ISLUSER]
$[GRID]
$[SESSION]
$[CODE]
These parameters can be used within the recording commands.
$[ISLUSER] defines the username of the operator from the recorded session. (Available in ISL Light 4.0.3+)
$[GRID] defines the ID of grid (Available in ISL Light 4.0.3+)
$[SESSION] defines the session id of the recorded session. (Available in ISL Light 4.0.3+)
$[CODE] defines the session code of the recorded session. (Available in ISL Light 4.0.3+)

 


Customization module

preselect_allow_remote_desktop_control=[true|false]

Allows you to set the "Allow remote desktop control" checkbox in ISL Light Client to either true or false.
Example: 
ISL_Light_Client.exe --on-load "customization?preselect_allow_remote_desktop_control=[true|false]"

Was this article helpful?