Document revision date: 30 March 2001

## OpenVMS DCL Dictionary

Previous | Contents | Index

## START/ZONE

> Adds a zone to the running VAXft system. For more information on the START/ZONE command, refer to the VAXft systems documentation.

> Applies only to the VAXft system. Requires CMKRNL (change mode to kernel) privilege.

### Format

> START/ZONE

## STOP

> Terminates execution of a command, an image, a command procedure, a command procedure that was interrupted by a Ctrl/Y function, or a detached process or subprocess.

> Requires GROUP privilege to stop other processes in the same group. Requires WORLD privilege to stop processes outside your group.

### Format

> STOP [process-name]

### Parameter

> #### process-name

> Requires that the process be in your group.

> Specifies the name of the process to be deleted. The process name can have from 1 to 15 alphanumeric characters. If the process-name includes spaces or lowercase letters, enclose the name in quotation marks (" ") to preserve the correct spelling.

> The specified process must have the same group number in its user identification code (UIC) as the current process; you cannot use the process-name parameter to stop a process outside of your group. To stop a process outside of your group, you must use the qualifier /IDENTIFICATION=pid.

> The process name is incompatible with the /IDENTIFICATION qualifier; if you use the /IDENTIFICATION qualifier, the process name is ignored. If you include neither the process-name parameter nor the /IDENTIFICATION qualifier with the STOP command, the image executing in the current process is terminated.

### Description

> The STOP command causes an abnormal termination of the image that is currently executing. If the image has declared any exit-handling routines, they are not given control. Use the EXIT command to terminate the image so that the exit-handling routines gain control.

> Note that when an image has been interrupted by a Ctrl/Y function and the RUN command is entered to execute another image, the interrupted image is terminated. However, in this case, exit-handling routines execute before the next image is run.

> If the STOP command is executed from a noninteractive process (such as a batch job), the process terminates.

> If you press Ctrl/Y to interrupt a command procedure and then enter the STOP command, or if the STOP command is executed in a command procedure, all command levels are unstacked and control returns to command level 0 (DCL level with the $ prompt).

> If you specify a process name or process identification (PID) code, the STOP command terminates the image currently executing in the specified process and deletes the process. If the process is noninteractive, no notification of the deletion occurs and the log file for the job is not printed.

### Qualifier

> #### /IDENTIFICATION=pid

> Specifies the system-assigned process identification (PID) code. When you create a process with the RUN command, the RUN command displays the PID code of the newly created process. The /IDENTIFICATION qualifier can be used in place of the process name parameter.

> You can omit any leading zeros in specifying the PID code.

###

#### Examples

#1
    $ RUN MYPROG
       .
       .
       .
    [Ctrl/Y]
    Interrupt
    $ STOP

> The RUN command in this example begins executing the image MYPROG. Subsequently, the Ctrl/Y function interrupts the execution. The STOP command then terminates the image.

#2
    $ @TESTALL
       .
       .
       .

    [Ctrl/Y]
    Interrupt
    $ STOP

> The @ (execute procedure) command in this example executes the procedure TESTALL.COM. Subsequently, the Ctrl/Y function interrupts the procedure. The STOP command then returns control to the DCL command interpreter.

#3
    $ RUN/PROCESS_NAME=LIBRA  LIBRA
    %RUN-S-PROC_ID, identification of created process is 0013340D
       .
       .
       .
    $ STOP LIBRA

> The RUN command in this example creates a subprocess named LIBRA to execute the image LIBRA.EXE. Subsequently, the STOP command causes the image to exit and deletes the process.

#4
    $  ON ERROR THEN STOP
       .
       .
       .

> In a command procedure, the ON command establishes a default action when any error occurs in the execution of a command or program. The STOP command stops all command levels. If this ON command is executed in a command procedure, which in turn is executed from within another procedure, control does not return to the outer procedure, but to DCL command level 0.

## STOP/CPU

> Stops the specified secondary processor or processors (and any associated vector processors). The /CPU qualifier is required.

> Applies only to OpenVMS multiprocessing systems. Requires CMKRNL (change mode to kernel) privilege.

### Format

> STOP/CPU [cpu-id[,...]]

### Parameter

> #### cpu-id[,...]

> Specifies a decimal value representing the identity of a processor in an OpenVMS multiprocessing system. On a VAX 6000 system or an Alpha 7000 system, the CPU ID is the backplane slot number of the processor. If you do not specify a CPU ID, the STOP/CPU command selects a processor in the current active set to stop.

