terminate

Output of --help=terminate

The following help text is generated by ecflow_client --help=terminate

terminate
---------

Terminate the server.

Argument(s):

    confirm: (optional)
        # value must be "yes"; bypasses the confirmation prompt

Usage:

    --terminate=yes

The client considers, for both user and task commands, the following environment variables:

  ECF_HOST <string> [mandatory*]
    The main server hostname; default value is 'localhost'
  ECF_PORT <int> [mandatory*]
    The main server port; default value is '3141'
  ECF_SSL <any> [optional*]
    Enable secure communication between client and server.
  ECF_HOSTFILE <string> [optional]
    File that lists alternate hosts to try, if connection to main host fails
  ECF_HOSTFILE_POLICY <string> [optional]
    The policy ('task' or 'all') to define which commands consider using alternate hosts.

The options marked with (*) must be specified in order for the client to communicate
with the server, either by setting the environment variables or by specifying the
command line options.

See also

Protocol reference for CtsCmd — the request/reply payloads exchanged with the server and the C++ command class that implements this command.