This document lists, explains and provides examples of all Natural ISPF session, function and local commands.

Before consulting any command described here, you should read section Command Logic.

Editor commands are described in section Editor.

This document covers the following topics:

• Note about Command Syntax Symbols

• Session Commands - Description

• Function Commands - Description

• Local Commands - Description

Note about Command Syntax Symbols

The following symbols are used in the description of command syntax:

Session Commands - Description

With Natural ISPF session commands, you can control your Natural ISPF session(s) and navigate within the system. Session commands can be issued from any system screen.

This subsection describes session commands in alphabetical order.

ACTIVITY

Opens a window with a list of all Natural ISPF sessions you have started. The current session appears highlighted.

The command format is:

ACTIVITY

Example:

You can issue any of the following line commands for any session in the list:

When you close the activity display with ENTER or PF3, the session selected with the P line command will be the current (active) session.

You can give a session a short name by typing the short name in the appropriate field in the column headed Name in the activity window. This serves for easy identification of the session in a subsequent POP command. Alternatively, you can type a PF key name in the Name field. Pressing this PF key calls the associated session to display. This PF key is valid only until you change it or log off from Natural ISPF, and overrides the PF definition in your user profile.

The following is an example of an ACTIVITY window:

   S*>>>EDIT-NAT:NSPFHELP(ALL)-Text->Report-Free-42K ------------- Columns 001 072
    COMMAND===> activity                                           SCROLL===> CSR
   ****** ****************************** top of data *****************************
    +------------------------N-ISPF ACTIVITY TABLE-------------------------+
    !                                                                      !
    !  Cmd Name Session                                                    !
    !  --- ---- ---------------------------------------------------------- !
    !      PF6  WORKPOOL - ENTRY PANEL                                     ! e  to
    !      PF7  LIST-PDS:BRY.COMN.SOURCE(*)                                ! list.
    !      PF5  NATURAL VIEW - ENTRY PANEL                                 ! uting
    !      F1   EDIT-NAT:NSPFHELP(ALL)-Text                                !
    !                                                                      !
    !                                                                      !
    !                                                                      !
    +----------------------------------------------------------------------+
   000130 &L
   000140   ALL ED
   000150   The command edit is executed for  all  members  of  the  list.  If  an
   000160  #end§command usually assigned to #PF3§ is  entered,  the  current  edit
   000170   session is terminated and an edit session for the next§member from the
   000180   list is opened.
   000190 &L
   Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
         Help  Split End   Suspe Rfind Rchan Up    Down  Swap  Left  Right Curso

The window shows four Natural ISPF sessions, the Natural EDIT session being the current session. You can call this session to display from any screen using the command:

POP F1

If you press PF6 from any screen, the Workpool Entry Panel becomes the current session.

APPLICATION

Activates the Natural application specified in the command parameters.

The command format is:

APPLICATION library[startup-program[parameters]]

where:

Examples:

The APPLICATION command is especially useful for the system administrator in menu definition, allowing applications written in Natural to be integrated into the Natural ISPF menu structure (see also the section Menu Maintenance in the Natural ISPF Administration Guide).

BPSTAT

Invokes the Natural Edit Buffer Pool Utility (see the section Buffer Pool and Recovery Files in the Natural ISPF Administration Guide).

The command format is:

BPSTAT

BREAK

Modifies the break interval defined in your user profile. The value specified is the number of trace windows to be displayed before you are prompted to interrupt processing: BREAK PROCESS (Y/N). For example, after the command BREAK 3, you are given the opportunity to interrupt processing every 3 trace windows.

The command format is:

BREAK {n }
      {OFF}     

where n stands for the number of trace windows to be displayed before the break in processing is allowed, and OFF disables the break feature.

For more information, see the subsection Break in Processing in the section Useful Features.

CALCULATOR

Invokes the calculator on your screen that allows you to perform computation in numeric or hexadecimal mode.

The command format is:

CALCULATOR

For more information, see the subsection Using the Calculator in the section Useful Features.

CHARPROF

Invokes the Magic-Character definition screen in your user profile. You can define magic characters for any number of Natural ISPF commands (see the subsection Magic-Character Definition in the section Profile Maintenance).

The command format is:

CHARPROF

COLPROF

Defines the colors to be used by the Natural ISPF browser, which is responsible for all LIST, BROWSE and EDIT sessions. The colors used in other screens cannot be modified with this profile option.

The command format is:

COLPROF

For more information, see the subsection Editor Color Definition in the section Profile Maintenance.

CONFIRM

Specifies whether confirmation windows are used when performing functions such as DELETE, COMPRESS, CATALOG and UNCATALOG. You can use this command to override the setting in your user profile.

The command format is:

CONFIRM [ON]
        [OFF]
        [LONG]
        [SHORT]

Meaning of the parameters:

If you issue the CONFIRM command without parameters, the default is ON, taking LONG or SHORT from your user profile.

CONTINUE

The command format is:

CONTINUE

The CONTINUE command can be used in command scripts to gain more flexible control in error situations. If no CONTINUE statement is in the command script, the script is set to PAUSE mode after an error.

