Document revision date: 30 March 2001

## OpenVMS DCL Dictionary

Previous | Contents | Index

## SHOW PROTECTION

> Displays the current default process protection to be applied to all new files created during the terminal session or batch job.

### Format

> SHOW PROTECTION

### Parameters

> None.

### Description

> The SHOW PROTECTION command displays the current default file protection to be applied to all new files created during the terminal session or batch job. You can change the default protection at any time with the SET PROTECTION/DEFAULT command.

> Use the DIRECTORY/PROTECTION command to see the current protection for one or more specific files.

### Example

    $ SHOW PROTECTION
      SYSTEM=RWED, OWNER=RWED, GROUP=RE, WORLD=NO ACCESS
    $ SET PROTECTION=(GROUP:RWED,WORLD:RE)/DEFAULT
    $ SHOW PROTECTION
      SYSTEM=RWED, OWNER=RWED, GROUP=RWED, WORLD=RE

> The SHOW PROTECTION command in this example requests a display of the current protection defaults and the user identifiers; the SET PROTECTION/DEFAULT command changes the file access allowed to other users in the same group and to miscellaneous system users. The next SHOW PROTECTION command shows the modified protection defaults.

## SHOW QUEUE

> Displays information about queues and the jobs that are currently in queues.

> Requires read (R) access to the job.

### Format

> SHOW QUEUE [queue-name]

### Parameter

> #### queue-name

> Specifies the name of the queue for which you want information displayed. The asterisk (*) and the percent sign (%) wildcard characters are allowed. The default value for the queue-name parameter is the asterisk (*) wildcard character. If no queue name is specified, information on all queues is displayed.

### Description

> The SHOW QUEUE command displays the name, type, status, and attributes of batch and output queues as well as information about jobs in the queues. When you enter the SHOW QUEUE command with no qualifiers, the OpenVMS system lists the names, types, and status of all the specified queues along with information about your jobs in those queues. The SHOW QUEUE command assumes the /BRIEF qualifier by default.

> In an OpenVMS Cluster, the SHOW QUEUE command displays information on all the queues available for the cluster.

> If you want information about queues or a complete list of the jobs in those queues, use the SHOW QUEUE command. For information about specific jobs, use the SHOW ENTRY command.

### Qualifiers

> #### /ALL_JOBS

> Displays all the jobs in the specified queues. You must have read (R) access to the job to show information about any jobs.

> #### /BATCH

> Displays only batch queues and jobs in those queues.

> #### /BRIEF (default)

> Displays a one-line description of each queue and jobs that are in it. This information includes the name, type, and status of each queue. It also includes the entry number, the job name, the user name, and the status for each job shown. The /FULL and /FILES qualifiers override the /BRIEF qualifier.

> #### /BY_JOB_STATUS=(keyword-list)

> Displays queues that contain jobs that match the specified status. By default, jobs owned by the user are displayed. Specify the status with one or more of the following keywords:

> EXECUTING | Requests the display of jobs in any of the following states:
> ABORTING EXECUTING PRINTING PROCESSING | STALLED STARTING SUSPENDED
> ABORTING means that the job is halting prior to normal completion and will not continue processing. A SUSPENDED state means that the job stopped during processing, but should continue when the cause of the SUSPENDED state is resolved. PROCESSING is the executing state for server queues. PRINTING is the executing state for printer and terminal queues. STARTING means the job is beginning to be processed or printed. A STALLED or SUSPENDED state means that the job stopped during processing, but should continue when the cause of the STALLED or SUSPENDED state is resolved.
> HOLDING | Requests the display of jobs on hold. Holding status indicates that the job is being held in the queue indefinitely.
> PENDING | Requests the display of jobs with pending status. Pending status indicates that the job is waiting its turn to execute.
> RETAINED | Requests the display of jobs retained in the queue after execution. Retained status indicates that the job has completed, but it remains in the queue.
> TIMED_RELEASE | Requests the display of jobs on hold until a specified time. Timed release status indicates that the job is being held in the queue for execution at a specified time.

> Note that if you specify the qualifier without a keyword, the system will only display queues that actually contain jobs.

> #### /DEVICE[=(keyword-list)]

> Displays a particular type of queue and jobs in that queue.

> Specify the type of device queue with one or more of the following keywords:

