 |
CCP4i: Graphical User Interface |
Documentation for Programmers |
Execute |
NAME
Execute - execute a CCP4 (or other) program within a CCP4i run
script
SYNOPSIS
Execute command_line script_file
return_status return_report args
Optional arguments:
-edit_script
-success program_success_value
-copy_log master_log_file
-nolog
-noexit
DESCRIPTION
Execute a program using the command line command_line and reading
the script from script_file. The program error status and final
report line returned as return_status and return_report.
The Execute command will return a value of 1 if it completes successfully.
The .log file is usually the same file used throughout the run script so
it may have the output from more than one program. If the program fails,
the Execute command will automatically call the TerminateScript
command to terminate the run script cleanly.
- -edit_script
- Display the command line command_line and script in file
script_file in a graphical window so the user can check and edit
these before running the program.
- -success program_success_value
- By default the Execute command assumes that programs follow
the CCP4 convention and have the return code 0 for successful completion.
The -success option should be used to indicate if a program has
a non-zero success code program_success_value.
- -copy_log master_log_file
- In some run scripts it is necessary to read the .log file output from
a program after the program has completed. To avoid potential problems
it is safest to make a temporary duplicate copy of the .log file which can
be read and then deleted. The log_file argument should be the name
of a temporary .log file to contain only the output from this program and
the master_log_file should be the name of the overall .log file for
the run script.
- -nolog
- Do not put .log file output into the default job .log file.
-noexit
Do not terminate the script even if there is an error in running the program.
KEYWORDS