REMARK

Insert remarks in command file

Component:	SDF
Functional area:	Editing command files
Domain:	JOB PROCEDURE
Privileges:	STD-PROCESSING OPERATING HARDWARE-MAINTENANCE SAT-FILE-MANAGEMENT SAT-FILE-EVALUATION SECURITY-ADMINISTRATION
Routing code:	@

Function

The REMARK command allows remarks to be inserted in command files (ENTER or procedure files) in order to document the job or procedure run. The command is logged as entered; in interactive operation, it is only meaningful if job execution is logged on SYSLST.

The command can be issued from all operator terminals (consoles) and authorized user programs. It is also permitted for operator command files.

In programs with an SDF interface, REMARK is available as a standard statement with the same syntax and functionality.

Format

REMARK                                                                                                                                                     

TEXT = <cmd-rest 0..1800>

Operands

TEXT = <command-rest 0..1800>
Text of the remarks. The text can be up to 1800 characters in length.
An equals sign must not be the first significant character, as otherwise the command will be interpreted as a value assignment (SET-VARIABLE without command name). A semicolon outside parentheses is interpreted as a command separator, i.e. any subsequent characters are interpreted as the next command.
When the text is entered at the console, its length is limited to one screen line.

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	Command executed without error

Example

A procedure file begins with the following commands:

/BEG-PROC LOG=*CMD
/REMARK PROCEDURE FOR LINKING

...
...

In the BEGIN-PROCEDURE command, the specification LOGGING=*CMD enables output of the remark to SYSOUT. Then, when the procedure is executed, the remark is logged as follows:

% /REMARK PROCEDURE FOR LINKING