> PRINTER | Requests the display of print queues.
> SERVER | Requests the display of server queues.
> TERMINAL | Requests the display of terminal queues.

> You can specify more than one keyword. If you do not specify a keyword with the /DEVICE qualifier, all printer, terminal, and server queues are displayed.

> #### /EXACT

> Use with the /PAGE=SAVE and /SEARCH qualifiers to specify a search string that must match the search string exactly and must be enclosed with quotation marks (" ").

> If you specify the /EXACT qualifier without the /SEARCH qualifier, exact search mode is enabled when you set the search string with the Find (E1) key.

> #### /FILES

> Adds to the display the list of files associated with each job. The /FILES qualifier overrides the /BRIEF qualifier.

> #### /FULL

> Displays complete information about queues, jobs contained in queues, and the files associated with the jobs. The /FULL qualifier overrides the /BRIEF qualifier.

> #### /GENERIC

> Displays only generic queues and jobs in those queues. A generic queue is not an execution queue. Its function is to hold jobs of a particular type (line printer jobs, for example) and direct them to execution queues for processing.

> #### /HIGHLIGHT[=keyword]

> Use with the /PAGE=SAVE and /SEARCH qualifiers to specify the type of highlighting you want when a search string is found. When a string is found, the entire line is highlighted. You can use the following keywords: BOLD, BLINK, REVERSE, and UNDERLINE. BOLD is the default highlighting.

> #### /OUTPUT[=filespec]

> #### /NOOUTPUT

> Controls where the output of the command is sent. By default, the output of the SHOW QUEUE command is sent to the current SYS$OUTPUT device (usually your terminal). To send the output to a file, use the /OUTPUT qualifier followed by a file specification.

> The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification. If you enter a partial file specification (for example, specifying only a directory), SHOW is the default file name and .LIS is the default file type.

> If you enter the /NOOUTPUT qualifier, output is suppressed.

> #### /PAGE[=keyword]

> #### /NOPAGE (default)

> Controls the display of information on the screen.

> You can use the following keywords with the /PAGE qualifier:

> CLEAR_SCREEN | Clears the screen before each page is displayed.
> SCROLL | Displays information one line at a time.
> SAVE[= n] | Enables screen navigation of information, where n is the number of pages to store.

> The /PAGE=SAVE qualifier allows you to navigate through screens of information. The /PAGE=SAVE qualifier stores up to 5 screens of up to 255 columns of information. When you use the /PAGE=SAVE qualifier, you can use the following keys to navigate through the information:

> Key Sequence | Description
> --- | ---
> Up arrow key, Ctrl/B | Scroll up one line.
> Down arrow key | Scroll down one line.
> Left arrow key | Scroll left one column.
> Right arrow key | Scroll right one column.
> Find (E1) | Specify a string to find when the information is displayed.
> Insert Here (E2) | Scroll right one half screen.
> Remove (E3) | Scroll left one half screen.
> Select (E4) | Toggle 80/132 column mode.
> Prev Screen (E5) | Get the previous page of information.
> Next Screen (E6), Return, Enter, Space | Get the next page of information.
> F10, Ctrl/Z | Exit. (Some utilities define these differently.)
> Help (F15) | Display utility help text.
> Do (F16) | Toggle the display to oldest/newest page.
> Ctrl/W | Refresh the display.

> The /PAGE qualifier is not compatible with the /OUTPUT qualifier.

> #### /SEARCH="string"

> Use with the /PAGE=SAVE qualifier to specify a string that you want to find in the information being displayed. Quotation marks are required for the /SEARCH qualifier, if you include spaces in the text string.

> You can also dynamically change the search string by pressing the Find key (E1) while the information is being displayed. Quotation marks are not required for a dynamic search.

> #### /SUMMARY

> Displays the total number of executing jobs, pending jobs, holding jobs, retained jobs, and timed release jobs for each queue. For output queues, the total block count for pending jobs is also shown.

> #### /WRAP

> #### /NOWRAP (default)

> Use with the /PAGE=SAVE qualifier to limit the number of columns to the width of the screen and to wrap lines that extend beyond the width of the screen to the next line.

> The /NOWRAP qualifier extends lines beyond the width of the screen and can be seen when you use the scrolling (left and right) features provided by the /PAGE=SAVE qualifier.

###

