Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Manual pages are part of the ecFlow script. This is to ensure that the manual page is updated when the script is updated. The manual page is a very important operational tool allowing you to view a description of a task, its importance, task dependencies and possibly describing solutions to common problems. The ecFlow pre-processor can be used to extract the manual page from the script file to be viewed by ecflowviewthe GUI. The manual page is the text contained within the %manual and %end tags. They can be seen using the manual button on ecflowviewtab in the info panel in ecflow_ui.


Manual pages are a vital source of information to users. The text on manual pages is not copied into the job-file when ecFlow sends a task into execution. Suites, families and tasks can have manual pages. Manual pages for tasks are placed in the ecFlow script inside a pair of pre-processor lines as in the following example:

...