### Description

> The STOP/CPU command removes a secondary processor from the active set in an OpenVMS multiprocessing system. If the secondary processor is not executing a process when the STOP/CPU command is issued, it enters the STOPPED state. If the secondary is executing a process at the time, it continues to execute the current process until it attempts to schedule another process. When this occurs, the secondary enters the STOPPED state.

> The OpenVMS operating system subjects a processor to a set of checks when it is the object of a STOP/CPU command. As a result, you may not be permitted to stop certain processors that are vital to the functioning of the system. In these cases, there is usually a process in the system that can execute only on the processor you intend to stop. You can determine this by issuing a SHOW CPU/FULL command. In unusual circumstances, you can bypass the checking mechanism by using the /OVERRIDE_CHECKS qualifier in the command.

> The STOP/CPU command has no effect if its object processor is already in the STOPPED state when it is issued.

### Qualifiers

> #### /ALL

> Stops all eligible secondary processors in the system's active set.

> #### /OVERRIDE_CHECKS

> Directs the STOP/CPU command to bypass a series of checks that determine whether the specified processor is eligible for removal from the active set.

### Examples

#1
    $ STOP/CPU

> The STOP/CPU command in this example selects a processor and removes it from the multiprocessing system's active set.

#2
    $ STOP/CPU 4,7

> The STOP/CPU command in this example selects the processors with CPU IDs 4 and 7 and removes them from the multiprocessing system's active set.

#3
    $ STOP/CPU/OVERRIDE_CHECKS 8

> The STOP/CPU/OVERRIDE_CHECKS command in this example unconditionally stops the processor with the CPU ID of 8 and removes it from active participation in the multiprocessing system.

#4
    $ STOP/CPU/ALL

> The STOP/CPU/ALL command in this example stops all eligible secondary processors in the active set and removes them from the multiprocessing system.

## STOP/NETWORK

> Stops the specified network service on the local node. The /NETWORK qualifier is required.

### Format

> STOP/NETWORK network-service

### Parameter

> #### network-service

> Specifies the name of the network service that you want to halt.

### Description

> The STOP/NETWORK command causes the specified network to stop executing on the local node.

> Use the START/NETWORK command to release the network from the paused state.

### Example

    $ STOP/NETWORK DECnet

> The STOP/NETWORK command in this example stops the current network service.

## STOP/QUEUE

> The STOP/QUEUE command causes the specified execution queue to pause. All jobs currently executing in the queue are suspended (until the queue is restarted with the START/QUEUE command), and no new jobs are initiated. The /QUEUE qualifier is required.

> Requires manage (M) access to the queue.

### Format

> STOP/QUEUE queue-name[:]

### Parameter

> #### queue-name[:]

> Specifies the name of the queue that you want to pause.

### Description

> The STOP/QUEUE command causes the specified queue to pause. All jobs currently executing in the queue are suspended. No new jobs are initiated.

> Use the START/QUEUE command to release the queue from the paused state. When you restart the queue, any jobs that were executing resume executing at the point where they left off, unless you use the /BACKWARD, the /FORWARD, the /SEARCH, or the /TOP_OF_FILE qualifier to restart a print job at a different place.

> For information about how to stop a queue, see the following commands:

> > STOP/QUEUE/ABORT
> > STOP/QUEUE/ENTRY
> > STOP/QUEUE/MANAGER/CLUSTER
> > STOP/QUEUE/NEXT
> > STOP/QUEUE/REQUEUE
> > STOP/QUEUE/RESET
> > STOP/QUEUES/ON_NODE

### Examples

#1
    $ STOP/QUEUE LPA0

> The STOP/QUEUE command in this example suspends the current print job in the queue LPA0 and places that queue in the paused state.

#2
    $ STOP/QUEUE JADE_PRINT
    $ START/QUEUE/TOP_OF_FILE JADE_PRINT

> The STOP/QUEUE command in this example suspends the job that is currently printing on the printer queue JADE_PRINT and places that queue in the paused state. The START/QUEUE command releases the queue from the paused state. The /TOP_OF_FILE qualifier causes the job that was suspended to resume printing at the beginning of the file rather than at where it was interrupted.

## STOP/QUEUE/ABORT