#### Examples

#1
    $ SHOW QUEUE/ALL/BY_JOB_STATUS=pending
    Printer queue KLEE$LCA0, stopped, mounted form DEFAULT
      /BASE_PRIORITY=4 /DEFAULT=(FEED,FORM=ELITE (stock=DEFAULT))
      /OWNER=[SYSTEM] /PROTECTION=(S:M,O:D,G:R,W:S)

      Entry     Jobname         Username        Blocks  Status
      -----     -------         --------        ------  ------
       2045     APPLICA         MARTIN             102  Pending

    Batch queue SYS_TEX, available, on NODE22::
      /BASE_PRIORITY=3 /JOB_LIMIT=25 /OWNER=[SYSTEM]
      /PROTECTION=(S:M,O:D,G:R,W:S)

      Entry     Jobname         Username                Status
      -----     -------         --------                ------
       1388     CHAPTER1.JOB    MARTIN                  Pending
    Generic batch queue CLUSTER_BATCH
      /GENERIC=(HMSCMS_BATCH,NODE22_BATCH) /OWNER=[SYSTEM]
      /PROTECTION=(S:M,O:D,G:R,W:S)
      Entry     Jobname         Username                Status
      -----     -------         --------                ------
        936     no privilege                            Pending
       .
       .
       .

> The SHOW QUEUE command in this example displays only the queues in which jobs are currently pending. The /ALL qualifier requests the display of all pending jobs. Notice that you cannot see job information for entry 936. You must have GROUP privilege to show all jobs in your group or OPER privilege to show all jobs in all groups.

#2
    $ SHOW QUEUE/FULL ARMADA*
    Batch queue ARMADA_BATCH, idle, on ARMADA::
      /AUTO_START_ON=(ARMADA::) /BASE_PRIORITY=3 /JOB_LIMIT=3
      /OWNER=[SYSTEM] /PROTECTION=(S:M,O:D,G:R,W:S)
    Printer queue ARMADA$PRINT, stopped, on ARMADA::LPA0,
     mounted form DEFAULT
      /BASE_PRIORITY=4 /DEFAULT=(FEED,FORM=ELITE (stock=DEFAULT))
      /OWNER=[SYSTEM] /PROTECTION=(S:E,O:D,G:R,W:W)
      Entry  Jobname         Username     Blocks  Status
      -----  -------         --------     ------  ------
        605  SET             DUDSON          140  Pending (queue stopped)
             Submitted 21-DEC-2001 16:14 /FORM=ELITE (stock=DEFAULT)
             /PRIORITY=200
             File: _$5$DUA1:[DUDSON]SET.CLD;5
        606  CLOSE           DUDSON          140  Pending (queue stopped)
             Submitted 21-DEC-2001 16:16 /FORM=DEFAULT /PRIORITY=200
             File: _$5$DUA1:[DUDSON]CLOSE.TXT;2
    Printer queue ARMADA$PRINTER_1, idle, on ARMADA::TTA3,
     mounted form DEFAULT
      <Printer queue on node ARMADA for a LN03R printer>
      /BASE_PRIORITY=4 /DEFAULT=(FEED,FORM=DEFAULT) /LIBRARY=SMU$DEVCTL
      Lowercase /OWNER=[SYSTEM] /PROCESSOR=CPS$SMB
      /PROTECTION=(S:M,O:D,G:R,W:S) /SEPARATE=(FLAG)

> The SHOW QUEUE command in this example lists information on all of your current job entries. Complete information about the queues, the jobs contained in those queues, and the files associated with the jobs is displayed.

#3
    $ SHOW QUEUE/SUMMARY

    Batch queue HMSCMS_BATCH, available, on HMSCMS::
        Job summary:  1 executing,  5 holding
    Server queue NM$QUE01, available, on NODE22::, mounted form DEFAULT
        Job summary:  2 executing
    Generic server queue NM$QUEUE
        Job summary:  1 timed release
    Batch queue PIZZA_BATCH, idle, on PIZZA::
        Job summary:  queue is empty
    Batch queue NODE22_BATCH, available, on NODE22::
        Job summary:  1 executing,  1 timed release
    Printer queue ARMADA$PRINT, stopped, on ARMADA::LPA0, mounted
      form DEFAULT
        Job summary:  8 pending (565 blocks)
    Terminal queue ALLBQ, stopped, on KATYA::TTA2, mounted form DEFAULT
        Job summary:  2 pending (445 blocks)
       .
       .
       .

