FLST Commands

This section describes the FLST commands. You can type these commands anywhere on the source FLST command column or from the command line.

Note:
If data is entered in multiple places, program function keys take precedence, followed by data entered on the command line, and finally data entered on the command column.

CANCEL

When you type CANCEL from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-CANCEL------------------------------------------------------><
 

CANCEL terminates without executing any commands in the command column.

CD

When you type CD from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-CD--+-------+-----------------------------------------------><
       '-dirid-'
 

CD changes the current directory.

Operands

dirid
specifies a REXX File System directory level identifier. This is partially or fully qualified. See the CD command, section CD, for more information.

Example

'CD TEMP'

This example changes the current directory to TEMP and updates the FLST display.

COPY

When you type COPY on the FLST command column use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-COPY--/--fileid---------------------------------------------><
 

COPY copies a file.

Operands

fileid
specifies the file ID of the file where the results are placed.
Note:
If fileid already exists, it is replaced.

Example

'COPY / TEST3.EXEC'

This example, executed from the command column next to TEST1.EXEC, creates a new file, TEST3.EXEC, that is identical to TEST1.EXEC.

When you type COPY from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-COPY--fileid1--fileid2--------------------------------------><
 

Operands

fileid1
specifies the file ID of the file the command acts on.
fileid2
specifies the file ID of the file where the results are placed.
Note:
If fileid2 already exists, the contents of fileid1 replaces it.

Example

'COPY TEST1.EXEC TEST3.EXEC'

This example, executed from the command line, creates a new file (TEST3.EXEC) that is identical to TEST1.EXEC.

DELETE

When you type DELETE on the FLST command column use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-DELETE------------------------------------------------------><
 

DELETE deletes a file.

When you type DELETE from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-DELETE--fileid----------------------------------------------><
 

Operands

fileid
specifies the file ID of the file the command acts on.

Example

'DELETE TEST1.EXEC'

This example, executed from the command line, deletes file TEST1.EXEC.

DOWN

When you type DOWN from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-DOWN--+---+-------------------------------------------------><
         '-n-'
 

DOWN scrolls down one or more lines.

Operands

n
specifies the number of lines to be scrolled down.

Example

'DOWN 5'

This example scrolls forward through the list five lines.

END

When you type END from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-END---------------------------------------------------------><
 

END executes all commands you typed, then terminates when END is typed on the command line or used as a PF key.

EXEC

When you type EXEC on the FLST command column use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-EXEC--+--------------+--------------------------------------><
         '-/--parameter-'
 

EXEC executes the exec, then terminates.

Operands

parameter
specifies the parameters passed to the exec as arguments.

Example

'EXEC / PARMS'

This example, executed on the command column next to TEST3.EXEC, executes exec TEST3.EXEC and passes PARMS as the argument.

When you type EXEC from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-EXEC--fileid--+-----------+---------------------------------><
                 '-parameter-'
 

Operands

fileid
specifies the file ID of the file the command acts on.
parameter
specifies the parameters passed to the exec as arguments.

Return Codes

n
specifies the return code set by the exit of the called exec
0
Normal return
-3
Exec not found
-10
Exec name not specified
-11
Invalid exec name
-12
GETMAIN error
-99
Internal error

Example

'EXEC TEST3 PARMS'

This example executes exec TEST3.EXEC and passes PARMS as the argument.

FLST

When you type FLST from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-FLST--+-------+---------------------------------------------><
         '-dirid-'
 

FLST calls the file list utility.

Operands

dirid
specifies the ID of a full or partial directory. If you do not specify dirid, FLST defaults to the current working directory.

Example

'FLST'

This example displays the file list for the member of the current working directory.

Note

See REXX/CICS File System for more information about the REXX File System.

MACRO

When you type MACRO from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-MACRO--fileid-----------------------------------------------><
 

MACRO calls a macro.

Operands

fileid
specifies the file ID of the macro you want to run. If this file ID includes a file type suffix, then an attempt is made to call an exec with that suffix. Otherwise, an attempt is made to call an exec whose suffix is EXEC.

Return Codes

n
specifies the return code set by the exit of the called exec
0
Normal return
-3
Exec not found
-10
Exec name not specified
-11
Invalid exec name
-12
GETMAIN error
-99
Internal error

Example

'MACRO POOL1:\USERS\USER1\TEST'

This example calls the macro, POOL1:\USERS\USER1\TEST.EXEC.

Note

Macros have the ability to make calls to the REXX/CICS FLST server. Any command that can be entered from the command line of the FLST can be run from a macro.

PFKEY

When you type PFKEY from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-PFkey--number--+------+-------------------------------------><
                  '-text-'
 

PFKEY sets or processes a program function (PF) key.

Operands

number
specifies the PF key that is set or processed.
text
specifies the text that the PF key is set to.

Example

'PFKEY 3 quit'
'PFKEY 3'

This example first sets PFKEY 3 to quit and then processes the PF key.

Note

If you specify text, the PF key is set with the text. If you do not specify text, the PF key is processed.

REFRESH

When you type REFRESH on the FLST command column use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-REFRESH-----------------------------------------------------><
 

REFRESH refreshes the file list.

Example

'REFRESH'

This example refreshes the file list for the member of the current working directory.

RENAME

When you type RENAME on the FLST command column use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-RENAME--/--fileid-------------------------------------------><
 

RENAME renames a file.

Operands

fileid
specifies the new file ID.
Note:
If fileid already exists, it is replaced.

Example

'RENAME / TEST4.EXEC'

This example, executed from the command column next to TEST3.EXEC, renames TEST3.EXEC to TEST4.EXEC.

When you type RENAME from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-RENAME--fileid1--fileid2------------------------------------><
 

Operands

fileid1
specifies the file ID of the file the command acts on.
fileid2
specifies the new file ID.
Note:
If fileid2 already exists, the contents of fileid1 replaces it.

Example

'RENAME TEST3.EXEC TEST4.EXEC'

This example, executed from the command line, renames file TEST3.EXEC to TEST4.EXEC.

SORT

When you type SORT from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram         .-DT-----.
>>-SORT--+--------+--------------------------------------------><
         +-+----+-+
         | '-FN-' |
         +-+----+-+
         | '-FT-' |
         +-+----+-+
         | '-AT-' |
         +-+----+-+
         | '-RC-' |
         '-+----+-'
           '-SZ-'
 

SORT sorts the file list.

Operands

DT
specifies sorting the files by date/time. (This is the default.)
FN
specifies sorting the files by file name.
FT
specifies sorting the files by file type.
AT
specifies sorting the files by attribute.
RC
specifies sorting the file by number of records.
SZ
specifies sorting the files by size.

Example

'SORT FN'

This example sorts the file list by file name.

SYNONYM

When you type SYNONYM from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-SYNONYM--syn--+---------+-----------------------------------><
                 '-command-'
 

SYNONYM assigns a command action to any other valid command.

Operands

syn
specifies any valid command that executes the command action for which it is a synonym.
command
specifies any valid command.

Example

'SYNONYM DISCARD RFS DELETE'

This example makes DISCARD equivalent to the RFS command DELETE.

UP

When you type UP from the command line use the following syntax:

Read syntax diagramSkip visual syntax diagram>>-UP--+---+---------------------------------------------------><
       '-n-'
 

UP scrolls up one or more lines.

Operands

n
specifies the number of lines to be scrolled up.

Example

'UP 5'

This example scrolls backward through the list five lines.