File: check.rst

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (52 lines) | stat: -rw-r--r-- 1,546 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

.. _check_cli:

check
*****







.. rubric:: Output of :code:`--help=check`



The following help text is generated by :code:`ecflow_client --help=check`

::

   
   check
   -----
   
   Checks the expression and limits in the server. Will also check trigger references.
   Trigger expressions that reference paths that don't exist, will be reported as errors.
   (Note: On the client side unresolved paths in trigger expressions must
   have an associated 'extern' specified)
     arg = [ _all_ | / | list of node paths ]
   Usage:
     --check=_all_           # Checks all the suites
     --check=/               # Checks all the suites
     --check=/s1 /s2/f1/t1   # Check suite /s1 and task t1
   
   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.