> The SHOW QUEUE command in this example lists all queues and displays the total number of jobs on the queues.

#4
    $ SHOW QUEUE DOC$LN03

    Server queue DOC$LN03, stopped, on NEWTON::, mounted form DEFAULT
     Entry  Jobname   Username  Blocks  Status
     -----  -------   --------  ------  ------
       436  DOCPLAN   HERSHEY        8  Retained until 11-JAN-2001 16:56
          %JBC-F-JOBABORT, job aborted during execution
            Completed  11-JAN-2001 15:56 on queue DOC$LN03

> This SHOW QUEUE display includes the date and time at which a retained job completed and the queue on which it executed. You can specify the /RETAIN qualifier with the PRINT, SUBMIT, or SET ENTRY command to specify the circumstances under which you want your job to be retained in a queue. In this example, the user set job retention to be one hour after job completion. Depending on the queue's job retention policy, the job might be deleted from the queue at 16:56. (See the PRINT, SUBMIT, or SET ENTRY command descriptions for more information on the /RETAIN qualifier.)

## SHOW QUEUE/CHARACTERISTICS

> Displays information about queue characteristics defined for the system. A characteristic is a user-defined attribute of a batch or output queue, such as ink color.

### Format

> SHOW QUEUE/CHARACTERISTICS

> [characteristic-name]

### Parameter

> #### characteristic-name

> Specifies the name of a characteristic. The asterisk (*) and the percent sign (%) wildcard characters are allowed. The default value for the characteristic-name parameter is the asterisk wildcard (*). Thus, information about all characteristics is displayed when you do not specify a characteristic name.

> You create a characteristic name with the DEFINE/CHARACTERISTIC command. You can then assign it to a queue by using the INITIALIZE/QUEUE, the SET QUEUE, or the START/QUEUE command with the /CHARACTERISTICS qualifier. You can also specify characteristics for a job by using the /CHARACTERISTICS qualifier with the PRINT, the SUBMIT, or the SET ENTRY command.

### Description

> The SHOW QUEUE/CHARACTERISTICS command displays the characteristic name and number of characteristics defined for the system. To see which characteristics are associated with a particular queue, use the SHOW QUEUE command with the /FULL qualifier.

### Qualifier

> #### /OUTPUT[=filespec]

> #### /NOOUTPUT

> Controls where the output of the command is sent. By default the output of the SHOW QUEUE/CHARACTERISTICS command is sent to the current SYS$OUTPUT device (usually your terminal). To send the output to a file, use the /OUTPUT qualifier followed by a file specification.

> The file specification may not include any wildcard characters. If you enter a partial file specification (for example, specifying only a directory), SHOW is the default file name and .LIS is the default file type.

> If you enter the /NOOUTPUT qualifier, output is suppressed.

###

#### Examples

#1
    $ SHOW QUEUE/CHARACTERISTICS
    Characteristic name                  Number
    -------------------                  ------
    BLUEINK                                   6
    BROWNINK                                 25
    COLOR_CHART                               1
    REDINK                                    0
    TEXMAC_JOB                                2

> The SHOW QUEUE/CHARACTERISTICS command in this example displays all the characteristics that have been defined for this system.

#2
    $ SHOW QUEUE/CHARACTERISTICS *INK
    Characteristic name                  Number
    -------------------                  ------
    BLUEINK                                   6
    BROWNINK                                 25
    REDINK                                    0

> The SHOW QUEUE/CHARACTERISTICS command in this example displays the name and number of all characteristics that end with INK.

## SHOW QUEUE/FORM

> Displays information about forms defined for the system. Forms define the size and type paper and the layout of text that are used for print jobs.

### Format

> SHOW QUEUE/FORM [form-name]

### Parameter

> #### form-name

> Specifies the name of the form. The asterisk (*) and the percent sign (%) wildcard characters are allowed. The default value for the form-name parameter is an asterisk (*), which means that the names of all forms on the system are displayed.

### Description

> The SHOW QUEUE/FORM command displays the name and number of forms defined for the system. To display the attributes associated with forms, use the /FULL qualifier.

