Spooler Commands

Use SETPTR to set the line printer spooler options for a logical print channel. These changes are effective until you use SETPTR again or use LOGOUT or QUIT.

Syntax

SETPTR [ channel , l.len , p.len , top , bottom , mode , options ]

  Qualifiers

All arguments are positional parameters. Each parameter is optional, but its position must be held by a comma. If you enter SETPTR with no parameters, the current settings for logical print channel 0 are displayed.

• channel - Identifies the logical print channel assigned to the printer with the ASSIGN command. Enter a number from 0 through 255. The default is 0. If you specify channel with no options, SETPTR displays the current settings for that logical print channel.
• l.len - Sets the line length, that is, the paper width. The default is 132.
• p.len - Sets the number of lines per page. The default is 66.
• top - Sets the top margin in number of lines. The default is 3.
• bottom - Sets the bottom margin in number of lines. The default is 3.
• mode - Specifies number from 1 through 5 used to direct output to one of the following places:

  Modes	Description
  1	Line Printer Spooler Output (default)
  2, 4, 6	Assigned Device. To send output to an assigned device, you must first assign the device to a logical print channel, using the ASSIGN command. The ASSIGN command does an automatic SETPTR command using the default parameters, except for mode, which it sets to 2. Use SETPTR only if you have to change the default parameters.
  3	Hold File Output. Mode 3 directs all printer output to a file called &HOLD&. If a &HOLD& file does not exist in your account, SETPTR creates the file and its dictionary (D_&HOLD&). You must execute SETPTR with mode 3 before each report to create unique report names in &HOLD&. If a report exists with the same name, the new report overwrites it.

Options can be any of the following:

• AS [ name ] - Same as BANNER.
• AT [ name ] - Routes output to system printer name.
• BANNER [ name ] - In mode 1, name appears on the second line of the banner page under the account name, that is, the login name. In mode 3, specifies the record ID of the record in &HOLD& which stores the report. If you do not specify name, the record ID is P#0000. If you specify name, it is the record ID of the output record. In either case, each subsequent print job uses the same record ID and overwrites the previous job.
• BANNER UNIQUE [ name ] - In mode 3, appends a sequential number to the name under which successive records are created in &HOLD&. If you do not specify name, the record ID is P#0000_nnnnnn, where nnnnnn is increased by each subsequent SETPTR command. If you specify name, the record ID is name_nnnnnn.
• BANNER NEXT [ name ] - In mode 3, appends a sequential number to the nameunder which successive reports are created in &HOLD&. If you do not specify name, the record ID is P#0000_nnnnnn, where nnnnnn is increased for each new print job. If you specify name, the record ID is name_nnnnnn.
• BRIEF - Suppresses the display of SETPTR settings.
• COPIES - Specifies the number of copies to print (with only one banner page).
• DEFER  time - Defers printing until time. Specify time in one of the following formats. The formats beginning with a plus sign ( + ) specify time relative to the current system time. hh:mm dd.hh:mm mm.dd.hh:mm yy.mm.dd.hh:mm dd mm.dd yy.mm.dd
  • +mm
  • +hh:mm
  • +dd.hh:mm
• HOLD - In mode 1, sends print jobs to the spooler as hold files. The spooler does not print held jobs when they are sent. You can use the PRINT.ADMIN command to print held jobs. After a held job is printed, it is removed from the spool queue.
• LNUM - Prints line numbers.
• NFMT or NOFMT - Specifies that the application controls pagination and formatting instead of the spooler.
• NOEJECT - Does not eject a page at the end of the print job.

Examples

>SETPTR 0,132,66,3,3,1
Unit Number : 0
Page Width : 132
Page Depth : 66
Top Margin : 3
Bottom Margin : 3
Print mode : 1 - Spooled Output
Default spool banner : "jbase"
OK to set parameters as displayed? Y
>SETPTR 1,21,12,3,3,1,BRIEF

Creates a new spooler structure

COMMAND SYNTAX

SP-NEWTAB (UNIX) is for Unix.

SP-NEWTAB (Windows) is for Windows.