> Aborts a job that is printing or processing on an output queue, deletes it from the queue, and begins processing the first pending job in the queue. The /QUEUE qualifier is optional, but the /ABORT qualifier is required.

> Requires delete (D) access to the current job.

### Format

> STOP/QUEUE/ABORT queue-name[:]

### Parameter

> #### queue-name[:]

> Specifies the name of the queue containing the job you want to abort.

### Description

> When you abort a print job, the print job completes the page that is currently printing. Then the job is removed from the queue. If the output queue has been set up to put trailing pages at the end of jobs, a trailer page is printed after the current page is completed. For information on how a batch job is aborted, see the description of the STOP/QUEUE/ENTRY command.

> Use the STOP/QUEUE/ABORT command to abort the current print job and to delete it from the queue. You do not specify a job entry number with the /ABORT qualifier, because output queues can have only one current job at a time.

> Use the STOP/QUEUE/ENTRY command to abort one or more batch jobs that are executing currently on a queue and to delete them from the queue. To stop a batch job, you must specify an entry number because batch queues, unlike print queues, can have more than one job executing at the same time. (You also can use the STOP/QUEUE/ENTRY command to abort a print job that is printing or processing currently on a queue, and to delete it from the queue.)

> Use the STOP/QUEUE/REQUEUE command to stop batch or print jobs and to requeue them. Use the DELETE/ENTRY command to delete an entry that is queued and awaiting execution.

> Note If you enter the STOP/QUEUE/ABORT command accidentally for a malfunctioning queue, enter the STOP/QUEUE/RESET command to stop the queue in an orderly fashion.

### Example

    $ STOP/QUEUE/ABORT LPA0

> This example aborts the current print job on the queue LPA0. The print symbiont begins to process the first pending job in the queue. Assuming there is no problem with the printer, the current page of the file completes printing. If the printer queue has been set up to put trailer pages at the end of jobs, a trailer page is printed after the current page is completed.

> For batch queues an entry number must be provided. To abort a batch job, use the STOP/QUEUE/ENTRY command.

## STOP/QUEUE/ENTRY

> Aborts one or more jobs that are executing on a batch queue or printing on an output queue, deletes them from the queue, and begins processing the first pending job in the queue. The /QUEUE qualifier is optional, but the /ENTRY qualifier is required.

> Requires delete (D) access to the specified job.

### Format

> STOP/QUEUE/ENTRY =(entry-number[,...]) [queue-name[:]]

### Parameters

> #### entry-number[,...]

> Specifies the entry number (or a list of entry numbers) of jobs to be deleted. If you specify only one entry number, you can omit the parentheses. If you do not specify a queue name, you can delete entries from multiple queues.

> The system assigns a unique entry number to each queued print or batch job in the system. By default, the PRINT and SUBMIT commands display the entry number when they successfully queue a job for processing. These commands also create or update the local symbol $ENTRY to reflect the entry number of the most recently queued job. To find a job's entry number, enter the SHOW ENTRY or the SHOW QUEUE command.

> #### queue-name[:]

> Specifies the name of the queue that contains the jobs that you want to abort. The queue name can refer either to the queue to which the job was submitted or to the queue where the job is executing. The queue-name parameter is optional syntax; however, when you specify a queue name, the OpenVMS system uses it to verify an entry in the specific queue before stopping and deleting the entry.

### Description

> When you abort a batch job, the system tries to stop the job in an orderly fashion by closing any open files and sending a message to the log file. For information on how a print job is aborted, see the description of the STOP/QUEUE/ABORT command.

> Use the STOP/QUEUE/ENTRY command to abort one or more batch jobs that are executing currently on a queue and to delete them from the queue. To stop a batch job, you must specify an entry number because batch queues, unlike print queues, can have more than one job executing at the same time. (You also can use the STOP/QUEUE/ENTRY command to abort a print job that is currently printing or processing on a queue and to delete it from the queue.)

> Use the STOP/QUEUE/REQUEUE command to stop batch or print jobs and to requeue them. Use the DELETE/ENTRY command to delete an entry that is queued and is awaiting execution.

> Note If you enter the STOP/QUEUE/ENTRY command accidentally for a malfunctioning queue, enter the STOP/QUEUE/RESET command to stop the queue in an orderly fashion.

### Example

    $ STOP/QUEUE/ENTRY=365 SYS$BATCH

