Viewing Data About Spool Files

Use the LISTSPF command to display information about input and output spool files. The set of spool files that you are allowed to see depends on your capabilities.

The general form of the LISTSPF command appears below. For a detailed explanation of this command and its parameters refer to chapter 4.

   LISTSPF[ [IDNAME=]  {spoolid

                        (spoolid [,spoolid]...)}]



   [ [;SELEQ=] {select-eq

                ^indirect_file  }]  [;DETAIL

                                 ;STATUS]

Viewing specific spool files

Use the LISTSPF command with the IDNAME parameter, followed by the numeric spool file identifier, to display information about a specific output spool file. You can use this command if

you created the spool file.
you are the account manager (AM) of the creator's account.
you have system manager (SM) or system operator (OP) capability.
you are the console user.

For example, to view data about output spool file 357, you would enter:

   LISTSPF IDNAME=O357

Or, you may omit the keyword IDNAME and the O, and enter the command this way:

   LISTSPF 357

Note that if you omit the O, by default an output SPOOLID is assumed. To specify input SPOOLIDs, you must precede each identifier with I.

If there is more than one file you want information about, you can string together the SPOOLIDs on the command line like this:

   LISTSPF IDNAME=357,375,458

Or, by grouping multiple ID names within parentheses you may omit the IDNAME keyword:

   LISTSPF (357,375,458)

Viewing multiple spool files

Use the following command to display information about multiple spool files (those spool files residing in IN.HPSPOOL and OUT.HPSPOOL):

   LISTSPF @

This command displays information for the following:

All spool files in IN.HPSPOOL and OUT.HPSPOOL, if you are the console user, or if you have SM or OP capability.
All spool files created by any user in your logon account, if you have AM capability.
All spool files in your user.account, if you are a user other than a console user.

If you are the console user, to display information about all output spool files, you may also enter:

   LISTSPF

If you are not the console user, you can use this same command to display information about all output spool files for your user.account.

Using wildcards to specify spool files

You may use wildcards in specifying the SPOOLID in the following way:

@

Specifies all spool files if you are the console user or have SM or OP capability.
Specifies input and output spool files by any user of your logon account if you have AM capability.
Specifies all spool files for your user.account if you are any other user.

O@

Specifies all output spool files if you are the console user or have SM or OP capability.
Specifies all output spool files created by any user of your logon account if you have AM capability.
Specifies all output spool files for your user.account if you are any other user.

I@

Specifies all input spool files if you are the console user or have SM or OP capability.
Specifies all input spool files created by any user of your logon account if you have AM capability.
Specifies all input spool files for your user.account if you are any other user.

@, O@ and I@ are mutually exclusive. In other words, you may use only one at a time.

If you are the console user or a user with SM or OP capability and you want to obtain information about all output spool files, enter:

   :LISTSPF O@

If you are a user with AM capability, the LISTSPF O@ command displays all output spool files created by users in your account. If you are any other user, the LISTSPF O@ displays all the output spool files for your user.account.

If you are not the console user and do not have SM or OP capability, to obtain information about input spool files for your user.account, enter:

 

   :LISTSPF I@

If you are the console user or you have SM or OP capability, LISTSPF I@ displays all input spool files. If you have AM capability, LISTSPF I@ displays all input spool files created by any user in your logon account.

Viewing spool file subsets

A useful feature of the LISTSPF command is the ability to define or select a subset of spool files for which to obtain information. This is accomplished by using a selection equation with the ;SELEQ= parameter.

For example, suppose that you are the console user and you want to display spool file information for all output spool files with an output priority of less than 8. You would enter the selection equation shown below (including the brackets):

   :LISTSPF;SELEQ=[PRI < 8]

If you have AM capability, this command displays information for all output spool files created by users in your logon account; otherwise, it displays information for all output spool files in your user.account.

Using AND and OR in the selection equation

You may use the logical operators AND and OR in the selection equation. If you use AND and OR in the same selection equation, AND takes precedence over OR unless you use parentheses to indicate otherwise. The files for which you see information depends upon whether or not you are using the console. If you are the console user, you will see information for all spool files that match the selection criteria. If you are not, you will see information for all output spool files created by your user.account.

For example, to display information for all output spool files that have an output priority less than 8 and that were sent to LDEV 6, you would enter:

   :LISTSPF;SELEQ=[PRI < 8 AND DEV = 6]

Or, for example, to display information for all output spool files with priority less than or equal to 10 or with destination device EPOC you would enter:

   :LISTSPF;SELEQ=[PRI <= 10 OR DEV = EPOC]

Excluding items in the selection equation

Use NOT to exclude specified items with the selection equation. You may use NOT with AND and OR.

For example, if you are the console user or if you have SM or OP capability, to select all spool files not created by MANAGER.SYS, enter:

   :LISTSPF @;SELEQ=[NOT(OWNER=MANAGER.SYS)]

Or, to select output spool files that do not have a priority of 8, enter:

   :LISTSPF;SELEQ=[NOT(PRI=8)]

Suppose that you are the console user or you have SM or OP capability. The following command line uses AND and selects all spool files created with formal file designator MRKTDATA that have not been routed to device class LP:

   LISTSPF @;SELEQ=[FILEDES=MRKTDATA AND NOT (DEV=LP)]