If a CONTINUE statement (which can be compared to a label) is in the script and an error occurs, the following actions are taken:

• RECORD ON is set internally if not activated by the user.

• The command causing the error and the message is recorded.

• All lines of the script until the next CONTINUE command are deleted and execution of these lines is skipped.

• Processing continues with the next CONTINUE statement. All following statements are executed.

• Termination resets RECORD to its previous value and informs the user if an error has occurred.

Example:

KEYS 3 PAUSE
HELP VERIFY
MESSAGE 7480
TECH
........
CONTINUE
REMARK PROCESSING WILL CONTINUE HERE AFTER ERROR
KEYS 3 INITIAL

The above script modifies the user profile, and by using the CONTINUE command, it makes sure that PF3 is reset to the value from the user profile after execution of the script, even if errors have occurred during execution of the script.

CONTROL

Applies to CA Panvalet and CA Librarian only. CONTROL OFF suppresses the automatic control cards passed to CA Panvalet or CA Librarian when a member is saved. Only the edited data (which may include user-defined control cards) are sent to CA Panvalet or CA Librarian.

The command format is:

CONTROL [ON]
        [OFF]

Meaning of the parameters:

You must issue the CONTROL command before opening the new Editor session.

DEFPROF

Displays your User Defaults definition screen in your user profile. You can modify any default (see the subsection User Defaults in the section Profile Maintenance).

The command format is:

DEFPROF

EDITPROF

Invokes the Editor Profile definition screen in your user profile. You can modify your Editor profile (see the subsection Editor Profile in the section Profile Maintenance).

The command format is:

EDITPROF

END

Returns you to the previous screen. Issued from the Main Menu, END terminates the Natural ISPF session. Issued from the last session, this command returns you to Natural.

This command is usually assigned to PF3.

The command format is:

END

FIN

Terminates all Natural ISPF sessions and Natural immediately. The command corresponds to LOGOFF IMM;FIN.

The command format is:

FIN

FLIP

Switches between PF key display (from PF1-PF12 to PF13-PF24 or vice versa). See also the KEYS session command.

The command format is:

FLIP

GENNCP

Starts the generation of a command processor for Natural ISPF. For more information, see the subsection NCP Concept in the section System Configuration of the Natural ISPF Administration Guide.

The command format is:

GENNCP

HELP

Issued without parameter, displays a screen-related help text. The HELP command is usually assigned to PF1.

The help text is displayed according to the following hierarchy:

• Menu help text defined by your system administrator;

• Help text from the online help facility.

You can also issue the HELP command with a parameter indicating the topic on which help is required from any system screen in the format

HELP [INDEX]
     [object]
     [:C]

where:

Examples:

KEYS

Used without parameter, displays current PF key assignments in your user profile. You can modify the assignments and specify whether and which PF keys are displayed on system screens (see the subsection PF-Key Definition in the section Profile Maintenance).

The command format is:

KEYS   [ON]
       [OFF] [string]
       [FIRST] [INITIAL]
       [LAST]
       [n]

The string and INITIAL parameters are only valid in conjunction with n (see below).

The parameters have the following meaning:

Examples:

LAST

Redisplays the last ten (10) commands entered via the keyboard in this session (but see note below). You can select any command for reexecution, or modify any command by overtyping it before reexecution. Select the required command from the list by placing the cursor on it and pressing ENTER.

If a command is executed again, it is always put on top of the last command buffer. This keeps the commands used most in the buffer. Additionally, you can also delete commands from the last buffer. Commands not used again can be deleted; this avoids automatic deletion of commands likely to be reused.

The command format is:

LAST

LOGOFF

The LOGOFF session command allows you to terminate Natural ISPF even if you are working with several sessions.

The command format is:

LOGOFF [IMM] [;Natural-command]

• If your Editor profile has AUTOSAVE=OFF and you issue the LOGOFF command without parameters, logoff processing is interrupted if an Editor session with modified data is detected.

• If your Editor profile has AUTOSAVE=ON and you issue the LOGOFF command without parameters, all modifications are saved during logoff processing.

If you wish to terminate Natural ISPF immediately, that is, regardless of any modifications, you can use the IMM (IMMEDIATE) parameter. All sessions will be closed without saving and Natural ISPF will be terminated.

You can concatenate the LOGOFF command with any valid Natural command.

If Natural ISPF is the only user interface installed, all sessions will be closed and you return to the Natural ISPF main menu.

Examples:

LOGON

Logs on to the specified Natural library as a default library from any system screen.

The command format is:

LOGON  library-name

The new library is addressed as the default library by function commands for Natural objects and as the library in the session command Natural.

MACPARM

The MACPARM command is used in command scripts to stack data which is read by a macro using an input statement later in the command script.

This avoids prompting by the macro for parameters, when using macros in a command script. The MACPARM command must be the only command in a source line.

The command format is:

MACPARM  p1

where:

Examples:

Another useful example can be found in member VERIFY in our example library.

MACRO

