The Spoolfile Interface Facility (SPIFF) (Continued) [ Native Mode Spooler Reference Manual ] MPE/iX 5.5 Documentation
Native Mode Spooler Reference Manual
The Spoolfile Interface Facility (SPIFF) (Continued)
SPIFF commands (Continued)
PURGE.
Deletes one or more spool files from the system.
Syntax.
{spoolfileid [,spoolfileid [,...]]}
> P[URGE] {* }
{{username[.acctname]} [;{ASK}] }
{{seleq } [ {YES}] }
Parameters.
spoolfileid An existing spoolid to which the user has access. This
parameter must begin with a number or with a pound sign
(#). The full syntax is [#O]nnnnn, where the n's represent
digits. If the # is used, the O must also be used. If the
O is used without the #, the parameter is interpreted as a
user name and will probably cause an error.
* The current spool file--one that has been explicitly TEXTed
in, or that is current because it is the last spool file
processed by the COPY, APPEND, or BROWSE command. If this
form is used without a current spool file, an error message
is displayed.
username The name of a user on the system. Full MPE wildcarding is
supported. This parameter, when used with the optional
acctname, specifies the set of spool files to be purged.
The SPIFF user must have access to files generated by
username. Refer to "Security" .
acctname The name of an account on the system. Full MPE wildcarding
is supported. Default: the logon account is assumed.
This parameter, when used with the username, specifies the
set of spool files to be purged. The SPIFF user must have
access to files generated by users in acctname. Refer to
"Security" .
__________________________________________________________
NOTE Because files in the CREATE state cannot be
deleted, SPIFF inserts a STATE <> CREATE in its
internal selection equation when processing a
username[.acctname] specification.
__________________________________________________________
seleq A native mode spooler selection equation specifying the set
of spool files to delete. The selection equation must be
enclosed in brackets as in the following example that
purges all spool files created by the user MANAGER.SYS with
priority less than 3:
PURGE [OWNER=MANAGER.SYS AND PRI<3]
If you choose this (seleq) form of file set selection,
SPIFF inserts an OWNER=!HPUSER.!HPACCOUNT in its internal
selection equation, unless you explicitly include your own
OWNER definition. This prevents users with SM, OP, or AM
capabilities from accidentally accessing files that they
did not create.
Because files in the CREATE state cannot be deleted, SPIFF
inserts a STATE <> CREATE in its internal selection
equation even if you explicitly include your own STATE
definition.
Consult one of the following documents for more information
about selection equation syntax and semantics:
* MPE/iX Commands Reference Manual Volumes 1 and 2
(32650-60115)
* MPE/iX online help facility
ASK/YES Once purged, spool files cannot be recovered unless an
archive copy has been made. These optional keywords
provide an interactive precaution against unintended
deletion of spool files. If either keyword is specified
with the spoolfileid or with *, a warning is displayed and
the keyword is ignored.
This parameter is in effect whenever SPIFF is run
interactively.
Omitted The user is presented with one list of all of
the spool files selected for purging and is
asked to approve the operation. This is an
"all or nothing" choice. It is intended for
users who are reasonably sure of the set of
spool files to be deleted.
Responding Y[ES] purges all of the selected
spool files.
Responding with N[O], E[ND], or CtrlY exits
the command without deleting the spool files.
ASK The user is presented with each spool file as
it is encountered and is asked to approve the
deletion.
Responding Y[ES] purges the spool file.
Responding N[O] leaves the spool file
unchanged.
Responding with E[ND], or CtrlY exits the
command without deleting the spool file.
YES SPIFF purges all of the selected spool files
without confirmation from the user.
When SPIFF is run non-interactively, it is impossible to
conduct a confirmation dialog. Examples of non-interactive
operation include running SPIFF in a job or with redirected
$STDIN or $STDLIST. In such cases, SPIFF operates as though
YES had been specified.
Operation Notes.
The PURGE command (abbreviated P) marks one or more spool files for
deletion from the system, displaying identifying information (in LISTSPF
format) for each marked spool file. The user may specify that SPIFF
pause to confirm the deletion(s).
Note that spool files in the CREATE state (OPEN as displayed by SHOWOUT)
cannot be purged.
If the spool file is your current text file, it will be closed. If you
are the last (or only) accessor, the file is also purged at this time.
If the spool file is currently opened by another process, it will not be
purged until its last accessor closes it. The resulting display shows
the spool file(s) in the DELPND state.
If the PURGE command has paused for a user response to any purge
confirmation, entering CtrlY terminates the command without purging any
more files.
Examples.
Assume that spoolid's #O7788 and #O7789 exist, and that the user has
access to them:
PURGE #O7788
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O7788 S64 MYFILE 2 1 PP DELPND MYUSER.MYACCT
TEXT 7789
PURGE *
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O7789 S64 MYFILE 2 1 PP DELPND MYUSER.MYACCT
PURGE *
You have no current TEXT file. (SPERR 81)
The following examples assume that you are MGR.ACCT (the manager of an
account), and that you have AM capability.
> PURGE USER1.ACCT
The following spoolfiles have been selected for purging:
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O452 J265 $STDLIST 2 1 PP READY USER1.ACCT
#O781 J518 $STDLIST 2 1 PP READY USER1.ACCT
#O779 J514 $STDLIST 2 1 PP READY USER1.ACCT
#O782 J520 $STDLIST 2 1 PP READY USER1.ACCT
#O784 J524 $STDLIST 2 1 PP READY USER1.ACCT
Purge all spoolfiles shown (Y/[N]) Y
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O452 J265 $STDLIST 2 1 PP DELPND USER1.ACCT
#O781 J518 $STDLIST 2 1 PP DELPND USER1.ACCT
#O779 J514 $STDLIST 2 1 PP DELPND USER1.ACCT
#O782 J520 $STDLIST 2 1 PP DELPND USER1.ACCT
#O784 J524 $STDLIST 2 1 PP DELPND USER1.ACCT
> PURGE [(OWNER=USER2.ACCT) AND (PRI <=2)];ASK
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O557 J354 $STDLIST 2 1 LP READY USER2.ACCT
Purge this spoolfile (Y/[N])? Y
#O569 J365 $STDLIST 2 1 LP READY USER2.ACCT
Purge this spoolfile (Y/[N])? N
Spoolfile not deleted (SPWARN 228)
#O612 J394 $STDLIST 2 1 LP READY USER2.ACCT
Purge this spoolfile (Y/[N])? Y
#O613 J394 $STDLIST 2 1 LP READY USER2.ACCT
Purge this spoolfile (Y/[N])? E
>
QUIT.
Terminates SPIFF and returns control to its parent process.
Syntax.
> Q[UIT]
Operation Notes.
The QUIT command (abbreviated Q) terminates the SPIFF process. If a file
has been opened by the TEXT command, it is closed before SPIFF
terminates. Control is returned to SPIFF's parent process. This is
usually a command interpreter, but may be another application if that
application supports creation of a child process. In particular, SPIFF
may be run from within another copy of SPIFF, using the RUN command.
QUITing the second copy of SPIFF returns control to the first instance of
SPIFF.
The QUIT command and the EXIT command operate identically.
NOTE It is not possible to suspend operation of a child SPIFF process,
give control to a parent SPIFF process, and return to the child
SPIFF process, as the SPOOK5 program used to do. Each exit of a
child process terminates that process and closes all open files
associated with that process. Each child process starts afresh
when created. As a result, the KILL command is not supported by
SPIFF.
SHOW.
Displays information about one or more spool files.
Syntax.
[spoolfileid [,spoolfileid [,...]]]
[* ]
> S[HOW] [ [ [@]] ]
[[username[.acctname]] [;[I]] ]
[[seleq ] [ [O]] ]
Parameters.
none Displays all spool files (input and output) belonging to
the logon user in the logon account.
spoolfileid An existing spoolid to which the user has access. To be
taken as a spoolid (instead of a username), this
parameter must begin with a number or with a pound sign
(#). The full syntax is [#O]nnnnn or [#I]nnnnn, where
the n's represent digits. If the # is used, the O or
"I" must also be used. If the O or "I" is used without
the #, the parameter is interpreted as a username and
will probably cause an error. Default: All output
spool files created by the logon user in the logon
account.
* The current spool file--one that has been TEXTed in, or
is current because it is the last spool file processed
by the COPY, APPEND, or BROWSE command. If this form is
used when no spool file has been TEXTed, an error
message is displayed.
When this parameter is specified, the current spool file
is displayed using LISTSPF's DETAIL (two-line) display
format.
username The name of a user on the system. Full MPE wildcarding
is supported. The SPIFF user must have access to files
generated by username. Refer to "Security" .
acctname The name of an account on the system. Full MPE
wildcarding is supported. Default: the logon account
is assumed. The SPIFF user must have access to files
generated by users in acctname. Refer to "Security"
.
seleq A native mode spooler selection equation specifying the
set of spool files to be shown. The selection equation
must be enclosed in brackets as in the following example
that displays all spool files created by the user
MANAGER.SYS with priority less than 3:
SHOW [OWNER=MANAGER.SYS AND PRI<3]
If you choose this (seleq) form of file set selection,
SPIFF inserts an OWNER=!HPUSER.!HPACCOUNT in its
internal selection equation, unless you explicitly
include your own OWNER definition. This prevents users
with SM, OP, or AM capabilities from accidentally
accessing files that they did not create.
Consult one of the following documents for more
information about selection equation syntax and
semantics:
* MPE/iX Commands Reference Manual Volumes 1 and 2
(32650-60115)
* MPE/iX online help facility
@ Displays selected files using LISTSPF's DETAIL
(two-line) format. Omitting this parameter displays
selected files in LISTSPF's one-line format. @ is valid
only when selecting files with username.acctname or with
seleq.
I Restricts display to input spool files. I is valid only
when selecting files with username.acctname or with
seleq.
O Restricts display to output spool files. O is valid
only when selecting files with username.acctname or with
seleq.
NOTE You may specify both I and O to display both input and output
spoofiles. This is equivalent to specifying neither.
Operation Notes.
The SHOW command (abbreviated S) displays attributes of one or more spool
files using the MPE/iX LISTSPF command format. The display may be in
either the one-line or two-line format of the LISTSPF command, according
to your specification of the SHOW command:
1. The two-line format is produced in either of these cases:
SHOW spoolfileid (or a list of spoolfileids), or SHOW *.
SHOW username.acctname or seleq with the ;@ option.
2. The one-line format is produced in all other cases.
When the username.acctname or seleq form is used, the @, I, and O
keywords may be used in any combination or repeatedly. Once used, each
parameter enables its option for the duration of the command and cannot
be disabled. Thus @IOI@OO@I and @@@@@@@@ are both valid.
Examples.
SHOW ;O
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#O7817 J166 $STDLIST 2 1 LP CREATE MYUSER.MYACCT
#O7820 S104 MYFILE 2 1 PP READY MYUSER.MYACCT
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 1; READY = 1;
OPEN = 0; DEFER = 0; SELECTED = 0;
READY = 0; DELPND = 0; SPSAVE = 0;
PRINT = 0; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 0; TOTAL OUT FILES = 2;
IN SECTORS = 0; OUT SECTORS = 2128;
OUTFENCE = 6
> SHOW *
You have no current TEXT file. (SPERR 81)
> TEXT 7820
> SHOW *
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
FORMID JOBNAME COPSRM SECTS RECS PAGES DATE TIME
#O7820 S104 MYFILE 2 1 PP READY MYUSER.MYACCT
1 80 234 ~4 01/07/92 08:42
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 0; READY = 1;
OPEN = 0; DEFER = 0; SELECTED = 0;
READY = 0; DELPND = 0; SPSAVE = 0;
PRINT = 0; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 0; TOTAL OUT FILES = 1;
IN SECTORS = 0; OUT SECTORS = 80;
OUTFENCE = 6
> SHOW MYUSER.MYACCT;@O
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
FORMID JOBNAME COPSRM SECTS RECS PAGES DATE TIME
#O7817 J166 $STDLIST 2 1 LP CREATE MYUSER.MYACCT
MYJOB 1 2048 0
#O7820 S104 MYFILE 2 1 PP READY MYUSER.MYACCT
1 80 234 ~4 01/07/92 08:42
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 1; READY = 1;
OPEN = 0; DEFER = 0; SELECTED = 0;
READY = 0; DELPND = 0; SPSAVE = 0;
PRINT = 0; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 0; TOTAL OUT FILES = 2;
IN SECTORS = 0; OUT SECTORS = 2128;
OUTFENCE = 6
>
STORE.
Stores one or more files to tape using the MPE/iX STORE subsystem.
Syntax.
{spoolfileid [,spoolfileid [,...]]}
> ST[ORE] {username[.acctname] }
{seleq }
[;store_option [;store_option [;...]]]
Parameters.
spoolfileid An existing output spoolid to which the user has access.
To be taken as a spoolid (instead of a username), this
parameter must begin with a number or with a pound sign
(#). The full syntax is [#O]nnnnn, where the n's represent
digits. If the # is used, the O must also be used. If the
O is used without the #, the parameter is interpreted as a
username and will probably cause an error.
username The name of a user on the system. Full MPE wildcarding is
supported. The SPIFF user must have access to files
generated by username. Refer to "Security" .
acctname The name of an account on the system. Full MPE wildcarding
is supported. Default: the logon account is assumed. The
SPIFF user must have access to files generated by users in
acctname. Refer to "Security" .
seleq A native mode spooler selection equation specifying the set
of spool files to store. The selection equation must be
enclosed in brackets as in the following example that
stores all spool files created by the user MANAGER.SYS with
priority less than 3:
STORE [OWNER=MANAGER.SYS AND PRI<3]
If you choose this (seleq) form of file set selection,
SPIFF inserts an OWNER=!HPUSER.!HPACCOUNT in its internal
selection equation, unless you explicitly include your own
OWNER definition. This prevents users with SM, OP, or AM
capabilities from accidentally accessing files that they
did not create.
Consult one of the following documents for more information
about selection equation syntax and semantics.
* MPE/iX Commands Reference Manual Volumes 1 and 2
(32650-60115)
* MPE/iX online help facility
store_option Any MPE/iX STORE subsystem option. The first option should
specify either an output device, such as a tape drive, or
be left empty (but with the semicolon to mark its
position). Refer to the Storing Files and Backing Up the
System Reference Manual (32650-90140) for a full list of
available options.
Operation Notes.
SPIFF's STORE command (abbreviated ST) is an interface to the MPE/iX
STORE subsystem that allows fileset selection by specific spoolfileid(s),
username.acctname, or seleq. This augments normal MPE/iX STORE fileset
wildcarding with attributes specific to spool files.
The chosen set of spool files are listed to an internal temporary
indirect file, which is then passed to the MPE/iX STORE subsystem along
with any store_options, such as ;SHOW.
Examples.
STORE MYUSER.MYACCT;*MYTAPE;SHOW
(Output from STORE's SHOW option is not listed here.)
STORE [DATE < 01/08/92 AND OWNER=MYUSER.MYACCT];;SHOW;PURGE
Notice the empty tape file specifier. (Output from STORE's SHOW option
is not listed here.)
MPE/iX 5.5 Documentation