File: alter.description

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 (26 lines) | stat: -rw-r--r-- 1,288 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

The CLI command :code:`alter` enables the manipulation of node attributes in
an ecFlow suite, namely it allows to:

 - add new node attributes
 - remove existing node attributes
 - update some characteristics of existing node attributes
 - set/clear node flags
 - sort node attributes

The arguments to the :code:`alter` command are specified as a sequence of space
separated options:

.. code-block:: shell

    ecflow_client --alter <operation> <type> <name> <value> <path>

where

 - :code:`<operation>`, determines what operation is performed (one of :code:`delete`, :code:`change`, :code:`add`, :code:`set_flag`, :code:`clear_flag`, or :code:`sort`)
 - :code:`<type>`, specifies which type of attribute is being manipulated (the list of types possible depends on the type of command selected previously)
 - :code:`<name>`, is the name of the attribute being manipulated (in the case where the attribute is unnamed, e.g. Repeat, Complete, Trigger, this option should be omitted)
 - :code:`<value>`, is the value to be used in the operation (this option is not required for all commands, e.g. when deleting an attribute)
 - :code:`<path> (<path> (...))`, one or more paths to the nodes where the operation is to be performed

See more details about each argument in the next section.