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.
  arg1 = path to node
  arg2 = (optional) [ script<default> | job | jobout | manual | kill | stat ]
         kill will attempt to return output of ECF_KILL_CMD, i.e the file %ECF_JOB%.kill
         stat will attempt to return output of ECF_STATUS_CMD, i.e the file %ECF_JOB%.stat
  arg3 = (optional) max_lines = 10000 <default>

The client considers, for both user and child 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.