file

Output of --help=file

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

file
----

Return the chosen file. Select from [ script<default> | job | jobout | manual | kill | stat ]
By default will return the script.

Argument(s):

    path: <path>
        # The path to the node

    kind: (optional) [ script<default> | job | jobout | manual | kill | stat ]
        # `script`: returns the script file, e.g., %ECF_JOB%.ecf
        # `job`: returns the pre-processed job script
        # `jobout`: returns the job output/log, e.g., %ECF_JOB%.out
        # `manual`: returns the job manual
        # `kill`: returns the output of ECF_KILL_CMD, e.g., %ECF_JOB%.kill
        # `stat`: returns the output of ECF_STATUS_CMD, e.g., %ECF_JOB%.stat

    max_lines: (optional)
        # default is 10000

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.