 |
» |
|
|
|
Produces a listing of input and output spooled files. (Native
Mode) Parameter Definitions | |
- spoolid
One or more spool file IDs: #Innn
for input spool files or #Onnn for output
spool files. These IDs are assigned by the spooling subsystem at
spool file creation time. The # is optional; but if it is used,
an O or I must also be used. If it is not used, the O is also optional
for output spool files; that is, if neither [#]O nor [#]I is specified,
then [#]O is assumed. The symbol @ may be
used to specify all spool files. The symbol O@ may be used to specify all output
spool files. The symbol I@ may be used to specify all input spool
files. If @, O@, or I@ is specified, it must be the only
SPOOLID value
supplied. @, O@, and I@ are mutually exclusive. If you specify duplicate SPOOLIDs,
the system displays a warning message.
A user with SM or OP capability or a console user who specifies
O@ will see all output spool files on the system. A user with AM
capability who specifies O@ will see all output spool files created
by users in the same account. All other users are limited to files
they have created. Similar rules apply to I@ and @. The default
is all the output spool files created by the current user.account.
The default SPOOLID
for the console user is all the output spool files on the system. - select-eq
The selection equation is used as a filter on the
set of spool files selected. Only spool files whose attributes satisfy
all filter requirements will be listed. When you use a selection equation, enclose the entire equation
in square brackets, and enclose individual keyword specifications
(such as PAGES<100)
in parentheses. For example, you use the following command to display
all the output spool files from user.acct
that have less than 100 pages: LISTSPF O@;SELEQ=[(OWNER=user.acct)AND(PAGES<100)] |
If you are not an SM, OP, AM, or console user, the following
command displays all the output files in your default group with
a priority greater than 2 that were created before September 30,
1994. LISTSPF O@;SELEQ=[(PRI>2)AND(DATE<09/30/94)] |
Selection equations have the following format. The symbol
::= should be interpreted as "can be replaced by". equation ::= { parm { > >= < <= <> = }value (equation) NOT equation equation { AND OR }equation } In a selection equation, the logical operator AND
takes precedence over the logical operator OR.
For example, suppose you enter the following command: LISTSPF O@;SELEQ=[FILEDES=REPT OR OWNER=BOB.ACCTG AND PRI>8] |
In this example, the selection equation [FILEDES=REPT OR OWNER=BOB.ACCTG AND PRI>8]
is the same as [FILEDES=REPT OR (OWNER=BOB.ACCTG AND PRI>8)]. value ::= Appropriate values per
data type. For example, STATE=READY
or PRI>6. parm ::= The parameter (parm)
may be one of several attributes of the spool file, used as filters.
The parm choices are described below. parm ::=
DEV: LDEV number,
device name, or device class name. You can use wildcards for device
name and device class name. parm ::= FILEDES:
Formal or actual file designator for the spool file. You may use
wildcards. For example, if you enter the file equation below and print
to it, EPOCLONG becomes the spool file's FILEDES. FILE EPOCLONG;DEV=EPOC;ENV=LPLONG.ENV.SYS
PRINT MYFILE,*EPOCLONG |
You may also select files based on a null string by entering
FILEDES= "" or
FILEDES= ''.
You must include such a construct if you specifically want to select
such an attribute. Note that ""
is not the same as " ";
the blank is significant. parm ::= SPOOLID:
Spoolfile identifier number in the format #Onnn
or #Innn. The "#" is optional; but if it is used, an O (for output)
or an I (for input) must also be used. If # is not used, the O is
also optional for output spool files; that is 123 is the same as
#O123. The valid range of SPOOLIDs
is 1 ≤ nnn ≤ 9,999,999.
(The commas are for clarity; do not enter any commas in the actual
equation.) parm ::= PAGES:
Number of pages in the spool file (if known). A positive integer
number is expected. This attribute does not apply to input spool
files; therefore, any logical condition
involving the attribute always returns FALSE when tested against
an input spool file. parm:= FORMID:
Form name. You can use wildcards. (The formid
is an ASCII string up to 8 characters, the first of which must be
a letter.). This attribute does not apply to input spool files; therefore,
any logical condition involving the attribute
always returns FALSE when tested against an input spool file. You may also select files based on a null string by entering
FILEDES= "" or
FILEDES= ''.
You must include such a construct if you specifically want to select
such an attribute. Note that ""
is not the same as " ";
the blank is significant. parm:= STATE:
The state can be one of READY, ACTIVE, OPEN, CREATE, PRINT, PROBLM, DELPND, SPSAVE, DEFER, XFER. parm ::= JOBNAME:
Job or session name under which the spool file was created. The
job name can consist of up to 8 alphanumeric characters, the first
of which must be a letter. For a job input spool file, the JOBNAME
shown is allocated to that job, not the job
or session that streamed it. You may use wildcards. The JOBNAME=@
parameter is a different use of the @
symbol in that it wildcards an optional field. The omission of this
optional parameter indicates that all entries are displayed whether
or not a job name exists. parm ::= DISP:
Disposition: SPSAVE
or PURGE. This
attribute does not apply to input spool files; therefore, any logical
condition involving the attribute always
returns FALSE when tested against an input spool file. parm ::= COPIES:
Number of copies. Minimum is 1, maximum is 65,535. This attribute does not apply to input spool files; therefore,
any logical condition involving the attribute
always returns FALSE when tested against an input spool file. parm ::= PRI:
Output priority. Minimum is 0, maximum is 14. parm ::= JOBNUM:
Job or session number under which the spool file was created, for
example: #S257, #J329, or Sn (the "#"
is optional) where 1 ≤ n ≤
16,383. (The comma is shown for clarity; do not enter any commas
in the actual equation.) For a job input spool file, the JOBNUM
shown is allocated to the job, not the job
or session that streamed it. You may use some wildcards; J@ accepts all jobs, S@ accepts
all sessions. J'@ and S'@ are also allowed, The apostrophe (') indicates
an imported spool file or a spool file recovered during START NORECOVERY. parm ::= RECS:
Number of records in the spool file. A positive integer is expected. parm ::= OWNER:
The user under which the spool file was created. The format of the
owner is user.account.
If the account is not specified, the user's current account is assumed.
You can use wildcards. For a job input spool file, the OWNER
is the user logon for the job, not the job
or session that streamed it. parm ::= JOBABORT:
Select based on whether or not this is the $STDLIST
of a job which aborted when an error was encountered but no CONTINUE
was in effect. Valid values are TRUE and FALSE. Only "=" and "<*gt;"
are allowed as relational operators. This attribute does not apply to input spool files; therefore,
any logical condition involving the attribute
always returns FALSE when tested against an input spool file. parm ::= 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.
- ^indirect_file
The indirect_file parameter
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 509
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 509, only 509 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 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 nonblank 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 509, an error is returned. If the total is less than 509,
the current record is appended to previous records. This process repeats until either 509 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 ≤509 characters,
it is parsed. If the parser detects a syntax error, or if any
non-blank character follows the closing bracket (]) of the select-eq,
an error is returned and the select-eq
is not processed.
- DETAIL
Produces a two-line description of the specified
spool file(s). The default is a one-line display (not detailed). - STATUS
By default, LISTSPF
displays a listing of selected spool files, followed by a statistical
summary of those spool files, known as the status display. Specification of the STATUS
option causes only the status summary to be displayed summarizing
the specified fileset. STATUS
and DETAIL cannot
be specified together.
Operation Notes | |
This command is provided to enable users to obtain a list
of spool file information without having to look for it within a
list that includes other files. The display for LISTSPF
is different from the SHOWIN/SHOWOUT
display. LISTSPF
displays both output and input spool files. The display shows output
spool files, then input spool files, and finally a summary status
display. The parameters are divided into three groups: selection, detail
and status. The selection group allows a user to limit the display of
spool files to a subset of the overall group of spool files on the
system. The detail parameter displays more than the default information
on the files that have been selected. The status parameter displays summary status only. These parameters can be combined as desired except for ;DETAIL
and ;STATUS,
which are mutually exclusive. This command displays status information for one or more spool
files. The information reflects the status at the time the command
is entered and always appears on the standard list device. You may
use CI I/O redirection to redirect the output to a file. Within device or device class, READY,
CREATE, PRINT,
and XFER state
output spool files are displayed first, sorted by priority and then
by date and time. Output spool files in DEFER,
PROBLM, or SPSAVE
states are shown next sorted by order of state and then priority
and time. Output spool files are displayed first, followed by input
spool files and the status display. The display for input spool
files is not sorted. Display Field and Description | |
Below is an example of the first line of the display for LISTSPF.
Following the example is a description of each field in the display. SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#01 J12345 $STDLIST 6 1 EPOC CREATE RSPFN THISUSER.ACCOUNT1 |
- SPOOLID
The unique spool file identifier. - JOBNUM
The job or session identifier of the job or session
that created the spool file. The exception to this is that the jobnum
for a JOB input
spool file is the job number assigned the process whose $STDIN
is (or will be) this input spool file, as opposed to the jobnum
of the process that streamed the job. Job numbers containing an
apostrophe (i.e., J'123) indicate that the spool file was imported
by SPFXFER, RESTORE,
or was recovered after a START NORECOVERY. - FILEDES
The formal or actual file designator for the spool
file. Printing to a file equation such as FILE EPOCLONG;DEV=EPOC;ENV=LP88LONG.HPENV.SYS
creates spool files whose formal designator is EPOCLONG. - DEV
The LDEV, device name or device class name that
is the destination of the spool file. LDEVs are intentionally displayed
with leading zeroes to simulate a device name. When you specify
LDEVs with SELEQ,
you need not supply the leading zeroes. - PRI
The input or output priority of the spool file. - COPIES
The total number of copies of the spool file to
be printed. - STATE
The current state of the spool file. READY
and DELPND apply
to input spool files as well as output spool files. CREATE:
An output spool file is being created; that is, an output spooled
device has been opened and is being written to, generating an output
spool file. When the device is closed, the spool file enters the
READY state. READY:
An output spool file is ready to be printed or an input spool file
is ready to be accessed. ACTIVE:
An input spool file is active when it is being read from a STREAM
file or a spooled device to disk. OPEN:
A JOB input spool
file (the $STDIN
for a batch job) is being accessed by the job's CI process or a
DATA input spool
file is being accessed by a process. PRINT:
An output spool file is being printed. If you enter the LISTSPF
command while a trailer is being printed, you may observe two spool
files in the PRINT
state at the same time for the same device. This is because the
spooler must open its next file to print before printing the trailer
of its current one. (This is required to manage headers and trailers
properly). Also note that you see only one file in the PRINT
state during a trailer if the next file is another copy of the current
file. DEFER:
An output spool file is in the deferred state. SPSAVE:
The SPSAVE option
was specified when the spool file was created or at any time before
it would have been deleted after its final copy was printed. That
final copy has been printed, so the spool file is now in this state
instead of being deleted. PROBLM:
The target device of the spool file does not match any device name
or device class on the system. This usually occurs because the spool
file has been restored to a system that has a different configuration
than the system from which the spool file was stored. DELPND:
Either the spooler has printed the last copy of the output spool
file and is waiting for one or more users to close the spool file
before purging it, or someone has requested that the spool file
be deleted (using the DELETESPOOLFILE
or the SPOOLF...;DELETE
command) and the file management routines are waiting for the last
FCLOSE of the
spool file before purging it. XFER:
The spool file has been selected for transportation from one node
of a network to another. The XFER
state is supported (in that it may be displayed, and used as a STATE
in a selection equation), but is provided only for use as desired
by third-party software providers. The spooler never places a file
in this state nor uses the state as a basis for spooler actions.
- RSPFN
The column under each letter R, S, P, F, and N,
contains the respective letter as a flag indicating something about
the spool file described in that row. R
indicates a restartable spooled job file, that is, one for which
the ;RESTART
option was specified in the :JOB
record. S
indicates that SPSAVE
disposition has been specified for this spool file. The spool file
will be saved in the OUT.HPSPOOL
group and account after the last copy is printed. P
indicates that the spool file is private. F
indicates that the spool file has a forms message associated with
it and requires special forms on which to print. If a formid
is present, its identity can be seen, using the ;DETAIL
option, on the second line of the display for the given spool file. N
indicates that the spool file is not complete because insufficient
account-level, group-level or system disk space was available when
the spool file was created or the system aborted while the spool
file was being created.
- OWNER
This is the fully qualified name of the creator
of the spool file.
Below is an example of the optional second line of the display,
followed by an explantion of each display field. FORMID JOBNAME COPSRM SECTS RECS PAGES DATE TIME
TESTJOB 1 250 500 ~9 12/20/88 8:39
|
- FORMID
An 8-character display, the first of which is a
letter. If an F appears in the RSPFN
column but this field is blank, it means that the file has a forms
message but formid was not specified. - JOBNAME
The job or session name of the user who created
the spool file or, for a job input spool file, the name of the job
that will use the input spool file as its $STDIN
file.. - COPSRM
The number of copies of this file that remain to
be printed, including any currently printing copy. - SECTS
The number of sectors occupied by the spool file. - RECS
The number of records in the spool file. - PAGES
The number of physical pages in the spool file.
This quantity is accurate only for CIPER protocol, 2680/88 page
printers, and HP5000/F1xx page printers, and then only if the device
has printed at least one complete copy. The device keeps track of
the pages as they are printed and returns the correct count at the
end of the copy. Until the actual count is known, an approximate
count calculated as number_of_records
÷ 60, and denoted by a leading tilde (~) is displayed. For serial printers, even the count without the tilde is approximate
because it is calculated as a best guess from the spool file data.
It is not returned by the device because serial printers have no
provisions for reporting this information. - DATE
The date that the file first entered the READY state
(mm/dd/yy). - TIME
The time that the file first entered the READY state
in 24-hour form (hh:mm). - STATUS
The status display has the following format: INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 1; CREATE = 2; READY = 3;
OPEN = 2; DEFER = 1; SELECTED = 4;
READY = 3; DELPND = 0; SPSAVE = 1;
PRINT = 1; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 6; TOTAL OUTFILES = 8;
IN SECTORS = 144; OUT SECTORS = 13090;
OUTFENCE = 6
OUTFENCE = 10 FOR LDEV 6 |
This display consists of three parts. The values in the first
two parts represent only those spool files selected for display. The itemized count of spool files
in each of the various states. They are shown in two groups, input
spool files to the left of the display and output spool files to
the right. Of these, only SELECTED
is not a state. Instead, SELECTED
shows the total count of spool files whose output priority is higher
than the global outfence; that is, SELECTED
displays the sum of printing files plus those READY
files whose output priority is above the global outfence. The total number of input spool files, the sector
count for input spool files, the total number of output spool files,
and the sector count for output spool files. The global outfence and any device-specific outfences.
Use | |
This command may be issued from a session, job, a program,
or in BREAK. It is breakable. Only files to which the user has access
are displayed. Examples | |
Following are some examples of the displays produced by LISTSPF.
The first and third examples display all output spool files for
the current user.account not using the console.
The second example displays all spool files for the current user.account
not using the console.
LISTSPF
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
#0123 J12 SP 13 2 PP PRINT F DEV.HPE
#0124 S14 LIST 9 1 00000012 READY F DEV.HPE
#0128 J144 $STDLIST 8 1 EPOC READY DEV.HPE
#01233 S1234 OUTLIST 0 1 FASTLP DEFER DEV.HPE
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 0; READY = 2;
OPEN = 0; DEFER = 1; SELECTED = 3;
READY = 0; DELPND = 0; SPSAVE = 0;
PRINT = 1; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 0; TOTAL OUTFILES = 4;
IN SECTORS = 0; OUT SECTORS = 5964;
OUTFENCE = 6
:LISTSPF @;DETAIL
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER
FORMID JOBNAME COPSRM SECTS RECS PAGES DATE TIME
#O123 J12 SP 13 2 PP PRINT F DEV.HPE
TESTJOB 1 250 500 125 07/09/88 8:39
#O124 S14 LIST 9 1 00000012 READY F DEV.HPE
PAYCHECK TESTJOB 1 250 500 ~9 12/20/88 8:39
#O128 J144 $STDLIST 8 5 EPOC READY DEV.HPE
LPJOB 3 250 127 21 12/20/88 22:19
#O1233 S1234 OUTLIST 0 1 FASTLP DEFER DEV.HPE
TESTJOB 1 250 500 ~9 12/20/88 8:39
#I564 J164 $STDIN 00000010 READY DEV.HPE
BATCHJOB 17 12 2/20/88 22:23
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 0; READY = 2;
OPEN = 0; DEFER = 1; SELECTED = 3;
READY = 1; DELPND = 0; SPSAVE = 0;
PRINT = 1; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 1; TOTAL OUT FILES = 4;
IN SECTORS = 17; OUT SECTORS = 1000;
OUTFENCE = 6
:LISTSPF;STATUS
INPUT SPOOL FILES OUTPUT SPOOL FILES
ACTIVE = 0; CREATE = 0; READY = 2;
OPEN = 0; DEFER = 1; SELECTED = 3;
READY = 0; DELPND = 0; SPSAVE = 0;
PRINT = 1; XFER = 0;
PROBLM = 0;
TOTAL IN FILES = 0; TOTAL OUTFILES = 4;
IN SECTORS = 0 ; OUT SECTORS = 1000;
OUTFENCE = 6
|
Related Information | |
- Commands
SPOOLER,
SPOOLF, SHOWIN,
SHOWOUT, LISTFILE - Manuals
Native Mode Spooler Reference Manual(32650-90166)
|
