General Command-Line Options

OptionDescription

-C

--connectiontimeout

Description

Sets a participant connection timeout interval.

Specifies the maximum length of time System Coupling will wait for a coupling participant to connect after participant connections have been requested (that is, via a Solve operation or the Initialize() command).

When used, System Coupling waits the specified interval of time, and if at the end of that interval any participant has not connected to the analysis, aborts the analysis.

Arguments

Accepts a positive real value greater than zero indicating the length of the interval in seconds. Do not enter units.

Defaults to a value of 3600 seconds – that is, a timeout interval of one hour is defined.

Usage


-C<ConnectionTimeout>

--connectiontimeout=<ConnectionTimeout>

Examples


-C120

--connectiontimeout=90

-G

--gui

Description

Starts the System Coupling GUI from the command line.

Automatically starts System Coupling in GUI Server mode, using the current directory as System Coupling's working directory.

--guiserver

Description

Starts System Coupling in GUI Server mode and writes connection information to the sycGUI.srv file. This file prevents the use of interactive input to the session being started and prevents other instances of System Coupling from being started in the same mode.

Applied automatically when the System Coupling GUI is started.

When used, the -I and --interactiveMode options are ignored and the CLI is closed after the script has run.

Required in order to connect/reconnect the System Coupling GUI to a running instance of System Coupling.

To be shut down cleanly, session started in this mode must be ended from a connected GUI instance. Otherwise, it must be shut down using an OS-specific kill request.

-h

--help

Description

Displays help on command-line startup options and then exits the command-line interface.

-I

--interactiveMode

Description

Starts System Coupling in Interactive mode.

When used with -R or --runScript, keeps the CLI open after the script has run.

This option is overridden when the --guiserver option is used to start System Coupling in GUI Server mode.

-R

--runScript

Description

Runs the specified script(s).

Arguments

Accepts a single script name.

Usage


-R<ScriptFile>

--runScript=<ScriptFile1>

To run multiple script files in succession, supply the argument multiple times.


-R <ScriptFile1> -R <ScriptFile2>

-v

--version

Description

Prints System Coupling's build information and exits.

-w

--workDirDialog

Description

When used with the -G or --gui command-line option, launches the Select working directory dialog before opening the System Coupling GUI.

The GUI then opens in the specified working directory.