Specifies whether macros are expanded in Natural programs and other sources that include inline macros or the INCLUDE-MACRO statement. For details, see the section Macro Facility in the Natural ISPF Programmer's Guide.

The command format is:

MACRO [ON]
      [OFF]

where ON specifies macro expansion and OFF specifies non-expansion. Default is ON.

MENU

Activates a defined menu. For example, the command MENU MAIN displays the Natural ISPF Main Menu. The name of the menu must be defined in the menu maintenance facility, see the section Menu Maintenance in the Natural ISPF Administration Guide.

The command format is:

MENU name

where name specifies the menu name as defined in the menu maintenance facility.

MESSAGE

The MESSAGE command can be used in command scripts to display a text during execution of a script on the screen and to interrupt the active command script. The MESSAGE command must be the only command in a source line.

The command format is:

MESSAGE  nnnn[p1,p2 ... pm]

where:

Examples:

Member MYPROG not found.

Please enter some text

Another useful example can be found in member VERIFY in our example library.

NATDEF

Invokes the Natural Defaults definition screen in your user profile which allows you to set several defaults that affect your working environment in Natural ISPF. For more information, see the subsection Natural Defaults in the section Profile Maintenance.

The command format is:

NATDEF

NATP-LOG

When you enter this command, a window prompts you for your user ID, password and Entire System Server node ID. Performs a logon to Entire System Server on the specified node.

The command format is:

NATP-LOG

NATURAL

Suspends your Natural ISPF session and invokes the Natural environment. You can return to your Natural ISPF session at any time by issuing the command SPF.

The command format is:

NATURAL [Natural-command and parameters]

If the Natural command is issued with parameters, the parameters are executed by Natural and you are automatically returned to Natural ISPF.

NEWS

Displays a summary of changes in the current release of Natural ISPF (new features, enhancements, etc.), selectable by topic after the NEWS command has been issued.

The command format is:

NEWS

NKEY

From Version 2.1.1 onward, this command is no longer needed and has no effect. However, it is still accepted for compatibility reasons.

The command format is:

NKEY [ON]
     [OFF]

NODE

Selects the Entire System Server node ID specified with the command keyword. This command changes the default node and has no effect on existing sessions.

The command format is:

NODE id

NODES

Invokes the Entire System Server node table, which offers active help for the NODE field in several Natural ISPF screens. For more information, see the subsection Entire System Server Node Table in the section System Configuration of the Natural ISPF Administration Guide.

The command format is:

NODES

NSPROF

Displays the NSPF Parameters definition screen. You can modify any parameter (see the subsection Natural ISPF Parameters in the section System Configuration in the Natural ISPF Administration Guide).

The command format is:

NSPROF

OPERATOR

Signals Natural ISPF that the command entered in the same input operation is an operator command. For easier operator command input, you are advised to assign this command to a magic character (see the subsection Magic-Character Definition in the section Profile Maintenance).

The command format is:

OPERATOR operator-command

PAUSE

The PAUSE session command can be written in a command script that is executed with the PLAY function command. It must be either the only or the last command in a source line of the script. When the script is executed, it is interrupted at the place of the PAUSE command.

To continue the script, you can issue the PAUSE command from the Natural ISPF command line. You can also use the PAUSE command if a command script is interrupted due to an invalid command: the command appears in the command line. You can correct the command, press ENTER to reexecute it, and then issue the PAUSE command to continue the script.

The command format is:

PAUSE

See also the subsection Executing Command Scripts in the section Useful Features.

PLAY OFF

If the execution of a Natural ISPF command script is interrupted due to the PAUSE command, you can cancel the script by issuing the command PLAY OFF. The script entry is also deleted from the workpool.

The command format is:

PLAY OFF

See also the subsection Executing Command Scripts in the section Useful Features.

POP

Selects the specified Natural ISPF session for work.

The command format is:

POP [string]

where string identifies the required session by the short name assigned in the ACTIVITY window or by any string from the session's header line. For example, the command

POP PDS

selects the Natural ISPF session that might have EDIT-PDS:NSP.V100.JCL(JOB1) as its header. If you use the POP command without a parameter, you can select a session by placing the cursor on it (usually on its header line). If the cursor remains in the current session, a window with selectable sessions appears. The current session is highlighted, the other sessions are numbered. Press ENTER to select the current session, or select any other session by entering its number in the input field.

PROFILES

Invokes the user Profile Menu. You can select any option (see the section Profile Maintenance).

The command format is:

PROFILES

RECORD

Activates the recording of Natural ISPF commands issued and the resulting error messages. The recorded messages are held in the User Workpool in the member RECORD. This member can be played (the commands are executed, see the PLAY function command).

The command format is:

RECORD [ON]
       [OFF]

RECORD or RECORD ON activates recording of commands. RECORD OFF ends recording. If a command causes an error, the error message is also recorded, but prefixed by two asterisks (**). The PLAY command ignores these lines.

RECOVER

If you lose files for any reason (for example, after an abnormal termination), Natural ISPF notifies you with a message the next time you log on. The RECOVER command displays a list of the lost files which you can select with a line command for further editing and saving, browsing or deleting.