WARNING SP-NEWTAB removes all print jobs and form queues. The STANDARD formqueue is recreated.

NOTES

This command can only be executed by root or an administrator

The default directory in which the spooler files are created is called jspooler. However, SP-NEWTAB allows a different directory to be specified. Before a user can access the spooler, its location must be specified using the environment variable JBCSPOOLERDIR. On UNIX platforms, SP-NEWTAB Prompts for the owner and group to be assigned to the spooler files. If not specified the owner is set to root and the group is set to lp.

SP-NEWTAB allows security settings for form queues and print jobs. These can be changed subsequently by using the commands SP-SECURITY, SP-SECURITY-JOBS, SP-SECURITY-OWNER and SP-SECURITY-QUEUE. Please refer to the documentation for a full discussion of the security settings.

The SP-NEWTAB command does not kill despooling daemons.

If a process was assigned to any formqueue other than STANDARD when the SP-NEWTAB command was executed, the process will be assigned to NO QUEUE.

The default formqueue STANDARD is re-initialized with a LPTR logical device type.

Displays print job status.

COMMAND SYNTAX

LISTPEQS {options}

SYNTAX ELEMENTS

EXAMPLE

# STAT LK LN STATUSES CP FO PAGES DATE      TIME     ACCT
10 xxxx x x  HOLD HS  1  2  10    31/01/95 10:42:20 SALS

• The STATUS column displays the status as per SP-JOBS and the specified assignment options.
• The FO column displays the formqueue Number.
• The PAGES column is equivalent to SP-JOBS SIZE field.
• JobNumber, Copies, Date, Time, Acct are as per SP-JOBS.

Displays printer or formqueue status

COMMAND SYNTAX

LISTPTR {options}

SYNTAX ELEMENTS

n - Displays the specified Printer/Formqueue

n-m - Displays a range of Printer/Formqueue from n to m inclusive

NOTES

LISTPTR has a JCL output interface. The status of the requested printer/formqueues is written into the secondary input buffer, separated by spaces or attribute marks depending on the type of jCL program.

EXAMPLE 1

The printer number is a reference to the Formqueue number. This number can be matched to Formqueues created with Formqueue name Fn, where n is the Form queue number. The page skip, status and device fields are as per SP-JOBS.

EXAMPLE 2

1134 1171 1 1 127 127 3

This command shows typical output to the secondary input buffer of a jCL program 1134 is the LISTPTR error message identifier. 1171 means that the printer or formqueue is inactive, the printer number is one, and the formqueue number is 1, 127 is reserved and 3 is the number of page skips.

Despools a print job to a printer or terminal attached to your current port.

COMMAND SYNTAX

PORT-DESPOOL {formqueue} {(X)}

SYNTAX ELEMENTS

formqueue is the formqueue assigned to the logical device type PORT where the output is to be despooled. If formqueue is omitted, the print queue is despooled from the first formqueue in the spooler tables that has the same logical device type, (PORT), and port number of the process which executed the PORT-DESPOOL command.

X stops the despooler after output of all queued print jobs. If you omit the X option, pressing ctrl <BREAK> must terminate the port despooler and then entering quit to the jBASE debugger Prompt.

NOTES

The PORT-DESPOOL command is a synonym for the PORTOUT command.

EXAMPLE

To use the PORT-DESPOOL command,

1. Create a formqueue with the PORT Device Type.

   If the form queue is SCREEN, there are two ways:

   • From Option 1 on the SP-STATUS menu, enter SCREEN PORT.
   • From the jShell command line, type SP-CREATE SCREEN PORT.
   In both cases, press <Enter> when you are prompted for ‘Device Name’.
