Altering and Deleting Spoolfiles [ Controlling System Activity ] MPE/iX 5.0 Documentation
Controlling System Activity
Altering and Deleting Spoolfiles
This section describes the use of the SPOOLF command to alter and delete
spoolfiles. The command can be executed by a user with OP capability or
by any other user meeting the capability requirements.
SPOOLF Syntax
[[ {spoolid }]]
{[[IDNAME= {(spoolid[,spoolid]...)}]]}
{[;ALTER ]}
{[ ]}
{[[ {[select-eq] }] ]}
{[[;SELEQ= {^indirect_file}] ]}
{[[ {ldev }] ]}
{[[;DEV={devclass}] ]}
{[[ {devname }] ]}
{[[;PRI=outpri] ]}
{[[;COPIES= numcopies] ]}
{[[;SPSAVE] ]}
{[[{;DEFER }] ]}
{ [{;UNDEFER}] }
{[[ {fileset }]]}
SPOOLF {[[IDNAME= {(fileset[,fileset]...)}]]}
{[;PRINT ]}
{[[ {ldev }] ]}
{[[;DEV= {devclass}] ]}
{[[ {devname }] ]}
{[[;PRI=outpri] ]}
{[[;COPIES= numcopies] ]}
{[[;SPSAVE] ]}
{[[{;DEFER }] ]}
{[[{;UNDEFER}] ]}
{[[ {spoolid }]]}
{[[IDNAME= {(spoolid[,spoolid]...)}]]}
{[;DELETE ]}
{[[ {select-eq }] ]}
{[[;SELEQ= {^indirect_file}] ]}
{[[;SHOW] ]}
Table 5-12. SPOOLF Parameters
---------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
---------------------------------------------------------------------------------------------
| | |
| spoolid | One or more spoolfile IDs: #Innn for input spoolfiles or #Onnn for |
| | output spoolfiles. These IDs are assigned by the spooling subsystem |
| | at spoolfile creation time. The # is optional. So is the O if you |
| | are displaying output spoolfiles; that is, if you specify neither |
| | [#O] nor [#]I, [#]O is assumed. |
| | The symbol @ may be used to specify all spoolfiles. |
| | The symbol O@ may be used to specify all output spoolfiles. |
| | The symbol I@ may be used to specify all input spoolfiles. |
| | If @, O@, or I@ is specified, it must be the only value supplied. |
| | @, O@, and I@ are mutually exclusive. |
| | |
| | The default is all the spoolfiles created by the current |
| | user.account. The default spoolid for the console user is all the |
| | spoolfiles on the system. |
| | |
| | If you specify duplicate spoolids, a warning message is displayed. |
| | |
---------------------------------------------------------------------------------------------
| | |
| fileset | Specifies the set of files to be modified. This positional parameter |
| | has this form: |
| | |
| | filename[/lockword[.groupname[.accountname]]] |
| | |
| | Wildcarding is supported; however, all files in the fileset must be |
| | output spoolfiles. If a file is not an output spoolfile, the print |
| | option on that file fails and the command continues on the rest of |
| | the files, if any. |
| | |
| | If the file name or set is not fully qualified, the default is the |
| | user's current logon group and account. If any file in the set has a |
| | lockword, it must be supplied with the command in batch mode; |
| | therefore, the file cannot be part of a wildcarded set. This |
| | restriction does not apply in interactive mode because the system |
| | prompts the user for each required lockword. In any case, if the |
| | lockword is not correctly provided, the print option on that file |
| | fails with a warning message, and the command continues on the rest |
| | of the files, if any. There is no default. |
| | |
---------------------------------------------------------------------------------------------
Table 5-13. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| select-eq | The selection equation is used as a filter on the set of |
| | spoolfiles selected. Only spoolfiles whose attributes satisfy |
| | all filter requirements are listed. |
| | |
| | Selection equations have the following format, displayed in a |
| | pseudo-BNF (Backus-Naur Form) grammar: |
| | |
| | select-eq ::= [equation] |
| | |
| | A selection equation must begin with "[" and end with "]". |
| | |
| | |
| | { condition } |
| | { (equation) } { AND} |
| | equation ::= { NOT equation } LOP ::= { OR } |
| | { equation LOP equation} |
| | |
| | |
| | NOTE: AND takes precedence over OR. |
| | |
| | * condition ::= parm ROP value |
| | |
| | * condition ::= parm ROP value |
| | |
| | * parm ::= The parameter (PARM) may be one of the following |
| | attributes of the spoolfile to be altered or deleted: |
| | |
--------------------------------------------------------------------------------------------
| | |
| DEV | Ldev number, device name, or device class name. Wildcarding is |
| | supported for device name and device class name. |
| | |
--------------------------------------------------------------------------------------------
| | |
| FILEDES | Formal file designator for the spoolfile. For example, if you |
| | enter the file equation below and print to it, "EPOCLONG" will |
| | be the spoolfile's FILEDES. |
| | |
| | FILE EPOCLONG;DEV=EPOC;ENV=LPLONG.ENV.SYS |
| | PRINT MYFILE,*EPOCLONG |
| | |
| | Wildcarding is supported. |
| | |
| | NOTE: This keyword supports selection on the null string by |
| | entering FILEDES= "" (you may also use single quotes). you must |
| | include such a construct if you specifically want to select on |
| | such an attribute. Note that "" is not the same as " ". The |
| | blank is significant. |
| | |
--------------------------------------------------------------------------------------------
Table 5-14. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| SPOOLID | Spoolfile identifier number in the format #Onnn or #Innn. |
| | |
| | The "#" is optional; but if it is used, an O or I must also be |
| | used. If it is no used, the "O" is also optional for output |
| | spoolfiles; that is 123 = #O123. The valid range of spoolids is |
| | from 1 to 9999999. |
| | |
| | Limited wildcarding is supported: |
| | |
| | The symbol @ may be used to specify all spoolfiles. |
| | |
| | The symbol O@ may be used to specify all output spoolfiles. |
| | |
| | The symbol I@ may be used to specify all input spoolfiles. |
| | |
--------------------------------------------------------------------------------------------
| | |
| PAGES | Number of pages in spoolfile (if known). Use a positive integer |
| | number. |
| | |
| | NOTE: This attribute does not apply to input spoolfiles; |
| | therefore, any logical condition involving the attribute always |
| | returns FALSE when tested against an input spoolfile. |
| | |
--------------------------------------------------------------------------------------------
| | |
| FORMID | Form name. Wildcarding is supported. (The formid is an ASCII |
| | string up to 8 characters, the first of which must be a |
| | letter.). See the NOTE accompanying the FILEDES and PAGES |
| | description. |
| | |
--------------------------------------------------------------------------------------------
| | |
| STATE | READY, ACTIVE, OPEN, CREATE, PRINT, PROBLM, DELPND, SPSAVE, |
| | DEFER. |
| | |
--------------------------------------------------------------------------------------------
| | |
| JOBNAME | Job or session name under which the spoolfile was created. The |
| | job name can consist of up to 8 alphanumeric characters, the |
| | first of which must be a letter. |
| | |
| | For job input spoolfiles, the JOBNAME and JOBNUM shown are those |
| | allocated to that job, not those of the job or session which |
| | streamed it. |
| | |
| | Wildcarding is supported. |
| | |
--------------------------------------------------------------------------------------------
| | |
| DISP | Disposition: SPSAVE or PURGE. See the NOTE accompanying the |
| | PAGES description. |
| | |
--------------------------------------------------------------------------------------------
| | |
| COPIES | Number of copies. Minimum is 1, maximum is 65535. See the NOTE |
| | accompanying the PAGES description. |
| | |
--------------------------------------------------------------------------------------------
| | |
| PRI | Output priority (minimum is 0, maximum is 14), or input priority |
| | (minimum is 1, maximum is 14). See the NOTE accompanying the |
| | PAGES description. |
| | |
--------------------------------------------------------------------------------------------
Table 5-15. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| JOBNUM | Job or session number under which the spoolfile was created, for |
| | example: #S257 or #J329 (the "#" is optional). The limits are |
| | 1 and 16,383. |
| | |
| | Limited wildcarding is supported; J@ accepts all jobs, S@ all |
| | sessions. |
| | |
--------------------------------------------------------------------------------------------
| | |
| RECS | Number of records in the spoolfile. A positive integer is |
| | expected. |
| | |
--------------------------------------------------------------------------------------------
| | |
| OWNER | The user under which the spoolfile was created. The format of |
| | the OWNER is user.account. If the account is not specified, the |
| | user's current account is assumed. Wildcarding is supported. |
| | |
--------------------------------------------------------------------------------------------
| | |
| JOBABORT | Select based on whether this is the $STDLIST of a job that |
| | aborted when an error was encountered when no "CONTINUE" was in |
| | effect. |
| | |
| | Valid values are "TRUE" and "FALSE". Only "=" and "<>" are |
| | allowed as relational operators. See the NOTE accompanying the |
| | PAGES description. |
| | |
--------------------------------------------------------------------------------------------
| DATE | Creation date in the format mm/dd/yy or mm/dd/year. Note that |
| | the year can be in the form of yy, as in 10/10/88, or in the |
| | form of year, as in 10/10/1988; both are legal syntax for the |
| | DATE parameter. |
| | |
| | |
| | { > } |
| | { >=} |
| | { < } |
| | ROP ::= { <=} |
| | { <>} |
| | { = } |
| | |
| | |
| | |
| | NOTE: For string types other than DATE, such as user name, only |
| | the relational operators "=" and "<>" are applicable. Using any |
| | others results in an error. |
--------------------------------------------------------------------------------------------
Table 5-16. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description value ::= Appropriate values per data type. |
| | |
--------------------------------------------------------------------------------------------
| | |
| indirect_file | Specifies the name of a file containing the selection equation. |
| | It must be preceded by a caret (^). The selection equation |
| | contained in the file may not exceed 277 characters in length, |
| | including the brackets in which it must reside. There is no |
| | restriction on the indirect file code. If the record size |
| | exceeds 277, only 277 characters per record are read and a |
| | warning is issued. Backreferencing to a formal file designator |
| | is also allowed for an indirect_file name; that is, ^*filename |
| | is also allowed. Any file is accepted as an indirect_file, |
| | unless the file system returns an error from FOPEN or FREAD. |
| | |
| | There is no limit to the number of records in the indirect_file, |
| | only the total character count. Records are processed as |
| | follows: |
| | |
| | Leading and trailing blanks are stripped. If the last non-blank |
| | character is an ampersand (&), it is also stripped; otherwise |
| | one blank is added back to the end of the record as a delimiter. |
| | The character count of the record is added to that of the |
| | records processed previously. If the total character count |
| | exceeds 277, an error is returned. If the total is less than |
| | 277, the current record is appended to previous records. This |
| | process repeats until either 277 characters have been counted or |
| | the end-of-file is detected. Records terminating with or |
| | without ampersands may be mixed as desired in the indirect file. |
| | |
| | |
| | If the resulting string is <=277 characters, it is parsed. If |
| | the parser detects a syntax error, or if any non-blank character |
| | follows the closing bracket (]) of the seleq, an error is |
| | returned and the seleq is not processed. |
| | |
--------------------------------------------------------------------------------------------
| | |
| ALTER | The ALTER option alters the characteristics of specified output |
| | spoolfiles. Private output spoolfiles may be altered in a |
| | limited fashion; only the keywords PRI, DEFER, and UNDEFER are |
| | allowed. A system manager (SM) user may also specify DEV=. |
| | |
| | You cannot alter the attributes of saved spoolfiles. |
| | |
--------------------------------------------------------------------------------------------
Table 5-17. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| PRINT | The PRINT option copies the specified filesets to the HPSPOOL |
| | account and links the copies into the spool queues for printing. |
| | |
| | |
| | If the target device or class information exists in the file |
| | label extension, that device or class is used as the default. |
| | The DEV= option may be used to override this default. If there |
| | is no target device in the file label extension, the DEV= |
| | parameter must be specified or an error message results. The |
| | default values of PRI (8) and COPIES (1) may also be overridden |
| | by user-specified parameters. |
| | |
| | The user of the SPOOLF...; PRINT command must have ND |
| | capability. Private files cannot be printed using the PRINT |
| | command. |
| | |
--------------------------------------------------------------------------------------------
| | |
| DELETE | The DELETE option purges all specified private or non- private |
| | spoolfiles to which the user has access from the system. |
| | |
| | If a spoolfile is not in use (opened by a user, or being printed |
| | or stored), it is purged immediately. If it is in use, it is |
| | placed in DELPND state. Any spooler process printing it is |
| | notified, and printing stops at that point. Each of these files |
| | is deleted when its last user (except STORE) closes it. |
| | |
| | STORE introduces a unique situation. If a spoolfile is being |
| | stored when anyone requests that the file be deleted, the file |
| | is placed in DELPND, as described above, but it cannot be purged |
| | by closing the file because it is still in use by STORE. |
| | However, STORE does not purge the file when it finishes with it |
| | (unless STORE's user has specified the PURGE option) because it |
| | accesses the file at a level lower than that known by the NMS |
| | file management routines. Such a file remains in the DELPND |
| | state until one of the following occurs: |
| | |
| | |
| | * Someone opens it and closes it (with PURGE or SPOOLF; |
| | DELETE). |
| | |
| | * STORE completes and the PURGE option was selected. |
| | |
| | * It is resurrected (made ready) by raising the number of |
| | copies such that after the SPOOLF...;ALTER completes, the |
| | number of copies to be printed exceeds the number already |
| | printed. |
| | |
| | The DELETE option works on either DATA input spoolfiles in the |
| | READY state, or all output spoolfiles in the READY, PRINT, |
| | DEFER, SPSAVE or PROBLM state. It does not work on job $STDIN |
| | files; use the ABORTJOB command for these files. |
| | |
--------------------------------------------------------------------------------------------
Table 5-18. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| ldev | Specifies the logical device number of the spoolfile's new |
| | destination device. |
| | |
| | If the spoolfile is in the PRINT state, it is returned to the |
| | READY state. It may immediately enter the PRINT state on ldev |
| | if all requirements are met. Note that this occurs even if ldev |
| | is the same as the device currently printing the file. |
| | |
--------------------------------------------------------------------------------------------
| | |
| devclass | Specifies the new destination device class name for the |
| | spoolfile. If the spoolfile is in the PRINT state, it is |
| | returned to the READY state. It may immediately enter the PRINT |
| | state on a device in devclass if all requirements are met. Note |
| | that this occurs even if the result is no change in output |
| | device. |
| | |
| | devclass must begin with a letter and consist of eight or fewer |
| | alphanumeric characters. Note that MPE XL does not allow the |
| | same name to be configured as a device class name and a device |
| | name. |
| | |
--------------------------------------------------------------------------------------------
| | |
| devname | Specifies the device name of the spoolfile's new destination |
| | device. If the spoolfile is in the PRINT state, it is returned |
| | to the READY state. It may immediately enter the PRINT state on |
| | devname if all requirements are met. Note that this occurs even |
| | if devname is the same as the device currently printing the |
| | file. |
| | |
| | devname must begin with a letter, and consist of eight or fewer |
| | alphanumeric characters. Note that MPE XL does not allow the |
| | same name to be configured as a device class name and a device |
| | name. |
| | |
--------------------------------------------------------------------------------------------
| | |
| outpri | Specifies the output priority of the designated spoolfiles, |
| | where 0 is the lowest and 14 is the highest. Only an OP user or |
| | the console can specify an outpri of 14; other users are limited |
| | to 13. The default is 8 with the PRINT option, and no change |
| | for the ALTER option. |
| | |
--------------------------------------------------------------------------------------------
| | |
| numcopies | Specifies the number of copies of the designated spoolfiles to |
| | be printed. The allowable range is 1 through 127. The default |
| | is 1 for the PRINT option, and no change for the ALTER option. |
| | |
--------------------------------------------------------------------------------------------
Table 5-19. SPOOLF Parameters Continued
--------------------------------------------------------------------------------------------
| | |
| Parameter | Description |
| | |
--------------------------------------------------------------------------------------------
| | |
| SPSAVE | The SPSAVE option specifies that the selected spoolfiles are not |
| | be deleted after their last copy has printed. Instead they are |
| | retained in the HPSPOOL account in the SPSAVE state until |
| | deleted manually. Among other advantages, this option allows |
| | documents to be copied to user filespace and reprinted without |
| | being reformatted. PRIVATE spoolfiles may not be saved. |
| | |
| | When a file enters the SPSAVE state, its priority is set to 8 |
| | and its number of copies is set to 1. This is so that it will |
| | have the proper defaults should it be printed later. |
| | |
--------------------------------------------------------------------------------------------
| | |
| DEFER | The DEFER option changes the spoolfile's state to DEFER. If it |
| | is currently in the PRINT state, its spooler is notified and |
| | printing stops at that point. The spoolfile's priority remains |
| | unchanged. If this option is used with the PRINT option, the |
| | spoolfile is copied to OUT.HPSPOOL and linked to the spooling |
| | system, but the state of the spoolfile is DEFER. The spoolfile |
| | is not printed until a subsequent SPOOLF...;UNDEFER is entered. |
| | |
| | |
| | IF the DEFER option is used on any file in the CREATE state |
| | (opened for original creation), the spoolfile only enters the |
| | DEFER state after it is completed (closed for the last time). |
| | |
--------------------------------------------------------------------------------------------
| | |
| UNDEFER | The UNDEFER option changes a spoolfile's state from DEFER to |
| | READY and causes a spooler to start printing it if the spoolfile |
| | is qualified for an idle printer to print. The spoolfile's |
| | priority remains unchanged. |
| | |
--------------------------------------------------------------------------------------------
| | |
| SHOW | The SHOW option allows a user to display the results of the |
| | SPOOLF command. All other parameters are processed before the |
| | SHOW command. Here is an example: |
| | |
--------------------------------------------------------------------------------------------
Altering Spoolfile Characteristics
The ALTER option of the SPOOLF command is used to alter the
characteristics of a spoolfile. You can use it to defer printing to a
later time, change priority to print sooner, send the file to a different
printer, or print additional copies.
Altering Spoolfile Output
To alter spoolfile 480 to device LP, enter:
SPOOLF IDNAME=480;ALTER;DEV=LP
IDNAME is a required parameter, although the word IDNAME is not
necessary. For example:
To alter spoolfile 480 to device LP, enter:
SPOOLF 480;ALTER;DEV=LP
You may also string multiple spoolfile identifiers in the IDNAME
parameter as in the following example:
SPOOLF 480,481,482;ALTER;DEV=LP
Defer Printing with ALTSPOOLFILE
To defer the currently ACTIVE file being output to logical device 6 (a
line printer), enter:
ALTSPOOLFILE 6;DEFER
The DEFER option places the ACTIVE file in the READY state and lowers its
output priority to 0 (lowest priority). The file will print only when
the priority is raised above the OUTFENCE.
Change Print Priorities with ALTER Option
To change the priority of deferred device file #O930 from 0 to 3 and
display change, enter:
SPOOLF 0930;ALTER;PRI=3;SHOW
The system displays:
______________________________________________________________________________
| |
| |
| SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER |
| |
| #O930 J'5 $STDLIST 3 1 LP READY SYS.MANAGER |
| |
______________________________________________________________________________
Direct Output to a Different Printer
Enter LISTSPF to list device characteristics and confirm the device class
as LP (line printer). Then, use ALTER option to send the output to a
different printer.
LISTSPF
The system displays:
________________________________________________________________________________
| |
| |
| SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER |
| |
| #0930 J1 $STDLIST 3 1 LP READY MANAGER.SYS |
| #O2 J2 $STDLIST 2 1 LP READY MANAGER.SYS |
| #O3 J3 $STDLIST 2 1 LP READY MANAGER.SYS |
| #O4 J7 $STDLIST 2 1 LP READY MANAGER.SYS |
| |
| INPUT SPOOL FILES OUTPUT SPOOL FILES |
| ACTIVE = 0; CREATE = 0; |
| READY = 4; |
| OPEN = 0; DEFER = 0; SELECTED = 0; |
| READY = 0; DELPND = 0; SPSAVE = 0; |
| PRINT = 0; |
| PROBLM = 0; |
| |
| TOTAL IN FILES = 0; TOTAL OUT FILES = 4; |
| IN SECTORS = 0; OUT SECTORS = 672; |
| |
| OUTFENCE = 7 |
| |
________________________________________________________________________________
To change the printer to the device class PP (page printer) enter:
SPOOLF 0930;ALTER;DEV=PP;SHOW
The SHOW option is used to verify the change.
The system displays:
__________________________________________________________________________________
| |
| |
| SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER |
| |
| #O930 J'19 $STDLIST 2 1 PP READY MANAGER.SYS |
| |
__________________________________________________________________________________
In this example, the file status is READY. Had it been ACTIVE, the
spooler printing the file would stop printing and the file would restart
(from the beginning) on a device in device class PP.
Print Multiple Copies with ALTER Option
To use ALTER option to print more than one copy of a spoolfile with an
output device file ID of #O14, enter:
SPOOLF 0930;ALTER;COPIES=2
To confirm the change, enter:
LISTSPF
The system displays:
__________________________________________________________________________________
| |
| |
| SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER |
| |
| #O930 J'19 $STDLIST 2 2 PP READY MANAGER.SYS |
| |
__________________________________________________________________________________
The column headed #C indicates two copies for spoolfile #O14. Since #O14
is at priority 1, the spoolfile will print only if the priority is raised
above the OUTFENCE. In this example the OUTFENCE is 7, so the spoolfile
must be altered to priority 8 to print.
Delete a READY Spoolfile
To delete a READY output spoolfile, you must use the output device file
identification (#Onnn) with the DELETE option command. Enter:
SPOOLF 0930;DELETE;SHOW
Delete a Spoolfile in the PRINT State
Use the ldev number with the DELETE option command. Enter:
SPOOLF Onnn;DELETE;SHOW
The system displays this message:
SPOOLFILE IS ACTIVE ON LDEV 6, DELETED.(CIWARN 3207)
MPE/iX 5.0 Documentation