The command format is:

RECOVER

See also the subsection Recovery in the section Useful Features.

REFRESH

Refreshes screen display.

The command format is:

REFRESH

REMARK

The REMARK command is used in command scripts for documentation purposes and must be the only command in a source line.

The command format is:

REMARK text

Example:

REMARK The following command extracts all members
REMARK including the string ADABASLIS

T PDS JW(*) SC=ADABAS

RETURN

Returns directly to the Natural ISPF Main Menu of the current session. If you issue this command from an edit session, Natural ISPF prompts you to SAVE or CANCEL any modifications.

The command format is:

RETURN

SEND

Allows you to send a message to up to five TSO, TIAM or Com-plete users anywhere within the network. A window opens prompting you for user ID(s), destination node number and message text. See also the subsection Message Switching in the section Useful Features.

The command format is:

SEND

SEPARATE

Splits the current screen from its session to create two separate and distinct sessions, for example, after selecting a member from a list for an EDIT operation: the edit screen and the list become two separate sessions.

The command format is:

SEPARATE

Useful in conjunction with the SPLIT session command to display two screens from the same session, for example, an edit session and the list of objects from which it was started. Use the command sequence:

SEP;SPLIT

See the subsection Multi-Session Operations in the section Useful Features for a more detailed example.

SHORTLIB

Displays the Short Libraries definition screen for library names in your user profile. You can define a two-character alias for any library (see the subsection Library Definition in the section Profile Maintenance).

The command format is:

SHORTLIB

SPLIT

Switches your session to split-screen mode. Your screen is divided horizontally into two at the cursor position or at the line number specified as command parameter. An existing session is redisplayed in the lower part of your screen. If there are no other existing sessions, a new one is started.

The command format is:

SPLIT [n]

where n is the line number at which the screen is to be split (n must be smaller than the available number of lines for the screen). The SPLIT command is usually assigned to PF2.

SUSPEND

Suspends the current Natural ISPF session and starts a new one.

The command format is:

SUSPEND

The SUSPEND command is usually assigned to PF4.

SWAP

When in split-screen mode, makes the other session active. The cursor moves to the first input field of the activated session. When issued from a session in full-screen mode, recalls a suspended session in wrap-around fashion.

The command format is:

SWAP

The SWAP command is usually assigned to PF9.

TECH

Displays technical information on Natural ISPF.

The command format is:

TECH

TRACE

Modifies the trace interval in seconds defined in your user profile. When you issue a command, a message appears in a window if the function is not yet complete after the specified interval. The message informs you of Natural ISPF activity, for example, PROCESSING 44 MEMBERS. The message is updated at the specified interval.

The command format is:

TRACE [n]
      [OFF]

where n stands for the interval in seconds, and OFF disables the trace feature.

UINFO

Displays site-specific information maintained by your system administrator. For more details, see the subsection Online Technical and Site-Specific Information in the section Useful Features (see also the section Site-specific Online Information in the Natural ISPF Administration Guide).

The command format is:

UINFO

UNZOOM

Reverses the effect of a previous ZOOM command (see the ZOOM command below).

The command format is:

UNZOOM

VERSIONS

Specifies versioning for PDS and Natural members. This command overrides the setting of the VERSIONS parameter in your user profile (see the subsection User Defaults in the section Profile Maintenance).

The command format is:

VERSIONS [ON]
         [OFF]

where OFF deactivates versioning and ON (re-)activates versioning. ON is the default.

ZOOM

Eliminates the header lines of suspended sessions from your screen. When in split-screen mode, a second ZOOM command displays the current session in full-screen mode. You can return to split-screen mode using the UNZOOM command.

The command format is:

ZOOM

Function Commands - Description

Function commands perform functions on Natural ISPF objects. You can issue a function command in three different ways:

• Enter a command in the command line and parameters in the parameter fields of the object Entry Panel as appropriate;

• Use a line command to select an object from a list;

• Enter command syntax in the command line of any screen in the format

  COMMAND object-type object-parameters,function-parameters

A description of the command parameters follows.

Object Types

Abbreviations of object types used in command syntax are:

Object-Parameters

There are two types of object parameters.

• Positional parameters:
  These correspond to the name parameter fields on the object Entry Panel and identify the required object, for example library(member);

• Keyword parameters:
  Specify a further characteristic of the object that corresponds to a parameter field on the object Entry Panel other than the name parameters. Keyword parameters take the format KEYWORD=value, for example TYPE=t.

  Keyword parameters can be abbreviated. The abbreviation must be long enough to identify the keyword, for example, LIST DS * V=MYDISK. In this case, V is a valid abbreviation for the keyword VOLSER.

  A list of possible keywords and their valid synonyms can be found in the section Keyword Parameters at the end of this documentation.

Function Parameters - for CHANGE, COPY, DOWNLOAD, EXPORT, HOLD, PRINT, RELEASE, RENAME, SUBMIT, UPLOAD

Which Commands for which Object Type?

Full parameter syntax is described for each object type in the relevant section of this documentation. No special distinction of required and optional parameters is made here, as Natural ISPF supports function command input with windows that prompt you for any required parameter you omit.