> The STOP/QUEUE/ENTRY command in this example aborts batch job number 365 currently executing on the SYS$BATCH queue and begins the first pending job in the queue.

## STOP/QUEUE/MANAGER/CLUSTER

> Shuts down the queue manager on a standalone node or an OpenVMS Cluster. The /QUEUE qualifier is optional, but the /MANAGER and /CLUSTER qualifiers are required on both standalone and clustered systems. By default, the command affects the default queue manager, SYS$QUEUE_MANAGER. Specify the /NAME_OF_MANAGER qualifier to shut down a queue manager other than the default.

> Requires OPER (operator) and SYSNAM (system logical name) privileges.

### Format

> STOP/QUEUE/MANAGER/CLUSTER

### Parameters

> None.

### Description

> The STOP/QUEUE/MANAGER/CLUSTER command notifies the queue manager to perform the following on the standalone node or on all nodes in the cluster:
> - Abort all of the current jobs that cannot be restarted, and requeue all of the current restartable jobs on the queue manager
> - Stop all of the execution queues on the queue manager
> - Disable the autostart feature for all of the queue manager's autostart queues
> - Close the queue manager's queue and journal files

> Once the STOP/QUEUE/MANAGER/CLUSTER command is entered, the affected queue manager process remains stopped, and requests to the queuing system are denied until the DCL command START/QUEUE/MANAGER is entered.

### Qualifier

> #### /NAME_OF_MANAGER=name

> Specifies the name of the queue manager process to be stopped. If the /NAME_OF_MANAGER qualifier is omitted, the default queue manager name SYS$QUEUE_MANAGER is used. For more information, refer to the chapter about the queue manager in the OpenVMS System Manager's Manual.

### Example

    $ STOP/QUEUE/MANAGER/CLUSTER

> The STOP/QUEUE/MANAGER/CLUSTER command in this example stops the queue manager process, SYS$QUEUE_MANAGER. The process remains stopped and requests to SYS$QUEUE_MANAGER will be denied until the START/QUEUE/MANAGER command is entered.

> This command stops the default queue manager SYS$QUEUE_MANAGER because the /NAME_OF_MANAGER qualifier is not specified.

## STOP/QUEUE/NEXT

> Stops the specified queue after all executing jobs have completed processing. No new jobs are initiated.

> The /QUEUE qualifier is optional, but you must specify the /NEXT qualifier.

> Requires manage (M) access to the queue.

### Format

> STOP/QUEUE/NEXT queue-name[:]

### Parameter

> #### queue-name[:]

> Specifies the name of the queue that you want to stop.

### Description

> The STOP/QUEUE/NEXT command stops the queue after it allows any current jobs to complete execution. No new jobs are initiated.

> You should use the STOP/QUEUE/NEXT command before deassigning, deleting, or merging a queue, as this command allows all currently executing jobs to complete processing before changes are made to the queue. You might also use this command to stop a queue if you need to perform planned service on a printing device. Use the START/QUEUE command to restart the queue.

> For autostart queues, the STOP/QUEUE/NEXT command stops the queue and makes it inactive for autostart, so it will not be automatically started. For this reason, you might use this command to prevent an autostart queue from being accidentally restarted when a printing device needs to undergo planned service. Use the START/QUEUE command to reactivate the queue for autostart.

### Examples

#1
    $ STOP/QUEUE/NEXT LASER_PRINT

> In this example, the STOP/QUEUE/NEXT command prepares to stop the queue LASER_PRINT. The currently printing job is allowed to complete, but no new job is allowed to initiate. Once the current job has finished, the queue is stopped.

> If LASER_PRINT is an autostart queue, it will not be automatically started until you enter the START/QUEUE command.

#2
    $ STOP/QUEUE/NEXT BATCH_1
    $ SHOW QUEUE/ALL BATCH_1
    Batch queue BATCH_1, stopped, on JADE::
    $ DELETE/QUEUE BATCH_1

> This example shows how to delete the batch queue BATCH_1. First, the STOP/QUEUE/NEXT command is entered, which stops the queue after jobs currently executing on the queue are completed. Second, the SHOW QUEUE/ALL command is entered to ensure that no jobs are pending in the queue. The screen display shows that no jobs are pending. Finally, the DELETE/QUEUE command is entered to delete the queue BATCH_1.

Previous | Next | Contents | Index

| privacy and legal statement |
9996PRO_079.HTML