Generated from C.65.00 /SYSADMIN/PUB/MYCICAT last modified on Sun Aug 29 15:08:37 2004
Produces a listing of input and output spool files.
LISTSPF [[IDNAME=] { spoolid }] {(spoolid [,spoolid ]...)} [[;SELEQ=]select_eq ] {^indirect_file } [{;DETAIL}] {;STATUS}
spoolid One or more spoolfile IDs: #Innnn for input spoolfiles or #Onnnn 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 neither [#]O nor [#]I is specified, then [#]O is assumed. o If you specify multiple spoolfiles, you must separate them with commas and enclose them in parentheses. For example: LISTSPF (288,332,405);DETAIL o You may use the symbol "@" to specify all spoolfiles. o You may use the symbol "O@" to specify all output spoolfiles. o You may use the symbol "I@" to specify all input spoolfiles. o 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, the system displays a warning message. select-eq The selection equation is used as a filter on the set of spoolfiles selected. Only spoolfiles whose attributes satisfy all filter requirements will be listed. For example, you use the following command to display all the output spool files from user.account 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)] You must begin and end a selection equation with square brackets ([ and ]), and enclose parameters and their values in parentheses. The format of selection equations is shown below. Read the ::= symbol as "can be replaced by". <select-eq> ::= [<equation>] <equation> ::= {(<equation>) } {(NOT <equation>) } {<equation><AND><equation> } {<equation><OR><equation> } { } { {> } } { {>+} } { {< } } {parm {<+} value } { {<>} } { {+ } } AND takes precedence over OR. The parameter (parm) may be one of the following attributes of the spoolfile to be altered/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" becomes 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 such an attribute. Note that "" is not the same as " ". The blank is significant. SPOOLID Spoolfile identifier number in the format #Onnnn or #Innnn. 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 spoolfiles; that is 123 = #O123. The valid range of spoolids is from 1 to 9999999. PAGES Number of pages in spoolfile (if known). A positive integer number is expected. 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 NOTES accompanying the FILEDES and PAGES description. STATE READY, ACTIVE, OPEN, CREATE, PRINT, PROBLM, DELPND, SPSAVE, DEFER, XFER. 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. The JOBNAME=@ parameter is a different use of the @ symbol in that it wildcards an optional field and the omission of this optional parameter indicates that all entries are displayed whether or not a job name exists. 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. 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 which aborted when an error was encountered but 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. 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 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 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 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 SELEQ, an error is returned and the SELEQ is not processed. DETAIL Produces a two-line description of the specified spoolfile(s). The default is a one-line display (not detailed). STATUS LISTSPF, by default, displays a listing of selected spoolfiles, followed by a statistical summary of those spoolfiles, known as the STATUS display. Specification of the STATUS option with no other parameters causes only the STATUS summary to be displayed. The STATUS option is ignored (and status is displayed after the spoolfile listing) if it is used in combination with any other parameters.
LISTSPF enables users to produce a list of spoolfile information without having to look for it within a list that includes other files. The display shows output spoolfiles followed by input spoolfiles, and finally a summary status display. Command parameters are divided into three groups: selection, detail and status. o The selection group allows you to limit the display of spoolfiles to a subset of the overall group of spoolfiles on the system. o The detail parameter displays more than the default information on the files that have been selected. o The status parameter, when used without other parameters, displays summary status only. You may combine these parameters as desired, except for the DETAIL and STATUS parameters, which are mutually exclusive. This command displays status information for one or more spoolfiles. The information reflects the status at the time the command is entered. It appears on the standard list device unless you redirect the output to a file using CI I/O redirection. Within device or device class, READY, CREATE, PRINT, and XFER state output spoolfiles 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. The first line of the display for LISTSPF has the following format. Each column is explained below. SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER #O1234567 J12345 ABCDEFGH 14 1 12345678 CREATE RSPFN USER.ACCT1 #I1234567 S12345 1 127 ABCDEFGH READY 0 ACTIVE OPEN PRINT DEFER SPSAVE PROBLM DELPND XFER SPOOLID The unique spoolfile identifier. JOBNUM The job or session identifier of the job or session that created the spoolfile. The exception to this is that the JOBNUM for JOB input spoolfile is the job number assigned the process whose $STDIN is (or will be) this input spoolfile, as opposed to the JOBNUM of the process which streamed the job. FILEDES The formal file designator for the spoolfile. Printing to a file equation such as FILE EPOCLONG;DEV=EPOC;ENV=LP88LONG.HPENV.SYS creates spoolfiles whose formal designator is "EPOCLONG". DEV The LDEV, device name or device class name that is the destination of the spoolfile. PRI The input or output priority of the spoolfile. COPIES The total number of copies of the spoolfile to be printed. STATE The current state of the spoolfile. READY and DELPND apply to input spoolfiles as well as output spoolfiles. CREATE An output spoolfile is being created; that is, an output spooled device has been opened and is being written to, generating an output spoolfile. When the device is closed, the spoolfile enters the READY state. READY An output spoolfile is ready to be printed or an input spoolfile is ready to be accessed. ACTIVE An input spoolfile is active when it is being read from a STREAM file or a spooled device to disk. OPEN A JOB input spoolfile (the $STDIN for a batch job) is being accessed by the job's CI process. PRINT An output spoolfile is being printed. NOTE: If this command is entered while a trailer is being printed, you may observe two spoolfiles 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 spoolfile is in the defer state. SPSAVE The SPSAVE option was specified when the spoolfile 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 spoolfile is now in this state instead of being deleted. PROBLM The target device of the spoolfile does not match any device name or device class on the system. This usually occurs because the spoolfile has been restored to a system which has a different configuration than the system from which the spoolfile was stored. DELPND Either the spooler has printed the final copy of the output spoolfile and is waiting for one or more users to close the spoolfile before purging it, or someone has requested that the spoolfile be deleted (using the DELETESPOOLFILE or the SPOOLF...;DELETE command) and the file management routines are waiting for the last FCLOSE of the spoolfile before purging it. XFER The file is being sent from this node to another node. This state is available to applications which transmit spoolfiles over a network. Use of the state is option. RSPFN The column under each letter R, S, P, F, and N, contains the respective letter as a flag indicating something about the spoolfile described in that row. R indicates a restartable spooled job file. S indicates that SPSAVE disposition has been specified for this spoolfile. The spoolfile will be saved in the OUT.HPSPOOL account after the last copy is printed. P indicates that the spoolfile is private. F indicates that the spoolfile has a forms message associated with it, a FORMID, or both, and therefore, 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 spoolfile. N indicates that the spoolfile is not complete because insufficient account, group or system disk space was available when the spoolfile was created or the system aborted while the spoolfile was being created. OWNER This is the fully qualified name of the creator of the spoolfile. The optional second line of the display has the following format. Each column of the display is explained below. FORMID JOBNAME COPSRM SECTS RECS PAGES DATE TIME TESTJOB 1 250 500 25 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 that is not part of a FORMID specification. JOBNAME The job or session name of the user who created the spoolfile. COPSRM The number of copies of this file that remain to be printed, including any currently printing copy. SECTS The number of sectors required by the spoolfile. RECS The number of records in the spoolfile. PAGES The number of physical pages in the spoolfile. This quantity is accurate only for CIPER protocol, HP2680/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. NOTE: For serial printers, even the count without the tilde is approximate because it is calculated as a best guess from the spoolfile 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). 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 OUT FILES = 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 spoolfiles selected for display; The itemized count of spoolfiles in each of the various states. They are shown in two groups, input spoolfiles to the left of the display and output spoolfiles to the right. Of these, only SELECTED is not a state. Instead, SELECTED shows the total count of output spoolfiles in the PRINT state or READY state, and whose output priority is higher than the global outfence. The total number of input and output spoolfiles and the total sector count for all the spoolfiles displayed. The global outfence and any device-specific outfences. This command may be issued from a Session, Job, in BREAK, or from a program. It is Breakable. Only files to which the user has access are displayed.
Following are some examples of the displays produced by LISTSPF. Single Line Display (;DETAIL not specified)
SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER #0123 J12 SP 13 2 PP PRINT F DEV.HPE #0124 S14 LIST 9 1 12 READY F DEV.HPE #0128 J144 $STDLIST 8 1 EPOC READY DEV.HPE #01233 S1234 OUTLIST 0 1 FASTLP DEFER DEV.HPE #I564 J164 $STDIN 10 READY DEV.HPE 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 = 64; OUT SECTORS = 5964; OUTFENCE = 6 Two Line Display ;LISTSPF ;DETAIL SPOOLID JOBNUM FILEDES PRI COPIES DEV STATE RSPFN OWNER FORMID JOBNUM COPSRM SECTS RECS PAGES DATE TIME #0123 J12 SP 13 2 PP PRINT F DEV.HPE TESTJOB 1 250 500 125 07/09/88 8:39 #0124 S14 LIST 9 1 12 READY F DEV.HPE PAYCHECK TESTJOB 1 250 500 125 12/20/88 8:39 #0128 J144 $STDLIST 8 5 EPOC READY DEV.HPE LPJOB 3 250 127 ~14 12/20/88 22:19 #01233 S1234 OUTLIST 0 1 FASTLP DEFER DEV.HPE TESTJOB 1 250 500 125 12/20/88 8:39 #1564 J164 $STDIN 10 READY DEV.HPE BATCHJOB 17 12 12/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 OUTFILES = 4; IN SECTORS = 64; OUT SECTORS = 5964; OUTFENCE = 6 Status Display :LISTSPF ;STATUS 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 = 64; OUT SECTORS = 5964; OUTFENCE = 6
Related Commands: SHOWIN, SHOWOUT Back to Main Index