This subsection describes all function commands in alphabetical order and gives some examples. Each function command appears together with its valid abbreviation, which can be used as a line command from a list of object names.

Not all function commands apply to each object type. To find out which commands are available for a specific object type, simply type the object type code in the Natural ISPF command line and press ENTER. A window opens with a list of the valid functions.

Example:

To list available functions for Natural objects, type the object code N in the command line and press ENTER. The list of valid functions is displayed:

   -------------------------- NATURAL ISPF MAIN MENU -----------------------------
   OPTION  === +---------------------------------------------------+
               ! ENTER FUNCTION:                                   ! id   BRY
               !   1 L  LIST               17 DS DESCRIPTION       !      11:04:01
      0    PRO !   2 B  BROWSE             18 FR FORMAT            ! inal DAEFTC55
      1    NAT !   3 E  EDIT               19 DW DOWNLOAD          ! ary  BRY
      2    VIE !   4 D  DELETE             20 UP UPLOAD            !      148
      3    ERR !   5 R  RENAME             21 CR COMPARE           !
      4    PRE !   6 SB SUBMIT             Select ==> __           !
      5    WOR !   7 PL PLAY                                       !
               !   8 PR PRINT                                      !
      6    JOB !   9 CP COPY                                       !
      7    PDS !  10 CT CATALOG                                    !
      8    DAT !  11 U  UNCATALOG                                  !
      9    JOB !  12 I  INFORMATION                                !
      10   MEM !  13 HL HOLD                                       !
  
   Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
         Help  Split End   Suspe Rfind Rchan Up    Down  Swap  Left  Right Curso

ALLOCATE / AL

Allocates a z/OS dataset. The ALLOCATE command is usually issued for an existing dataset or file. The allocation information for the existing item is displayed, and you can overtype the name and modify the specifications for the new item.

Examples:

Under z/OS, this command is invoked implicitly if the target dataset of a copy operation does not exist.

BROWSE / BR

Displays the specified object in Editor format. This means you can use all Editor scrolling commands, including FIND and LOCATE, as well as appropriate local commands described in the subsection Local Commands - Description.

Examples:

CATALOG / CT

Catalogs the specified Natural program or dataset.

Example:

The command:

CAT N NATLIB(MYPROG)

catalogs the Natural program MYPROG in the library NATLIB.

CC

Displays the condition codes of the job specified in the command parameters. Condition codes appear in Editor format in browse mode.

Example:

The command:

CC COM444

displays the condition codes for job COM444. If there are several copies of the same job, use the job number parameter, otherwise you are notified with a message and the code for the copy last submitted is selected.

If you issue the CC command without parameters, the job last submitted from Natural ISPF is selected.

CHANGE / CH

Changes one or more attributes of the specified object; valid for z/OS jobs and SYSOUT file(s). The new attribute values can be specified by means of function parameters (see below). If none of the available function parameters are present, the new attribute values are prompted.

Available function parameters and restrictions:

Combinations of the above parameters can be specified in one command.

Example Job Class (z/OS):

The command:

CH J MYJOB CLASS=C

changes the class of job MYJOB in an z/OS environment from C to a new class which is prompted. Additionally a new output destination can also be specified in the prompt window. If there is more than one copy of the job, use the job number parameter. If JES2.4.1 or a lower version of JES2 is installed at your site, the specified job queue entry must not be in the HOLD queue.

Example SYSOUT File:

The command:

CH SYS 3982 SI=SO FILE=2

prompts you for a new job class to which file SO-2 of job number 3982 is to be redirected. The specified job file must be in the HOLD queue.

COMPARE / CR

Compares Natural sources stored in the Natural system file. For further information, see the example in the corresponding subsection of the section Common Objects.

COMPRESS / CM

Compresses the specified dataset.

Example:

The command:

COM D L99022.EDITOR.LOAD

compresses the dataset L99022.EDITOR.LOAD after confirmation. You are notified of completion by a message.

COPY / CP

Copies the specified object as another object of the same or different object type. You can enter target parameters as part of the command syntax.

Under z/OS, if the target dataset of a COPY D dataset-name command does not exist, you are prompted for a file allocation.

Examples:

See also the subsection Copying Objects in the section Useful Features, as well as the COPY local command.

DEFINITION / DF

Displays the specified Natural DDM.

Examples:

DELETE / D

Deletes the specified object from the system file or system environment after confirmation.

Example:

The command:

CONFIRM OFF;D N NATLIB(NATMEM)

deletes, without the confirmation prompt, the Natural member NATMEM from the library NATLIB.

DESCRIPTION / DS

Opens an edit session with the Predict long description of the selected Natural object, Natural view or any other Predict object type in Editor format. You can modify the description as required.

Example:

The command:

DS N NATLIB(MYPROG)

starts an edit session with the Predict description of Natural program MYPROG in library NATLIB.

DIFFERENCE / DI

The DIFFERENCE function is available for any previous version of a versioned object. It displays the current version together with any changes made during the period between the selected version and current version. Changes are indicated by highlighting and a corresponding remark in the prefix area.

