RDRLIST

Read syntax diagramSkip visual syntax diagramRDRListRList1(PROFilePROFRLSTVMDate(2PROFilePROFRLSTPROFilefnVMDateSHOrtdateFULldateISOdateAppend)
Notes:
  • 1 DISCARD and EXECUTE are special commands that can be used in the RDRLIST environment.
  • 2 You can enter Options in any order between the parentheses.

Authorization

General User

Purpose

Use the RDRLIST command to display information about the files in your virtual reader. The RDRLIST environment is controlled by XEDIT. Therefore, you can use XEDIT subcommands to manipulate the files. In addition, you can look at a given reader file, discard it, copy it to a CMS disk or directory, or transfer it to someone else (local or remote).

In most cases the files in your reader were sent to you by other computer users, on your computer or on other computers.

Options

PROFile fn
specifies the name of an XEDIT macro to be executed when XEDIT is invoked by the RDRLIST command. If not specified, the default macro PROFRLST XEDIT is invoked. For more information on the PROFRLST macro, see Usage Note 10, Default PF Key Settings.
VMDate
displays the creation date of each file in the format specified by the user's default date format setting. This is the default. For more information on the user's default date format setting, see Usage Note 16.
SHOrtdate
displays the creation date of each file in mm/dd format.

Where:

mm
specifies the month
dd
specifies the day of the month
FULldate
displays the creation date of each file in mm/dd/yyyy format.

Where:

mm
specifies the month
dd
specifies the day of the month
yyyy
specifies the 4-digit year
ISOdate
displays the creation date of each file as yyyy-mm-dd format.

Where:

yyyy
specifies the 4-digit year
mm
specifies the month
dd
specifies the day of the month
Append
specifies the list of files in your reader should be appended to the existing list. This option has meaning only when entered from within RDRLIST. When entered outside of RDRLIST, it results in an error condition.

Usage Notes

  1. For more information on how to customize this command see Customizing Profiles for CMS Productivity Aids.
  2. You can use the special commands EXECUTE and DISCARD from the RDRLIST screen. The EXECUTE command allows you to issue commands that use the reader files displayed by RDRLIST. For more information, see EXECUTE. The DISCARD command allows you to purge the reader files displayed by RDRLIST. For more information, see DISCARD.
  3. Tailoring the RDRLIST Command Options

    You can use the DEFAULTS command to set up options and override command defaults for RDRLIST. However, the options you specify in the command line when entering the RDRLIST command override those specified in the DEFAULTS command. This allows you to customize the defaults of the RDRLIST command, yet override them when you desire. For more information, see DEFAULTS.

  4. Format of the List

    When you invoke the RDRLIST command you are placed in the XEDIT environment, editing a file userid RDRLIST A1. The existing copy of this file is erased if it exists.

    The file you are editing is a list of files with information collected from the CP QUERY RDR ALL command. Each line contains:
    • A command area
    • File name and file type
    • Class and type
    • Number of records
    • Whether the file is held
    • Creation date and time
    • Originating user ID and node

      A truncation algorithm is used for domain names on the RDRLIST panel. For example, if the first token is greater than 8 characters, the userid is truncated to the first 8 characters of the token. For more information on the truncation algorithm for domain names, see z/VM: TCP/IP User's Guide.

    The full power of XEDIT is available to you while you issue commands against the list of files. For example, you may want to use XEDIT subcommands to scroll through the list of files, locate a particular file, and so forth.

    However, some XEDIT subcommands are inappropriate in this environment. Subcommands that alter the format or the contents of userid RDRLIST. For example, SET TRUNC, SET FTYPE, or SET LINEND may cause unpredictable results.

  5. Entering CMS commands from RDRLIST:

    Begin CMS commands with CMS to prevent XEDIT from decoding the command. This prevents CMS commands from being mistaken as XEDIT subcommands.

  6. Issuing Commands from the List

    On a full screen display, you can issue commands directly from the line on which a reader file is displayed. These commands must be CP or CMS commands that operate on reader files. For example, CHANGE RDR, PURGE RDR, TRANSFER RDR, PEEK, DISCARD. For the above commands that operate on the reader files, the spool ID number is automatically appended to the end of the command.

    Note: When a 'B' is entered, the CP command search is bypassed. If passed to CP the 'B' would be interpreted as the CP BEGIN command. Because the spool ID is appended to the 'B' and the CP BEGIN command expects an address as input, the spool ID would be interpreted as such. In most cases this would cause an ABEND of the CMS virtual machine.
    Use the slash (/) symbols described below to specify the spool ID elsewhere in the command. For example:
    CHANGE RDR / CLASS A
    RECEIVE / fn ft ( REPLACE
    To enter a command, just move the cursor to the line that describes the file to be used by the command, and type the command in the space provided to the left of the file name. If a command is longer than the command space provided on the screen, just continue typing over the rest of the line. When you are finished typing the command, erase the rest of the line by pressing Erase EOF, or space over the rest of the line. Press Enter. You may use the DELETE key to erase the rest of the line, but do not use it to erase only part of the rest of the line.

    For more information, see EXECUTE.

  7. A message from RDRLIST may sometimes appear on the line where a reader file is listed. To enter commands on that line, type over the response and press Enter.
    For example, to transfer a reader file to a user on your computer (local), you would move the cursor to that line on the screen and type:
    TRANSFER RDR / USERA
    Where:
    USERA
    identifies the user ID of the recipient.
    To transfer a reader file to a user on another computer connected to yours (remote), you must know the user ID of the user, the user ID (rscsid) of the virtual machine at your location running the Remote Spooling Communications Subsystem (RSCS), and the location identification (locid) of the computer at the remote location. Move the cursor to that line on the screen and type:
    TAG FILE / REMOTE1 USERB
    Where:
    REMOTE1
    identifies the locid of the remote computer
    USERB
    identifies the user ID of the recipient
    After you have entered the TAG command, on the same line type:
    TRANSFER RDR / NET
    Where:
    NET
    identifies the user ID (rscsid) of the virtual machine at your location running RSCS.

    To purge a file, you would move the cursor to that line on the screen, and type discard in the space provided to the left of the file name. For more information, see DISCARD. When you press Enter, all the commands typed on one screen are executed. The screen is restored to its previous state; however, the list is updated to reflect the current status of the files. For more information, see Responses.

    Commands typed on the RDRLIST command line are executed first, then PF key actions are taken, then commands typed in the prefix area are executed when you press Enter. You may want to enter commands from the RDRLIST command line before executing commands that are typed on the list. To do this, move the cursor to the command line by using the PF12 key (instead of the Enter key). After typing a command on the command line and pressing Enter, you can use PF12 to move the cursor back to its previous position on the list.

    Another way to issue commands that make use of the reader files displayed is to issue EXECUTE from the RDRLIST command line.

  8. Using Symbols as Part of a Command
    Symbols can be used to represent operands in the command to be executed. They can be used in the commands typed on the list, or as part of the command in EXECUTE (on the command line). Symbols are needed if the command to be executed has operands or options that follow the command name. For more information, see EXECUTE. For more information, see Examples. These symbols can be used:
    Symbol
    Description
    /
    means the spool ID of the file displayed on the line.
    /n
    means the file name displayed on the line.
    /t
    means the file type displayed on the line.
    /o
    means execute the line as is, without appending anything.
    /m
    means the device type (from which the file was sent).
    Any combinations of symbols can be used. For example:
    /n /t
    means file name followed by file type.
    /nt
    means file name followed by file type.
    Note: If the symbol ‘/’ appears in a command or in its operands, it must be issued from the command line, and not as part of an EXECUTE command.
  9. Special Symbols Used Alone
    These special symbols can be typed alone on the lines of the RDRLIST display:
    Symbol
    Description
    =
    means execute the previous command for this file. Commands are executed starting at the top of the screen. For example, suppose you enter DISCARD on a line. You can then type an equal sign on any other line(s) below the DISCARD command. Those files preceded by equal signs are discarded when the EXECUTE command is entered (from the command line or by pressing Enter).
    ?
    means display the last command executed. The command is displayed on the line in which the ? is entered.
    /
    means make this line the current line. (On the RDRLIST screen, the current line is the first file on the screen.)
  10. Default Key Settings and Synonyms

    The PROFRLST XEDIT macro is executed when the RDRLIST command is invoked, unless you specified a different macro in the RDRLIST command. Table 1 shows the values to which the keys are set.

    Table 1. Default Key Settings and Synonyms Set by PROFRLST XEDIT
    Enter   Execute commands typed in the file line(s) or on the command line. (The ENTER key is set by the XEDIT subcommand, SET ENTER IGNORE MACRO EXECUTE.)
    PF1 Help Display RDRLIST command description.
    PF2 Refresh Update the list to indicate discarded files, and so forth.
    PF3 Quit Exit from RDRLIST display.
    PF4 Sort Sort by file type, file name.
    PF5 Sort Sort by date and time, in a calendar year, oldest to newest.
    PF6 Sort Sort by user ID, in alphabetic order.
    PF7 Backward Scroll back one screen.
    PF8 Forward Scroll forward one screen.
    PF9 Receive Receive the file pointed to by the cursor. For more information, see RECEIVE.
    PF10   Not assigned.
    PF11 Peek Display file where cursor is placed, but do not write it on a disk or directory. The file is displayed in the XEDIT environment. For more information, see PEEK.
    PF12 Cursor If cursor is in the file area, move it to the command line; if cursor is on the command line, move it back to its previous location in the file (or to the current line).
    Note: On a terminal equipped with 24 PF keys, PF keys 13 to 24 are assigned the same values as PF keys 1 to 12 as discussed here.

    Some XEDIT subcommands are stacked by the FILELIST command (for example, SET TRUNC, SET LRECL, and SET VERIFY). In order to override these settings in a profile, these SET subcommands must be stacked FIFO.

    In addition to setting the above PF keys, the PROFRLST XEDIT macro sets the synonyms that sort your RDRLIST files. Enter these synonyms on the RDRLIST command line:
    Synonym
    Description
    SNAME
    Sorts the list alphabetically by spool file name and spool file type.
    STYPE
    Sorts the list alphabetically by spool file type and spool file name.
    SCLAS
    Sorts the list by device type, class, and hold status.
    SHOLD
    Sorts the list by hold status, device type, and class.
    SUSER
    Sorts the list by origin user ID, node, and date.
    SSIZE
    Sorts the list by the number of records (greatest to least).
    SDATE
    Sorts the list by month, day, and time (oldest to most recent).
  11. Displaying a File

    To display a file on the screen without reading it onto a disk or directory, position the cursor at the file you want to see and press PF11, which is set to the PEEK command. For more information on the PEEK screen, see PEEK.

  12. If you want to issue RDRLIST from an exec program, you should precede it with the EXEC command; that is, specify
    exec rdrlist
  13. When you press PF9 (RECEIVE), you may receive prompting messages that require a response. For more information, see RECEIVE.
  14. To obtain secure origin data for a spool file sent from a remote site using secure origin data support, the CMS RDRLIST EXEC issues DIAGNOSE X'F8' subcode X'01' instead of the CP TAG QUERY FILE command. However, if secure origin data support is not installed in the system or if a file arrives from another system that does not have this support, RDRLIST obtains the origin data as it does now—using the CP TAG QUERY FILE command.

    The RDRLIST command calls the EXECUTE XEDIT macro to refresh the RDRLIST panel every time a command is executed from it. That's why EXECUTE issues DIAGNOSE X'F8' subcode X'01' to obtain the real origin data of the spool file.

  15. Open files are displayed on the RDRLIST screen with OPEN in the date field and 000C in the time field. Keep in mind the origin user ID and node for an open spool file from a remote node will display the Networking Virtual Machine in the user ID field and an asterisk (*) in the node field.
  16. If a date format is not specified on the RDRLIST command, the default date format is determined by the setting of the DEFAULTS command. The DEFAULTS command default (the initial setting) is VMDATE, which indicates the user's default date format is to be used. The DEFAULTS command setting can be changed by using DEFAULTS SET.

    The default date format for certain CP and CMS commands can be set on a system-wide basis and also for the individual user. The system-wide default date format is set with the SYSTEM_DATEFORMAT system configuration statement. The user's default date format is set with the DATEFORMAT user directory control statement. The system-wide default and the user's default can also be set with the CP SET DATEFORMAT command. If SET DATEFORMAT is not specified for an individual user and there is no DATEFORMAT statement in the user's directory entry, the default format for that user is the system-wide default.The system-wide and user settings can be queried with the CP QUERY DATEFORMAT command.

    The hierarchy of possible date format settings for the RDRLIST command, from highest priority to lowest, is:
    • RDRLIST command option
    • DEFAULTS command setting or default
    • User default
    • System-wide default
  17. When FULLDATE or ISODATE is in effect, the columns to the right of the Date field will be shifted to the right to accommodate the addition of the 4-digit year.
  18. An existing RDRLIST profile (PROFRLST XEDIT) on your A-disk or in your search order may cause the files displayed by RDRLIST to be sorted incorrectly when sorted by date with FULLDATE or ISODATE in effect. To ensure the date sort function operates correctly, you should erase your old profile and build a new user profile that first calls the system profile for RDRLIST (PROFFLST) followed by your customized changes.
  19. In an SSI cluster, when a single-configuration virtual machine issues the RDRLIST command, all spool files that reside in the shared spool of the cluster (except files transmitted through RSCS) will appear to be local. That is, the files will appear to originate from the member where the RDRLIST command was issued, although the files might have been created on other members. (For files transmitted through RSCS, the actual origin node will be displayed.)

    If the RDRLIST command is issued by a logon instance of a multiconfiguration virtual machine, only spool files created on that member (or transmitted through RSCS) will be displayed.

Examples

In the RDRLIST environment, information about the user's virtual reader is displayed in a format similar to what the FILELIST command provides about a CMS disk or Shared File System (SFS) directory.

The following is a sample RDRLIST screen when an external security manager is not installed.
Figure 1. Sample RDRLIST Screen
 OHARA    RDRLIST     A0  V 108  Trunc=108 Size=17 Line=1 Col=1 Alt=1
Cmd     Filename Filetype Class User At Node Hold  Records  Date  Time
        PIZZA    TOPPINGS PUN A KEN   NODE04 NONE       10  10/06 10:39:38
        COOKIE   ASSEMBLE PUN A KEN   NODE04 NONE       10  10/06 10:25:11
        $JELLY   SCRIPT   PRT A KEN   NODE04 NONE        7  10/06 10:15:50
        DIETING  TIPS     PUN A KEN   NODE04 NONE       11  10/06 09:40:28
        KEN      NOTE     PUN A KEN   NODE04 NONE       10  10/06 08:43:07
        SEND     EXEC     PUN A BOB   NODE02 NONE        2  10/06 07:12:35
        GOOD     DAY      PUN A GEOFF NODE02 NONE       29  10/05 11:44:34
        Acknowl  edgment  PUN A BOB   NODE02 NONE        2  10/05 11:42:21
 
 
 
 
 
 
 
 
 
1= Help     2= Refresh  3= Quit     4= Sort(type) 5= Sort(date) 6= Sort(user)
7= Backward 8= Forward  9= Receive 10=           11= Peek      12= Cursor
 
====>
                                                            X E D I T  1 File

The appearance of the RDRLIST screen changes when an external security manager is called on to check security labels.

In the following sample screen, notice some fields are masked by asterisks. This indicates the security label governing your current session does not dominate that reader file. Consequently, the system does not allow you to observe these fields.

To see these fields, log off and log on again with a security label that dominates the reader file you want to work with.
Figure 2. Sample RDRLIST Screen with an External Security Manager Installed
 JSMITH   RDRLIST     A0  V 108  Trunc=108 Size=5  Line=1 Col=1 Alt=1
Cmd     Filename Filetype Class User At Node   Hold  Records  Date  Time
        PROJA    PLANS    PUN A PJONES  NODE7  NONE     9410  9/22  3:30:57
        PROJD    PLANS    PUN A MBROWN  NODE9  NONE    11074  9/26  5:35:21
        PROJE    NOTE     PUN A FGREEN  NODE8  NONE       67  9/22  3:30:27
        ******** ******** *** A KWHITE  NODE4  NONE  *******  9/26  5:35:10
        PROJB    MEMO     PUN A PJONES  NODE4  NONE       32  9/12  8:30:21
 
 
 
 
 
 
 
 
 
 
 
 
1= Help     2= Refresh  3= Quit     4= Sort(type) 5= Sort(date) 6= Sort(user)
7= Backward 8= Forward  9= Receive 10=           11= Peek      12= Cursor
 
====>
                                                            X E D I T  1 File
The following examples show how symbols can be used to represent operands in a command. The values substituted for the symbols and the resulting command are shown. In each case, the command can be entered in either of the following ways:
  • Typed in the Cmd area of the screen. The command is executed either by pressing ENTER or by entering EXECUTE on the XEDIT command line and then pressing Enter.
  • Entered from the XEDIT command line, as an operand of EXECUTE (in the form EXECUTE lines command).

If a symbol is not specified, the spool ID number of the reader file is appended automatically to the command.

Spool File ID Command Resulting Command
pizza toppings DISCARD DISCARD spoolid
cookie assemble RECEIVE / CAKE /t ( REPLACE RECEIVE spoolid CAKE ASSEMBLE (REPLACE
ken note PEEK PEEK spoolid
send exec FILELIST /n * * FILELIST SEND * *
$jelly script TRANSFER RDR / TO * PRT TRANSFER RDR spoolid TO * PRT (prints the file)

Responses

After a command is executed, one of the following symbols is displayed in the Cmd space to the left of the file for which it was executed.
*
Means the command was executed successfully (RC=0).
*n
Is the return code from the command executed (RC=n).
*?
Means the command was an unknown CP/CMS command (RC=-3).
*!
Means the command was not valid in CMS subset. For a list of commands valid in CMS subset mode, see z/VM: CMS User's Guide.
The following responses can also appear on the RDRLIST screen after you have issued a command for a file from your virtual reader:
* spoolfn spoolft ** Discarded or Received **
* spoolfn spoolft has been discarded.
File spoolfn spoolft has been discarded.
* spoolfn spoolft has been left in your reader.
* spoolfn spoolft ** Command not issued, RDRLIST line has been changed **
The following response can also appear if RDRLIST is invoked in the CMS environment and you have no reader files:
No files in your reader.

Messages and Return Codes

  • DMS205E No files in your reader [RC=28]
  • DMS651E APPEND must be issued from RDRLIST [RC=40]

Additional system messages may be issued by this command. The reasons for these messages and their location are:

Reason Location
Errors in command syntax Command Syntax Error Messages