Suppose that you have AM capability. The following command line uses OR and selects all spool files created by users in your logon account that have priority 8 or are not in the ready state:

   LISTSPF @;SELEQ=[PRI=8 OR NOT(STATE=READY)]

Using an indirect file with a selection equation

The indirect file is a convenient way to avoid the extra keystrokes associated with often-used and complex selection equations. An indirect file is simply an ASCII file that contains the selection equation. When you use the LISTSPF command you enter the indirect file instead of the selection equation.

Suppose that you want to select all spool files sent to formal file designator MRKTDATA but not sent to device LP. You would put the selection equation shown below (including both left and right brackets ( [ ] ) into an ASCII file using any HP 3000 text processor. This ASCII file would then be your indirect file.

   [FILEDES=MRKTDATA AND NOT (DEV=LP)]

In the following example, the indirect file is named INDFILE. To use the indirect file with the LISTSPF command, enter:

   LISTSPF;SELEQ=^INDFILE

You may give your file any name that suits you. You must remember to always precede the indirect file with the ^ sign.

Using relational operators for the selection equation

You may use the following relational operators in the ;SELEQ equation:

=: equal
<>: not equal
>: greater than
>=: greater than or equal
<: less than
<=: less than or equal

Selection equation parameters

Use the relational operators with any of the following keyword parameters to construct the selection equation of your choice.

DEV *: LDEV number, device name, or device class name
FILEDES *: Formal file designator
SPOOLID *: Spool File identifier number
PAGES: Number of pages in spool file
FORMID *: Form name
STATE *: State
JOBNAME *: Job or session name
DISP *: Disposition (PURGE or SPSAVE)
COPIES: Number of copies requested
PRI: Output priority
JOBNUM *: Job or session number under which spool file was created
RECS: Number of records in spool file
OWNER *: Owner in user.account format
JOBABORT *: $STDLIST of job that aborted with no continue in effect (TRUE or FALSE)
DATE: Creation date in mm/dd/yy or mm/dd/yyyy format

Keywords marked with the asterisk (*) can only be used with two relational operators, = and <>.

Using wildcard characters in the selection equation

Wildcards are also supported in selection equations specifying owners. Use the @ sign to represent any combination of characters. For example, if you are the console user and you want to select all output spool files created by any user in the MFG account, you would enter:

   LISTSPF;SELEQ=[OWNER=@.MFG]

If you want to do the same thing but you are a user with SM or OP capability and not a console user, enter:

   LISTSPF @;SELEQ=[OWNER=@.MFG]

In a selection equation that specifies a job number, you may use J@ and S@ to specify all job numbers and all session numbers respectively. If you do not have SM, OP, or AM capability nor are you the console user, the following example displays all your spool files that were created by a job:

   LISTSPF @;SELEQ=[JOBNUM=J@]

This command displays all spool files that were created by a job if you are the console user or if you have SM or OP capability. If you have AM capability, this command displays all spool files that were created by a job in your logon account.

You may also specify a specific job or session number.

Displaying summary data about spool files

Used with only the ;STATUS option of the LISTSPF command, the display is limited to a statistical summary of spool file data, known as a status display. If you are not the console user, to see only this summary for the spool files for your user.account without listing the spool files, enter:

   :LISTSPF ;STATUS

If you are the console user, LISTSPF ;STATUS displays the status for all spool files. If you are not the console user, to see this summary for all spool files to which you have access without listing the spool files, enter:

   :LISTSPF @ ;STATUS

You cannot use ;STATUS in combination with ;DETAIL.

Displaying detailed data about spool files

To display more detailed information regarding spool files, you may add the ;DETAIL parameter to the LISTSPF command as follows:

   :LISTSPF IDNAME=O234;DETAIL

Spool file identification after a system reboot

Spool file job and session numbers are transposed from the Jnnn or Snnn format to the J'nnn or S'nnn format whenever you perform a system START with the NORECOVERY option or whenever you import files to the system with RESTORE or the SPFXFER utility.

In the above command, J@ or S@ also selects output spool files with job/session identifiers in the J'nnn or S'nnn format. Specifying J'@ or S'@ selects only spool files with J'nnn or S'nnn identifiers. You may also select a single job or session using the Jnnn, J'nnn, Snnn, or S'nnn format.

Viewing spool file data with LISTFILE

Another command that supplies information about files is the LISTFILE command. You may use this command on spool files just as you would on any other file. For example, to display all output spool files in OUT.HPSPOOL if you have access to them, enter:

   LISTFILE O@.OUT.HPSPOOL;FORMAT=5

You may use the name of a specific spool file instead of O followed by the wildcard (@).

The LISTFILE command displays MPE/iX file system characteristics such as the record size, block size, file code, security, creator, and access dates. The LISTFILE command also displays file information for those files named in the hierarchical file directories. Refer to MPE/iX Commands Reference Manual Volumes 1 and 2 (32650-60115) for more information on hierarchical files and the LISTFILE command.

FORMAT=5 is useful for spool files, both linked and unlinked, because it shows a spool file's target device. It is particularly useful for unlinked spool files since LISTSPF does not display information about them.