For example, the command:

DI NV MBE(MYPROG)

opens a window prompting you for the date and time of a previous version for Natural member MYPROG in library MBE. It is more common, however, to issue the DIFFERENCE function as a line command from a list of previous versions for the member.

See the subsection Versioning in the section Useful Features for an example.

DOWNLOAD

In addition to the EXPORT command, which usually handles text only, the DOWNLOAD command also downloads binary data. Currently it is available for the following Natural ISPF objects:

The command format is:

DOWNLOAD object-type object-id, SOURCE BINARY OBJECT DESTINATION=file.ext

The keywords SOURCE BINARY OBJECT are evaluated for views and Natural members only. They have no meaning when downloading PDS members. Any combination of these keywords can be entered in one command, allowing Natural source and object to be downloaded in a single command. If multiple download types are entered, the DESTINATION parameter cannot be entered.

The DESTINATION parameter can be used to enter the PC file name.

Examples:

All PC files created with a Natural ISPF DOWNLOAD command can be processed by the UPLOAD command.

EDIT / E

Starts an edit session with the specified object. If the object does not exist, it is created.

Examples:

ENTRY / EN

The ENTRY command displays the Entry Panel for the specified object type, for example, the command:

EN NAT

displays the Natural Objects Entry Panel. Usually, the system administrator uses this command in menu definition (see the section Menu Maintenance in the Natural ISPF Administration Guide). When working with Natural ISPF, you will normally display an Entry Panel by selecting an option from the Main Menu.

If you use this command as a line command (EN), you can select a specific object from a list. This invokes the Entry Panel for the object type, with the parameter fields filled with the selected object's parameter values. This makes it easy to start sessions with objects with similar names.

See the subsection ENTRY as Line Command in the section Useful Features for an example.

EXECUTE / XE