2. Assign this queue using the SP-ASSIGN command (For example, SP-ASSIGN = SCREEN).
3. Create a print job (For example, type LIST. (P). 

   This sends the contents of the current directory to the spooler, specifically to the form queue SCREEN.

4. Despool this job with PORT-DESPOOL SCREEN (X.
   The spooler assignment (SP-ASSIGN = SCREEN) remains in effect until you execute another SP-ASSIGN or you terminate the current connection to jBASE.

   A common use for this is to send spooled output through the ‘aux’ (serial) port of a local pc to a ‘slave’ printer. The trouble is that ‘slave-on’ and ‘slave-off’ sequences are not generated automatically. Not to worry though, jBASE has a solution. To ‘auto generate’ slave-on/slave-off sequences you need to defined these in a spooler form-type that is assigned to the form queue. Continuing with our example of using the form queue SCREEN:

5. Assign a form-type with defines STARTJOB and ENDJOB. STARTJOB sends a ‘slave on’ message at the start of each job and ENDJOB sends a ‘slave off’ message.
6. For these two actions, create two jBASIC programs called ‘slave_on’ and ‘slave_off’ respectively:

   PROGRAM slave_on
    PRINT @(-17):
   PROGRAM slave_off
   
    PRINT @(-18):
   

7. Compile and catalog these two programs, and ensure they can be seen from the PATH environment variable.
8. Create the new form-type by copying the jspform_deflt file to a new name. This file is located in %JBCRELEASEDIR%\config directory.

   For example, on Windows, at a jShell prompt, type:

   COPY C:\JJBASE30\config jspform_deflt
   TO: jspform_port

   This assumes that jBASE was installed in the default location on Windows.

   TO: jspform_port

9. Edit the new jspform_port  file, locate the STARTJOB and ENDJOB commands, and enter the following two lines:

   STARTJOB slave_on
   ENDJOB slave_off

   Other form-type settings you might want to set at this time are WIDTH and DEPTH so that you do not have to issue these as TERM commands.]
10. Assign the new form-type to the SCREEN form queue by entering the following command at a jShell command Prompt:

    SP-TYPE SCREEN port

11. Test this with the PORT-DESPOOL command.

    SP-ASSIGN = SCREEN
    LIST . LPTR
    PORT-DESPOOL (XL

    When issuing a PORT-DESPOOL command under BASIC control, do not capture the output as this does not allow the job to be despooled.

Defines a formqueue, spooler options and number of copies to be used by subsequent print reports

COMMAND SYNTAX

SP-ASSIGN {{n}=formqueue} {options} {copies}

SYNTAX ELEMENTS

n defines the print report channel to be assigned in the range 0 to 127. The default value for n is zero. If a print report channel is specified a formqueue must also be specified.

Zero is the default print report channel number. jBASE processors such as jQL and jCL produce print reports on print channel zero. The default PRINT statement will also direct output to print report channel zero.

The SP-ASSIGN command can assign print report channels 1-127 for use within jBASE programs to direct output to separate print reports simultaneously by using the PRINT ON statement.

Print report channels of the range 128-254 are reserved.

formqueue defines the name of the formqueue to which print jobs are queued. The default formqueue is STANDARD.

The following options define the spooler assignment options, which will be assigned to the subsequent print jobs when queued to the formqueue.

RESTRICTIONS ON OPTIONS

The following combinations of spooler options are incompatible.

C or I option cannot be assigned to logical PROG device type formqueues.

The following error message appears if any illegal combinations are attempted.

INCOMPATIBLE OPTIONS: I S, C NOT I, COPIES I

NOTES

The default spooler assignment takes effect if the SP-ASSIGN command is executed without parameters. The default assignment is printing report channel zero, formqueue STANDARD, spooler options P and number of copies set to one. This is also the default spooler assignment after log on.

The options assigned using the SP-ASSIGN command remain in effect until the SP-ASSIGN command is re-executed for the same print report channel or the user logs off.

Assignment information about each print report channel is held in the spooler assignment table and can be displayed by using the SP-LOOK command.

SP-ASSIGN closes any previously open global print jobs.

Closes a global print job.

COMMAND SYNTAX

SP-CLOSE {options}

SYNTAX ELEMENTS

Options can be:

Rn limits the global close to report number n only.

n closes the specific print job number n. Use this option with care - it is normally only used to close jobs which have been left open unintentionally.

NOTES

SP-CLOSE clears the flag in the assignment environment to indicate that subsequent printer output should be directed to a new print job. The global print job is closed and queued to the despooling process.

Creates a print job containing a specified number of form feeds (pages to eject) from the printer

COMMAND SYNTAX

SP-EJECT {n}

SYNTAX ELEMENTS

n is the number of pages to eject. The default is one and the maximum is 10.

NOTES

If you specify more than the maximum allowed, only one page will be ejected.

Displays your current spooler assignments

COMMAND SYNTAX

Opens a global print job.

COMMAND SYNTAX

SP-OPEN {Rn}

SYNTAX ELEMENTS

Rn optionally limits the global open to specific report number n.

NOTES

SP-OPEN sets a flag in the assignment environment to indicate that subsequent printer output should be directed to a global print job. This print job will stay open until closed by an SP-CLOSE command, another SP-OPEN, or an SP-ASSIGN command, which uses the O option.

This command shuts down all the jBASE printer daemons. To use this command you should have Administrator privileges on Windows NT or root privileges on UNIX.

After typing the command, either of the following happens:

• The system displays the following, which means that there are no jspprint daemons running to shut down.

  *****All spooler Daemons are already shut down***** 

• The system displays a list of queues with their PID numbers shown and you will be asked if you want to shut them down. Example is shown below.

  295 - NETWORK1
  212 - LETTER1
  261 - LABEL1
  Do you wish to stop the above daemons? (Y/N): _

If you press enter or type N, the following message appears and the program exits.

*** Aborted ***

If you type Y, then the program tries to tidy shut the processes down and then sleeps for 30 seconds to allow the daemons to shut themselves down as shown below.

Do you wish to stop the above daemons? (Y/N): Y
Waiting for 30 Seconds to allow Daemons to shut down _

If this was successful, then the following message appears and the program exits.

Waiting for 30 Seconds to allow Daemons to shut down

All spooler Daemons have now shut down.

If this process was not successful, then the remaining daemons appear and you can get an option to kill the daemons as shown below.

Waiting for 30 Seconds to allow Daemons to shut down.
261 - LABEL1
The above daemons have not shut down.
Do you wish to kill them? (Y/N): _

If you hit return or type N then you will get the following message and the program will exit.

*** Aborted ***

If you type Y, then the program tries to kill the processes and you can know if the kill was successful:

The above daemons have not shut down.
Do you wish to kill them? (Y/N): Y
Printers have been successfully shut down

Alternatively, if it is unsuccessful, error message appears.

Kill was not successful errors occurred during shutdown

When the kill fails the error message, it gives before the above should be reported to your support company so it can be investigated further.

Enters the SP-STATUS menu

COMMAND SYNTAX

SP-STATUS

NOTES

Selecting this option invokes the SP-STATUS menu.

EXAMPLE

12:12:12  12 FEB 2001           QUEUE STATUS                 PAGE 1 OF 1 PAGES

 QUEUE NAME  DEVICE                   STATUS             #Q SKIP   XLT    BLKSZ
STANDARD    NT                       KILLED             0     1
cards       PROG lp -df\\ROOSTA\”HP  ACTIVE             49    1
inv         PORT                     NO DEVICE          163   1

   
  
  
 1. CREATE FORMQUEUE  4. CHANGE DEVICE      7. DELETE FORM QUEUE   10. PURGE
 2. CHANGE QUEUENAME  5. CHANGE PAGE SKIP   8. CHANGE TRANSLATION  11. SECURITY
 3. LIST FORM TYPES   6. LIST PRINT JOBS    9. STOP PORT DESPOOL   99. EXIT

 ENTER ACTION CODE / PAGE NUMBER (P#) / QUEUE (QName) ?

Creates and assigns a formqueue to a logical device type.

PROMPT

FORM-QUEUE DEVICE-TYPE(LPTR,TAPE,PORT,PROG) DEVICE NAME:

COMMAND SYNTAX

SP-CREATE formqueue devicetype devicename

SYNTAX ELEMENTS

formqueue is the formqueue name, which contains up to 20 alphabetic numeric or special characters (excluding asterisks and embedded spaces). The first character of the formqueue name must be alphabetic.  Only the first fifteen characters are displayed. The formtype screen can display the complete 20-character name.

devicetype is the logical device type to be assigned:

devicename is the device name or program command to which output will be despooled.

NOTES

Parameters must be entered in the order shown in the syntax description. You will be prompted for any missing parameters. There is no limit to the number of formqueues, which can be created.

Renames an existing formqueue.

PROMPT

OLD-NAME NEW-NAME:

COMMAND SYNTAX

SP-FORM old-formqueue new-formqueue

SYNTAX ELEMENTS

• old-formqueue is the existing formqueue name.
• new-formqueue is the new name for the formqueue.

NOTES

Missing parameters appear.

If old-formqueue is invalid, the following error message appears.

FORM-QUEUE CANNOT BE FOUND

Only the name of the formqueue is changed. Device assignments remain unchanged.

Assigns or reassigns a formtype to a formqueue.

PROMPT

FORM-QUEUE FORMTYPE:

COMMAND SYNTAX

SP-TYPE formqueue formtype

SYNTAX ELEMENTS

• formqueue is the name of the formqueue for form type assignment.
• formtype is the name of the formtype to be used for formqueue configuration.

NOTES

To revert a formqueue to the default form type, use the following command.

SP-TYPE formqueue

Selecting LIST FORM TYPES from the SP-STATUS menu displays the FORMTYPES menu.

The FORMTYPES menu provides a display of the formqueues and their assigned formtypes. Menu options enable formtypes to be assigned to specific formqueues.

The formtype entries specify configuration parameters to be used by the despooler when despooling print jobs from a formqueue for example, banner information and format.

Formtype entries reside in the $JBCRELEASEDIR/config directory and use the naming convention jspform_formtype for example, entering a value of abcd would expect to find formtype:

jspform_abcd

Formqueues that are not associated with a formtype use the definitions in the file jspform_deflt.

Reassigns a logical device type to a formqueue

PROMPT

FORM-QUEUE DEVICE-TYPE(LPTR,TAPE,PORT,PROG) DEVICE NAME:

COMMAND SYNTAX

SP-DEVICE formqueue devicetype devicename

SYNTAX ELEMENTS

• formqueue is the name of the existing formqueue to be reassigned.
• devicetype is the logical device type to be assigned.
• devicename is the device name or program command to output will be despooled.

NOTES

Parameters must be entered in the order shown in the syntax description.

Missing parameters appear.

The despooler process checks the formqueue assignment at the end of each print job and can therefore be reassigned to alternative device types (depending on availability), without stopping the process.

Changes the number of blank pages to eject at the end of each print job

PROMPT

FORM-QUEUE PAGES:

COMMAND SYNTAX

SP-SKIP formqueue number-of-pages

SYNTAX ELEMENTS

• formqueue is the formqueue to change
• number-of-pages is the number of blank pages (0 to 10) to be ejected after despooling the print job.

NOTES

The page-eject value in the SKIP field affects all print jobs despooled from that formqueue.

An alternate command SP-EJECT can be used to set the number of page ejects for a set of print jobs.

Manipulates and displays status of print jobs.

COMMAND SYNTAX

SP-JOBS

NOTES    

The SP-JOBS screen displays a list of print jobs together with their status and formqueue assignment. Displayed at the jBASE of the screen are14 action codes each action code, except code 99, corresponds to a jBASE command that performs the same function.

The SP-JOBS command displays only the print jobs associated with the jBASE spooler. The command does not display information about the UNIX spooler.

SELECTING A MENU OPTION

To select a menu option enters the appropriate option number at the Prompt.

For example, to move print jobs from one formqueue to another, enter 1 at the Prompt:

Action Code / Options (P#; PT#; A acctname; Q queuename; S status) : 1

The selected option prompts the necessary parameters to enable command execution. In this case, the Prompt is:

FROM-FORM-QUEUE    TO-FORM-QUEUE:

You should enter the formqueue to move print jobs from, a space, and the formqueue to move the print jobs. You will be prompted for any missing parameters.

SELECTING A DISPLAY PAGE

The SP-JOBS display may contain more than one page of print job information. The number of pages available and the current page number are displayed in the top right hand corner of the screen. To display the next page enter RETURN. To skip to a specific page, enter P followed by the page number.

DISPLAY PRINT JOBS FOR A SPECIFIC PORT NUMBER

Print jobs can be filtered to display only those jobs generated from a specific port number. At the Action Code or Options Prompt, enter PT followed by a port number as shown below.

Action Code / Options (P#; PT#; A acctname; Q queuename; S status) : PT 42

It displays the first page of print jobs generated from port 42.

DISPLAY PRINT JOBS FOR A SPECIFIC FORMQUEUE

Print jobs can be filtered to display only those jobs belonging to a specific form queue. At the Action Code / Options Prompt, enter Q followed by a name of a formqueue as shown below.

Action Code / Options (P#; PT#; A acctname; Q queuename; S status) : Q INVOICES

It displays the first page of print jobs belonging to the INVOICES form queue.

DISPLAY PRINT JOBS FOR A SPECIFIC STATUS

Print jobs can be filtered to display only those jobs with a specific STATUS. At the Action Code / Options Prompt, enter S followed by a status of QUEUED, PRINT, FINISH, OPEN, HOLD, KILLED or EDIT as shown below.

Action Code / Options (P#; PT#; A acctname; Q queuename; S status) : S FINISH

It displays the first page of print jobs whose status is FINISH indicating which jobs have been completely despooled.

EXECUTING AN EQUIVALENT jBASE COMMAND

Equivalent jBASE commands can be executed by entering the command at the shell Prompt. For example, to move print jobs, enter the following command.

SP-MOVEQ formqueue formqueue

Missing parameters appear.

EXITING THE SP-JOBS MENU

To exit the SP-JOBS menu, you should select option 99.

SP-JOBS SCREEN DISPLAY

The screen displays contains the following fields:

Deletes a formqueue

PROMPT    

QUEUE-NAME:

COMMAND SYNTAX

SP-FQDELETE formqueue

SYNTAX ELEMENTS

formqueue is the name of the formqueue to be deleted.

NOTES

A formqueue cannot be deleted if the formqueue is not empty or the formqueue is assigned to logical device type.

The formqueue should be changed to a device type of zero and any print jobs either deleted or reassigned to another formqueue. Any processes currently assigned to the deleted formqueue will change to NO QUEUE and any attempt to spool a job will display an error message.

Changes the translation table entry for the specified formqueue

PROMPT

FORMQUEUE TABLE#:

COMMAND SYNTAX

SP-TRANSLATE formqueue table-number

SYNTAX ELEMENTS

• formqueue is the formqueue to use the translation table.
• table-number is the number of the translation table entry.

NOTES

The translation table comprises characters or character strings which are to be translated to alternative characters or character strings. For example, a printing device may not perform an automatic carriage return when a form feed is executed, or it may not be capable of printing lower case characters. In this example, the translation table can be used to map a form feed character to a form feed followed by a carriage return character, and all lower case characters can be mapped to their upper case equivalents. Like this

\f ]\f \r map form feed to form feed followed by carriage return (using char definition).
\141 ] \101 map ASCII lowercase “a” to uppercase “A” (using octal definition).

RESTRICTIONS

The translation table entry is only examined when the despooler is initiated. The despooling process must therefore be stopped and restarted to effect any changes made to either the formqueue assignment or the translation table.

Purges a formqueue of a specific print or all print jobs this command will delete the print job or jobs irrespective of status. If all jobs are requested the jspprint despool will also be stopped.

PROMPT

FORM-QUEUE PRINT JOB LIST (OR * FOR ALL):

COMMAND SYNTAX

SP-PURGEQ

NOTES

This command can only be run by root (UNIX) or an Administrator (NT).

This is a menu driven interface to the previously mentioned SP-SECURITY-xx commands. It is also available from option 11 of SP-STATUS. When run, the following appears.

17:32:20 12 FEB 1998   SECURITY                   PAGE 1 OF 1 PAGES

 QUEUE NAME  Queue    Job            Queue Owners

 STANDARD    -none-   -q.owners-    lp greg jBASE ted
 1. QUEUE SECURITY   3. QUEUE OWNERS        5. RETURN TO SP-STATUS
 2. JOB SECURITY     4. RETURN TO SP-JOBS  99. EXIT

 ENTER ACTION CODE / PAGE NUMBER (P#) ?

The screen shows up to 10 form queues at a time. The four fields shown for each form queue are as follows:

Menu Options

This command modifies the security state of a form queue. The syntax of the command is:

SP-SECURITY-QUEUE queuename (CREATOR | QUEUE | NONE)

For example, to modify the security of form queue “PAYROLL” such that only the user who created that form queue has access to it, you would use the following command:

SP-SECURITY-QUEUE PAYROLL CREATOR

For example, to modify the security of form queue “MAILSHOT” such that ANY user can modify the form queue, use the following command:

SP-SECURITY-QUEUE MAILSHOT NONE

This command modifies the security state of print jobs that are placed in a particular form queue. The syntax of the command is:

SP-SECURITY-JOBS queuename (CREATOR | QUEUE | NONE)

For example, to modify the security of print jobs on the form queue “DEVELOPMENT” such that only the form queue owners can modify or view the print job, use the following command:

SP-SECURITY-JOBS DEVELOPMENT QUEUE

In the above example, if we assume that the alternate form queue owners had been set to “personnel” and “footwear”, then the following users are allowed to modify or view any print jobs:

• The user who created the print job
• The initial creator of form queue “DEVELOPMENT”
• The users personnel and footwear

This command allows you to define a list of users who are considered “alternate” owners of the form queue. This list of users is used when the form queue security state is set to “OWNER” or the print job security state is set to “OWNER”. The syntax of the command is:

SP-SECURITY-OWNER queuename {user {user...}}

For example, to make users “personnel” and “footwear” the alternative owners of the form queue “LIBRARY” use the following command:

SP-SECURITY-OWNER LIBRARY personnel footwear

Move all print jobs from one formqueue to another formqueue.

PROMPT

FROM-FORM-QUEUE TO-FORM-QUEUE

COMMAND SYNTAX

SP-MOVEQ from-formqueue to-formqueue

SYNTAX ELEMENTS

• from-formqueue is the source formqueue.
• to-formqueue is the destination formqueue.

NOTES

Root or the generating user can only move print jobs assigned with the P option. Any user can move print jobs assigned with the U option.

Parameters must be entered in the order shown in the syntax description.

Missing parameters appear.

Moves a print job to a specified formqueue

PROMPT

NEW-FORM-QUEUE PRINT JOB LIST

COMMAND SYNTAX

SP-SWITCH new-formqueue print-job-list

SYNTAX ELEMENTS

• new-formqueue is the destination formqueue.
• print-job-list is the list of print job numbers to be moved, separated by spaces or commas.

NOTES

Any user, except root/Administrators or the generating user, cannot move print jobs assigned with the P option. Any user can move print jobs assigned with the U option.

Parameters must be entered in the order shown in the syntax description.

Missing parameters appear.

Changes the spooler assignment options assigned to a print job.

PROMPT

PRINT JOB# OPTIONS:

COMMAND SYNTAX

SP-OPTS print-job-num options

SYNTAX ELEMENTS

• print-job-num is the number of the print job to change.
• options are the options to be assigned to the print job. Valid options are listed below. If no parameter is supplied for options then all current options are cancelled, except the P and U options, which cannot be changed.
  • A – Align
  • H - Hold

NOTES

Options cannot be changed for print jobs once the job is being despooled.

Changes the number of copies assigned to a print job.

PROMPT

PRINT JOB # COPIES:

COMMAND SYNTAX

SP-COPIES print-job-num copies

SYNTAX ELEMENTS

• print-job-num is the number of the print job to change.
• copies are the number of copies (1 to 99) to be despooled.

NOTES

The number of copies of a print job already despooled to the UNIX spooler cannot be changed.

Parameters must be entered in the order shown in the syntax description.

Missing parameters appear.

Deletes a list of print jobs.

PROMPT

PRINT JOB LIST:

COMMAND SYNTAX

SP-DELETE print-job-list

SYNTAX ELEMENTS

print-job-list is the list of print jobs to be deleted, separated by spaces or commas.

NOTES

• Root or the user that generated the print job can only delete print jobs with the P option assigned. Any user can delete print jobs with the U option.
• Print jobs with OPEN or EDIT status cannot be deleted.
• Print jobs currently being despooled can be deleted. The job is killed and then deleted.

Stops despooling from a formqueue

PROMPT

FORM QUEUE OR PRINT JOB:

COMMAND SYNTAX

SP-STOP formqueue

SYNTAX ELEMENTS

formqueue is the formqueue from which to stop despooling.

NOTES

Despooling stops after the current print job is despooled.

To resume printing, refer to Option 7 - the SP-RESUME command.

Resumes despooling from a formqueue.

PROMPT

FORM-QUEUE:

COMMAND SYNTAX

SP-RESUME formqueue

SYNTAX ELEMENTS

formqueue is the formqueue from which to resume despooling.

NOTES

Despooling is resumed from the point at which the formqueue was either SUSPENDED or STOPPED.

Edits a list of print jobs.

PROMPT

PRINT JOB LIST:

COMMAND SYNTAX

SP-EDIT print-job-list {(options)}

SYNTAX ELEMENTS

print-job-list is the list of print jobs for editing, separated by spaces or commas. You can specify a range of jobs (n1-n2).

options are the command line options to be applied to the list of print jobs and can be one or more of the following:

NOTES

Root and the user that generated the job can only edit print jobs created with the P option assigned. Any user can edit print jobs created with the U option assigned. Print jobs, which are still OPEN, cannot be edited.

You can then enter a filename and record ID for the print job data.

SP-EDIT EDITOR COMMANDS

The following commands are available in the spooler editor.

Suspends despooling a print job.

PROMPT

FORM-QUEUE:

COMMAND SYNTAX

SP-SUSPEND formqueue

SYNTAX ELEMENTS

formqueue is the formqueue from which the print job is being despooled.

NOTES

To resume despooling use the RESUME PRINTING option or the SP-RESUME command.

Moves a print job to the head of the formqueue

PROMPT

PRINT JOB #:

COMMAND SYNTAX

SP-PRIORITY print-job-number

SYNTAX ELEMENTS

print-job-number is the number of the print job to move to the head of the formqueue.

Immediately stops despooling the current print job.

PROMPT

FORM-QUEUE:

COMMAND SYNTAX

SP-KILL formqueue

SYNTAX ELEMENTS

formqueue is the formqueue from which the print job is being despooled.

NOTES

The print job status is changed from PRINTING to KILLED and the print job is deleted. If the print job was a hold file, the status of the print job changes to FINISHED. The next print job on the formqueue will then be despooled.

Allows forms alignment before despooling

PROMPT

FORM-QUEUE:

COMMAND SYNTAX

SP-ALIGN formqueue

SYNTAX ELEMENT

formqueue is the formqueue on which to allow alignment.

NOTES

Print jobs assigned with the align option (A), will display a status of ALIGN while suspended and waiting for alignment, before being despooled. This menu option or command prompts for one of the following options.

The alignment command is available only for directly driven formqueues.

Clears a formqueue of queued print jobs

PROMPT

FORM-QUEUE:

COMMAND SYNTAX

SP-CLEAR formqueue

SYNTAX ELEMENTS

formqueue to be cleared

NOTES

Root or the user that generated the print job can only clear print jobs assigned with the P option. Any user can clear print jobs assigned with the U option. Print jobs, which have an OPEN or EDIT status cannot be cleared.

All print jobs queued to the specified formqueue will be deleted. Any print job currently despooling from the specified formqueue will be killed and then deleted.

Spooler error messages are shown below.