> Use the SHOW QUEUE/FORM command to find out which forms are available on the system. To see which forms are available on one or more queues, use the SHOW QUEUE command with the /FULL qualifier.

> Form names are created by the DEFINE/FORM command. You can specify a particular form for a print job by using the /FORM qualifier with the PRINT or SET ENTRY command. Forms are assigned to queues with the INITIALIZE/QUEUE, the SET QUEUE, or the START/QUEUE command.

### Qualifiers

> #### /BRIEF (default)

> Displays a brief description (form names, numbers, and descriptions) about the forms on the system.

> #### /FULL

> Displays a full description (including paper size and margin settings) about the forms on the system.

> #### /OUTPUT[=filespec]

> #### /NOOUTPUT

> Controls where the output of the command is sent. By default the output of the SHOW QUEUE/FORM command is sent to the current SYS$OUTPUT device (usually your terminal). To send the output to a file, use the /OUTPUT qualifier followed by a file specification.

> The file specification cannot include the asterisk (*) and the percent sign (%) wildcard characters. If you enter a partial file specification (for example, specifying only a directory), SHOW is the default file name and .LIS is the default file type.

> If you enter the /NOOUTPUT qualifier, output is suppressed.

###

#### Examples

#1
    $ SHOW QUEUE/FORM DEFAULT
    Form name                         Number   Description
    ---------                         ------   -----------
    DEFAULT                                0   System-defined default

> The SHOW QUEUE/FORM command in this example displays only the default form.

#2
    $ SHOW QUEUE/FORM LN01*
    Form name                            Number   Description
    ---------                            ------   -----------
    LN01_LANDSCAPE (stock=DEFAULT)          105   132 by 66 (landscape)
    LN01_LANDSCAPE_INDENTED (stock=DEFAULT)
                                            107   132 by 65 (landscape)
    LN01_PORTRAIT (stock=DEFAULT)           106   80 by 60 (portrait)

> The SHOW QUEUE/FORM command in this example displays the names of all forms, including the stock, that begin with LN01. The display includes the names, stock for each form, numbers, and brief descriptions of those forms.

#3
    $ SHOW QUEUE/FORM/FULL
    Form name                       Number   Description
    ---------                       ------   -----------
    132_51_STD (stock=DEFAULT)         102   132 by 51 (standard short)
        /LENGTH=51 /MARGIN=(BOTTOM=6) /STOCK=DEFAULT /TRUNCATE
        /WIDTH=132
    40_66_STD (stock=DEFAULT)          103   40 by 66 (standard labels)
        /LENGTH=66 /MARGIN=(BOTTOM=6) /STOCK=DEFAULT /WIDTH=40
    BLUE_PAPER_STOCK (stock=DIGITAL_8X11_STOCK1412TEA)
                                     22222 blue paper, DEC order# 22222
        /LENGTH=66 /MARGIN=(BOTTOM=6) /STOCK=DIGITAL_8X11_STOCK1412TEA
        /TRUNCATE  /WIDTH=80
    DEFAULT                              0   System-defined default
        /LENGTH=66 /MARGIN=(BOTTOM=6) /STOCK=DEFAULT /TRUNCATE
        /WIDTH=132
    LN01_LANDSCAPE (stock=DEFAULT)     105   132 by 66 (landscape)
        /LENGTH=66 /STOCK=DEFAULT /WIDTH=132
    LN01_LANDSCAPE_INDENTED (stock=DEFAULT)
                                       107   132 by 65 (landscape)
        /LENGTH=65 /SETUP=(LN01_TOP_MARGIN_150) /STOCK=DEFAULT
        /WIDTH=132
    LN01_PORTRAIT (stock=DEFAULT)      106   80 by 60 (portrait)
        /LENGTH=60 /SETUP=(LN01_PORTRAIT) /STOCK=DEFAULT /WIDTH=80
    MEMO (stock=DEFAULT)               110   LN03 indented memo format
        /LENGTH=64 /MARGIN=(TOP=2,LEFT=5) /STOCK=DEFAULT /TRUNCATE
        /WIDTH=80

> This SHOW QUEUE/FORM command also displays the names of all form types and stock for the system. By using the /FULL qualifier, you can see what image size has been set for each form type.

Previous | Next | Contents | Index

| privacy and legal statement |
9996PRO_073.HTML