Executes the specified Natural object. The object must be cataloged (CATALOG or STOW command). If the object is a macro object, the generated output is written to the user workpool (see also the section Macro Facility in the Natural ISPF Programmer's Guide).

Example:

The command:

XE N NATLIB(MYPROG)

executes the Natural object MYPROG in library NATLIB.

EXPORT / EX

Exports the specified object to the specified target environment (PC or Con-nect). For more details, including command syntax and available keywords, see the subsection Natural Interface to External Environments in the section Useful Features.

Example:

The command:

EX P MY.ONLY.SOURCE(MYMEM),PC

opens a window in which you can specify the PC file name under which the PDS member MYMEM in library MY.ONLY.SOURCE is to be downloaded.

When you use the EXPORT command from an Editor session, the shortest possible abbreviation is EXP.

EXTENTS / ET

The EXTENT command displays the extents for a specific dataset, giving the disk address and cylinder size of each one.

Example:

The command:

ET D MBE.COMN.SOURCE

displays extent information for dataset MBE.COMN.SOURCE. For an example of the EXTENTS command, see the section z/OS Objects in this documentation.

EXTERNS / XT

Displays all external references to a load module or CSECT (z/OS only).

Example:

The command:

XT P MBE.COMN.LOAD(NATPARM)

displays a list of external references to the load module NATPARM in the load library MBE.COMN.LOAD. For an example, see the subsection Load Modules and CSECTs in the section z/OS Objects.

FOLLOW / FL

Instructs Natural ISPF to report progress of the specified job. The status message remains in the message line until the job is in the output queue or until job execution has been completed. You can discontinue the status reports by using the command FOLLOW OFF.

Example:

The command:

FL J ISPINT

reports the status of job ISPINST in an z/OS environment every time you invoke another system screen. If there is more than one copy of the same job, you are notified with a message, and the copy submitted last is selected.

If you use the FOLLOW command without parameters, the job submitted last from Natural ISPF is the default.

FORMAT

This function command applies only to Natural objects of the type map. The map layout is displayed in a Natural ISPF Editor session. Modifiable fields (AD=A and AD=M) are replaced by a special filler character which is the underscore (_). Variable output fields (AD=O) are replaced by a period (.) .

Example:

The command:

FR ISPN---1

displays the map layout in an Editor session.

HOLD / HL

Issued for a job, this command puts the SYSOUT of the specified job on hold.

Example:

The command:

HL J ISPINST

puts the SYSOUT of job ISPINT on hold.

The HOLD command is also available for the current version of an object. Placing a member in HOLD status means that it is not counted as an existing version and will not be automatically deleted as further versions of the member are created. For more information and an example, see the subsection Versioning in the section Useful Features.

INFORMATION / I

Displays information about the specified object.

Example:

The command:

I N NATLIB(NATPROG)

displays information about Natural object NATPROG in library NATLIB.

LIST / L

Displays a list of specified objects. You can select an object from a list for further handling using appropriate line commands (abbreviations of function commands).

Examples:

OUTPUT / OT

Displays the output of CA Panvalet or CA Librarian protocol after a member is saved and refers to the member saved most recently.

Examples:

PLAY / PL

Executes the specified member as a Natural ISPF command script.

Example:

The command:

PLAY N MYLIB(SCRIPT)

executes the Natural member SCRIPT in the library MYLIB as Natural ISPF commands. For more information and examples of command scripts, see the subsection Executing Command Scripts in the section Useful Features.

The commands described below can be entered interactively but they are meant to be used in Natural ISPF command scripts.

PRINT / PR

Prints the specified object at the hard copy device selected as follows:

• Printer specified in the function parameters;

• Printer specified by name in your user profile;

• Printer specified by name in your user group profile (for example, if your user ID is ABC, profile A*);

• Printer specified in prompt window that appears if an asterisk (*) is specified as printer in your user profile;

• If no printer specification is made in your user profile, the printer defined in your TP environment;

• If no printer is defined in your TP environment, the printer specified by the Natural profile parameter PRINTER2.

Examples:

Printing from an Editor Session

1. Issue the PRINT command from an Editor session with the object in EDIT or BROWSE mode to print the member;

   Note
   When issuing the PRINT command from an Editor session, the current boundary settings (BNDS Editor command) are respected: only the data within the set boundaries are printed.

2. Use the Editor line command P to print the selected line, or mark the first and the last lines of a block of text with the Editor PP line command to print the block from the member;

When issuing a PRINT command from an Editor session, you can use the special parameter ASIS as follows:

PRINT,ASIS

• If a printer is defined in your Natural ISPF profile, the whole Editor session is printed, including header, prefix, etc.

• If an asterisk (*) is defined as printer in your Natural ISPF profile, you are prompted with the following window:

  +-----------Print parameters------------+ ! ! ! Lines per page : 60 ! ! Take linesize from ! ! edit session : X ! ! or screensize : ! ! Print prefix : X ! ! Enter printer : _________ ! ! Listname : ________ ! ! Form : ____ ! ! Disp : L___ (D/H/K/L) ! ! Copies : (0-255) ! ! Log.-Driver : ________ ! ! Print via NOM : (Y/N) ! +---------------------------------------+

Meaning of the input fields:

PURGE / PG

Purges the SYSOUT of a job from the job entry queue.

Example:

The command:

PG DJ ISPINST

purges the SYSOUT of job ISPINST from a job entry queue.

RELEASE / RL (Member: RELEASE)

Releases a job, its output or a specific SYSOUT file (object-type S, z/OS only) from HOLD status (when job has been held explicitly) or from Hold Queue (when job output is associated with a held output class).

Available function parameter (optional):

Examples:

Examples for use with function command syntax:

Similar considerations apply for use as line command (RL).

RENAME / RN

Renames the specified object to the new name specified in the function parameters. If you enter the RENAME command without the function parameter, a window is opened in which you can specify the new name.

Examples:

RUN / RU

Compiles and executes the specified Natural program. If the program uses the macro facility or contains the INCLUDE-MACRO statement, the macros are executed and the output is written to the user workpool.

STATUS / ST

Displays a status message of the specified job.

Example:

The command:

ST J ISPINT

reports the status of job ISPINST in an z/OS environment. If there is more than one copy of the same job, you are notified with a message, and the copy submitted last is selected.

If you use the STATUS command without parameters, the job submitted last from Natural ISPF is the default.

SUBMIT / SB

Submits the specified object to the operating system. You can follow the submitted job with the FOLLOW and STATUS commands. If the job control contains macros, expansion is performed before submission, provided that the macro expansion has been activated in your current User Defaults profile (see the subsection User Defaults in the section Profile Maintenance). In this case, you can access the submitted object in the WORKPOOL facility.

The SUBMIT command can be issued with the following function parameters:

Examples:

UNCATALOG / U

Uncatalogs the specified Natural object or dataset.

Example:

The command:

U N NATLIB(MYPROG)

uncatalogs Natural program MYPROG.

UPLOAD

In addition to the IMPORT command, which is a local command in the Editor and handles text only, the UPLOAD command also uploads binary data. Currently it is available for the following Natural ISPF objects:

The command format is:

UPLOAD object-type object-id, SOURCE BINARY OBJECT FROM=file.ext REPLACE=YES

The keywords SOURCE BINARY OBJECT are evaluated for Views and Natural members only. They have no meaning when uploading PDS members. Any combination of these keywords can be entered in one command, allowing Natural source and object to be uploaded in a single command. If multiple upload types are entered, the FROM parameter cannot be entered.

The FROM parameter can be used to enter the PC file name. The REPLACE parameter can be used to overwrite an existing object.

Upload of a load module with REPLACE=YES should not be interrupted, because the old module is deleted before starting the upload from PC.

Examples:

ZAPS / ZP

Displays a list of Zaps applied to the specified load module or CSECT (z/OS only).

Examples:

Local Commands - Description

Local commands are object-specific and can be issued only when displaying an object in Editor format in LIST, EDIT or BROWSE mode. If you enter an asterisk (*) in the command line, a window opens that lists all valid local commands and you can select a command for execution. Some local commands are available only in LIST mode, others only in EDIT or BROWSE mode.

This subsection describes all local commands in alphabetical order according to object type. Valid abbreviations of local commands are indicated in the command title.

All Objects that can be Edited

COPY

Copies a specified object into the current edit session. The place at which the copied object is to be inserted must be marked by appropriate Editor line commands (A, B, O or OO). The following object types can be copied:

You can issue the COPY local command with full name parameters, for example:

COPY MAC library (name)

If you issue the COPY command without parameters, you are prompted for object type and name. For special considerations that apply when copying Natural objects and views, see the subsection Natural Objects and the subsection Natural Views in the section Common Objects.

IMPORT / IM

Copies the specified PC file or Con-nect document into the edit area. If the edit area already contains data, you must mark the place at which you want the file or document copied with Editor line commands A (after this line) or B (before this line).

The command format is:

IMPORT [CNT / CONNECT]
       [PC]

Prompt windows open to prompt you for identifiers of the file or document you wish to copy.

For more information, including examples, see the subsection Natural Interface to External Environments in the section Useful Features.

To import Natural objects in binary form, use the UPLOAD command as described in the section Function Commands.

SET

Opens a window with your current edit profile. You can modify any parameter by overtyping the value.

The command format is:

SET

Lists of Objects

ALL

Executes a command or command sequence for all objects shown in the list. For details, see the subsection ALL Command for Lists in the section Useful Features.

The command format is:

ALL command-string

LAYOUT

Opens a window in which you can define a new layout for the list. For details, see the subsection LAYOUT Command for Lists in the section Useful Features.

The command format is:

LAYOUT

RELIST

Rebuilds the list to reflect changes from line commands such as DELETE, RENAME or EDIT. For details, see the subsection RELIST Command for Lists in the section Useful Features.

The command format is:

RELIST

SORT

When displaying lists of objects, you can use the Editor SORT command with special parameters:

SORT [column-header] [a] [d]

Where a is ascending order (default), d is descending order and column-header is the string of the column header according to which the items in the list are to be sorted. For details, see the subsection SORT Command for Lists in the section Useful Features.

Views - object type V

GENERATE / GEN

Issued from a view definition displayed using the DEFINITION function command, generates data definition statements for a Natural source.

Natural Objects object types N and MAC - in LIST mode

CATALL

Catalogs multiple Natural objects displayed in a list. The command format is:

CATALL [name] [type]

where name can be an optional name pattern, and type an optional Natural object type.

Examples:

Natural Objects object types N and MAC - in EDIT mode

CATALOG / CAT

Stores the edited Natural member in object form only (the source remains unchanged).

CHECK / C

Checks syntax of current Natural object. If the object is a macro-type program, only a check of processing statements and variables to be substituted is performed. The CHECK local command does not check that the lines generated by the macro are valid Natural source. To do this, execute the macro, and copy its generated output from the user workpool as a Natural program into a Natural library (see the subsection User Workpool in the section Common Objects).

OUTPUT

Starts an edit session with the output of the current program in the user workpool (only valid after a RUN command issued from the edit session).

REGENERATE / REG

Available for Natural programs written using the Edit macro option. Reexecutes the specified macro object and writes the result in the current edit session. Any defined user code remains in place. For details, see the section Macro Facility in the Natural ISPF Programmer's Guide.

STOW 'text'

Stores the Natural program in source and object form. The text parameter is relevant when stowing the program with versioning on: you can specify a reason for changing the program. The text must be enclosed in quotation marks.

STRUCT

Performs structural indentation of Natural source statements and identifies any structural inconsistencies. This command does not apply to macro objects.

SM

Enables/disables structured mode. The command format is:

SM [ON]
   [OFF]

TYPE

Specifies Natural object type. The command format is:

TYPE t

where t can be any of the following:

Natural Error Messages - in BROWSE or EDIT mode

NEXT

Job SYSOUT - object type S

Job SYSOUT is displayed in BROWSE mode only.

FILE

Selects SYSOUT file for display. The command format is:

[FILE] [SI] [n]
       [SO]
       [SM]
       [CC]
       [JL]

where n stands for file number.

NEXT

Selects next SYSOUT file for display.

PREV

Selects previous SYSOUT file for display.

Library Members and Sequential Files - in EDIT mode

The following commands apply to object types PDS, MEM, DS, FIL and BF.

PASSWORD

This command is available when editing files that are password-protected for update.

The command format is:

PASSWORD password

Use this command to enter the valid password in order to update the protected file.

REGENERATE / REG

Available for source members written using the Edit macro option. Reexecutes the specified macro object and writes the result in protected lines in the current edit session. Any defined user code remains in place. For details, see the section Macro Facility in the Natural ISPF Programmer's Guide.

SUBMIT

If the member contains JCL, you can submit the job to the operating system from the edit session with the SUBMIT local command.

Online Help Facility and UINFO Texts

UP LEVEL or BACK

When scrolling help or information screens, you can use the UP command with the parameter LEVEL to move directly to the next higher level in the screen hierarchy.

The command format is:

UPLEVEL
BACK

Assuming the UP command is assigned to PF7, you can type L in the command line and press PF7.