OpenVMS DCL Dictionary

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

/PRINTER

Puts the display in a file and queues the file to SYS$PRINT for printing under the name given by the /OUTPUT qualifier. If you do not specify the /OUTPUT qualifier, output is directed to a temporary file named DIRECTORY.LIS, which is queued for printing and then is deleted.

/PROTECTION

/NOPROTECTION (default)

Controls whether the file protection for each file is listed.

/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.

/SECURITY

Controls whether information about file security is displayed; using the /SECURITY qualifier is equivalent to using the /ACL, /OWNER, and /PROTECTION qualifiers together. ACEs that were created with the hidden option are displayed only if the SECURITY privilege is turned on.

For further information, see the OpenVMS Guide to System Security.

/SELECT=(keyword[,...])

Allows you to select files for display. Choose one of the following keywords:

ACL
NOACL

Displays files that have an associated ACL or files that do not (NOACL keyword).

FILE=(option[,...])

Displays portions of the file specification. The /SELECT=FILE qualifier is used to turn off specific portions by explicit or implicit specification of the options. Possible options are:

[NO]NODE
[NO]DEVICE
[NO]DIRECTORY
[NO]NAME
[NO]TYPE
[NO]VERSION

/SELECT=FILE qualifier cannot be used with the /FULL qualifier.

ONLINE
NOONLINE

Displays files that are online or shelved.

SHELVABLE
NOSHELVABLE

Displays files that are shelvable or not shelvable.

SIZE=(option[,...])

Displays files according to their size. Possible options are:

Option	Description
MAXIMUM= n	Displays files that have fewer blocks than the value of n, which defaults to 1,073,741,823. Use with MINIMUM=n to specify a size range for files to be displayed.
MINIMUM= n	Displays files that have blocks equal to or greater than the value of n. Use with MAXIMUM=n to specify a size range for files to be displayed.
(MINIMUM= n, MAXIMUM= n)	Displays files whose block size falls within the specified MINIMUM and MAXIMUM range.

By default, file selection is based on other criteria.

/SHELVED_STATE

Displays whether the file is shelved or online.

/SINCE[=time]

Selects only those files dated after the specified time. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the following keywords: BOOT, LOGIN, TODAY (default), TOMORROW, or YESTERDAY. Specify one of the following qualifiers with the /SINCE qualifier to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED (default), /EXPIRED, or /MODIFIED.

For complete information on specifying time values, see the OpenVMS User's Manual or the topic SPECIFY Date_Time in online help.

/SIZE[=option]

/NOSIZE (default)

Displays the size in blocks of each file. If you omit the option parameter, the default lists the file size in blocks used (USED). Specify one of the following options:

ALL	Lists the file size both in blocks allocated and blocks used.
ALLOCATION	Lists the file size in blocks allocated.
USED	Lists the file size in blocks used.

The size of this field can be altered by supplying the size value of the /WIDTH qualifier.

/TIME[=option]

/NOTIME (default)

The same as the /DATE qualifier: includes the backup, creation, expiration, or modification time for each specified file; the default is the /NOTIME qualifier. If you use the /TIME qualifier without an option, the creation time is provided. Possible options are as follows:

Option	Description
ALL	Specifies creation, expiration, backup, and last modification times.
BACKUP	Specifies the last backup time.
CREATED	Specifies the creation time.
EFFECTIVE	Specifies the effective time the contents are valid.
EXPIRED	Specifies the expiration time.
MODIFIED	Specifies the last modification time.
RECORDING	Specifies the recording time on the media.

/TOTAL

Displays only the directory name and total number of files.

By default, the output format is determined by the /BRIEF qualifier, which gives this total but also lists all the file names, file types, and their version numbers.

/TRAILING

/NOTRAILING

Controls whether trailing lines that provide the following summary information are displayed:

Number of files listed
Total number of blocks used per directory
Total number of blocks allocated
Total number of directories and total blocks used or allocated in all directories (only if more than one directory is listed)

By default, the output format includes most of this summary information. The /SIZE and /FULL qualifiers determine more precisely what summary information is included.

When used alone, the /TRAILING qualifier lists the number of files in the directory. When used with the /SIZE qualifier, the /TRAILING qualifier lists the number of files and the number of blocks (displayed according to the option of the /SIZE qualifier, FULL or ALLOCATION). When used with the /FULL qualifier, the /TRAILING qualifier lists the number of files as well as the number of blocks used and allocated. If more than one directory is listed, the summary includes the total number of directories, the total number of blocks used, and the total number of blocks allocated.

/VERSIONS=n

Specifies the number of versions of a file to be listed. The default is all versions of each file. A value less than 1 is not allowed.

/WIDTH=(keyword[,...])

Formats the width of the display. If you specify only one keyword, you can omit the parentheses. Possible keywords are as follows:

DISPLAY= n	Specifies the total width of the display as an integer in the range 1 to 256 and defaults to zero (setting the display width to the terminal width). If the total width of the display exceeds the terminal width, the information will be truncated.
FILENAME= n	Specifies the width of the file name field; defaults to 19 characters. If you request another piece of information to be displayed along with the file name in each column, file names that exceed the n parameter cause the line to wrap after the file name field. (See the /COLUMNS qualifier.)
OWNER= n	Specifies the width of the owner field; defaults to 20 characters. If the owner's user identification code (UIC) exceeds the length of the owner field, the information will be truncated.
SIZE= n	Specifies the width of the size field; defaults to 6 characters on systems prior to OpenVMS Version 6.0; the default is 7 characters on OpenVMS Version 6.0 systems or higher. If the file size exceeds the length of the size field, the field is filled with asterisks.

/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

$ DIRECTORY AVERAGE.*
 
Directory DISK$DOCUMENT:[MALCOLM]
 
AVERAGE.EXE;6      AVERAGE.FOR;6      AVERAGE.LIS;4     AVERAGE.OBJ;12
 
Total of 4 files.

In this example, the DIRECTORY command lists all files with the file name AVERAGE and any file type.

$ DIRECTORY/SIZE=USED/DATE=CREATED/VERSIONS=1/PROTECTION  AVERAGE
 
Directory DISK$DOCUMENT:[MALCOLM] 
 
AVERAGE.EXE;6       6        19-APR-1995 15:43:02.10 (RE,RE,RWED,RE)
AVERAGE.FOR;6       2        19-APR-1995 10:29:53.37 (RE,RE,RWED,RE)
AVERAGE.LIS;4       5        19-APR-1995 16:27:27.19 (RE,RE,RWED,RE)
AVERAGE.OBJ;6       2        19-APR-1995 16:27:44.23 (RE,RE,RWED,RE)
 
Total of 4 files, 15 blocks.

In this example, the DIRECTORY command lists the number of blocks used, the creation date, and the file protection code for the highest version number of all files named AVERAGE in the current directory.

$ DIRECTORY/FULL DISK$GRIPS_2:[VMS.TV]DEMO.EXE
 
Directory DISK$GRIPS_2:[VMS.TV]
 
DEMO.EXE;1                      File ID:  (36,11,0)     
Size:           390/390         Owner:    [0,0]
Created:  12-NOV-1995 11:45:19.00
Revised:  14-DEC-1995 15:45:19.00 (34)
Expires:   <None specified>
Backup:   28-NOV-1995 04:00:12.22
Effective: <None specified>
Recording: <None specified>
File organization:  Sequential
Shelved state:      Online
File attributes:    Allocation: 390, Extend: 0, Global buffer count: 0, 
                    Version limit: 0, Backups disabled, Not shelvable
Record format:      Fixed length 512 byte records
Record attributes:  None
RMS attributes:     None
Journaling enabled: None
File protection:    System:RE, Owner:RE, Group:RE, World:RE
Access Cntrl List:  None
 
Total of 1 file, 390/390 blocks.

The example illustrates the DIRECTORY/FULL command.

$ DIRECTORY/VERSIONS=1/COLUMNS=1 AVERAGE.*

The DIRECTORY command in this example lists only the highest version of each file named AVERAGE in the current default directory. The format is brief and restricted to one column. Heading and trailing lines are provided.

$ DIRECTORY BLOCK%%%

The DIRECTORY command in this example locates all versions and types of files in the default device and directory whose names begin with the letters BLOCK and end with any three additional characters. The default output format is brief, four columns, with heading and trailing lines.

$ DIRECTORY/EXCLUDE=(AVER.DAT;*,AVER.EXE;*) [*...]AVER

The DIRECTORY command in this example lists and totals all versions and types of files named AVER in all directories and subdirectories on the default disk, except any files named AVER.DAT and AVER.EXE.

$ DIRECTORY/SIZE=ALL FRESNO::DISK1:[TAYLOR]*.COM

The DIRECTORY command in this example lists all versions of all files with the file type COM in the directory TAYLOR on node FRESNO and device DISK1. The listing includes the file size both in blocks used and in blocks allocated for each file.

$ DIRECTORY-
_$ /MODIFIED/SINCE=14-DEC-1995:01:30/SIZE=ALL/OWNER-
_$ /PROTECTION/OUTPUT=UPDATE/PRINTER [A*]

The DIRECTORY command in this example locates all files that have been modified since 1:30 a.m. on December 14, 1995, and that reside on the default disk in all directories whose names begin with the letter A. It formats the output to include all versions, the size used and size allocated, the date last modified, the owner, and the protection codes. The output is directed to a file named UPDATE.LIS, which is queued automatically to the default printer queue and then is deleted.

$ DIRECTORY/SHELVED_STATE 
Directory MYDISK:[SMITH]
MYFILE.TXT;2            Online
NOT_SHELVED.TXT;1       Online
SHELVED.TXT             Shelved
Total of 3 files.

The DIRECTORY command in this example lists all the files in a directory and shows whether a file is shelved, online, or remote.

DISABLE AUTOSTART

Disables the autostart feature on a node for all autostart queues managed by the specific queue manager. By default, this command uses the /QUEUES qualifier.
Requires OPER (operator) privileges.
For more information on autostart queues, see the chapter on batch and print queues in the OpenVMS System Manager's Manual.

Format

DISABLE AUTOSTART[/QUEUES]

PARAMETERS

None.

DESCRIPTION

The DISABLE AUTOSTART/QUEUES command notifies the queue manager to perform the following tasks on the affected node:

Mark all of the queue manager's autostart queues as "stop pending" in preparation for a planned shutdown.
Prevent any of the queue manager's autostart queues from failing over to the node.
Upon completion of any jobs currently executing on any of that queue manager's autostart queues, force the queue to fail over to the next available node in the queue's failover list (if any) on which autostart is enabled. (For information on failover lists for autostart queues, see the /AUTOSTART_ON qualifier for the INITIALIZE/QUEUE command.)

Autostart queues on the node that do not have a failover list, or for which no failover node is enabled for autostart, are stopped upon completion of any current jobs. These stopped queues remain activated for autostart. The queue manager will restart these stopped autostart queues when the ENABLE AUTOSTART command is entered for the affected node or a node to which the queue can fail over.
By default the command affects the node on which it is entered. Specify the /ON_NODE qualifier to disable autostart on a different node.
The DISABLE AUTOSTART/QUEUES command is included in the node shutdown command procedure SHUTDOWN.COM. If you shutdown a node without using SHUTDOWN.COM, and the node is running autostart queues, you might want to enter the DISABLE AUTOSTART/QUEUES command first.
The DISABLE AUTOSTART/QUEUES command only affects autostart queues.

QUALIFIERS

/NAME_OF_MANAGER=name
Specifies the name of the queue manager controlling the autostart queues you want to disable. The qualifier allows the autostart feature to be used differently for different sets of queues.
If the /NAME_OF_MANAGER qualifier is omitted, the default queue manager name SYS$QUEUE_MANAGER is used. For more information on multiple queue managers, see the OpenVMS System Manager's Manual.
/ON_NODE=nodename
Specifies a node in an OpenVMS Cluster system. Use this qualifier to disable autostart on a node other than the one from which you enter the command.
/QUEUES
Specifies that autostart is to be disabled for queues. (This qualifier is used by default.)

Examples

$ INITIALIZE/QUEUE/BATCH/START/AUTOSTART_ON=SATURN:: BATCH_1
$ ENABLE AUTOSTART/QUEUES
   .
   .
   .
$ DISABLE AUTOSTART/QUEUES

In this example, the INITIALIZE/QUEUE command creates an autostart queue BATCH_1, capable of executing on node SATURN. The /START qualifier activates the queue for autostart. The ENABLE/AUTOSTART/QUEUES command (executed on node SATURN) enables autostart on the node, causing the queue (and any other active autostart queues on the node) to begin executing jobs.
The DISABLE AUTOSTART command (executed on node SATURN) stops autostart queues on the node, and prevents any queues from failing over to the node.
This command only affects queues managed by the default queue manager SYS$QUEUE_MANAGER because the /NAME_OF_MANAGER qualifier is not specified.
Because BATCH_1 is set up to run only on one node, the queue cannot fail over to another node and therefore is stopped. However, the queue remains active for autostart and will be started when the ENABLE AUTOSTART command is entered for node SATURN. No START/QUEUE command is needed to restart BATCH_1 unless autostart of the queue is deactivated with the STOP/QUEUE/NEXT or STOP/QUEUE/RESET command.

$ DISABLE AUTOSTART/QUEUES/ON_NODE=JADE

The DISABLE AUTOSTART/QUEUES command in this example disables autostart on the OpenVMS Cluster node JADE. This command can be entered from any node in the cluster.

DISCONNECT

Breaks the connection between a physical terminal and a virtual terminal. After the physical terminal is disconnected, both the virtual terminal and the process using it remain on the system.
Requires that your physical terminal is connected to a virtual terminal.

Format

DISCONNECT

PARAMETERS

None.

DESCRIPTION

Use the DISCONNECT command to disconnect a physical terminal from a virtual terminal and its associated process. The virtual terminal and the process remain on the system, so you can use the CONNECT command to reconnect to the process later. (For more information about virtual terminals and how to connect to them, see the description of the CONNECT command.) To terminate a process connected to a virtual terminal, use the LOGOUT command.
After you are disconnected from a virtual terminal, you can use the physical terminal to log in again.
You can use the DISCONNECT command only if your physical terminal is connected to a virtual terminal.

QUALIFIER

/CONTINUE

/NOCONTINUE (default)
Controls whether the CONTINUE command is executed in the current process just before connecting to another process. This procedure permits an interrupted image to continue processing after the disconnection until the process needs terminal input or attempts to write to the terminal. At that point, the process waits until the physical terminal is reconnected to the virtual terminal.

Examples

$ DISCONNECT

This command disconnects a physical terminal from a virtual terminal, but does not log the process out. Now you can use the physical terminal to log in again.

$ RUN PAYROLL
[Ctrl/Y]
$ DISCONNECT/CONTINUE

In this example, the RUN command is entered from a physical terminal that is connected to a virtual terminal. After the image PAYROLL.EXE is interrupted, the DISCONNECT command disconnects the physical and the virtual terminals without logging out the process. The /CONTINUE qualifier allows the image PAYROLL.EXE to continue to execute until the process needs terminal input or attempts to write to the terminal. At that point, the process waits until the physical terminal is reconnected to the virtual terminal. However, you can use the physical terminal to log in again and perform other work.

DISMOUNT

Closes a mounted disk or tape volume for further processing and deletes the logical name associated with the device.
Requires the GRPNAM (group logical name) and SYSNAM (system logical name) privileges to dismount group and system volumes.

Format

DISMOUNT device-name[:]

PARAMETER

device-name[:]
Name of the device containing the volume---either a logical name or a physical name. If a physical name is specified, the controller defaults to A and the unit defaults to 0.
If the volume currently mounted on the device is a member of a disk or tape volume set, all volumes in the set are dismounted, unless the /UNIT qualifier is specified.

DESCRIPTION

The DISMOUNT command (which invokes the $DISMOU system service) checks for conditions that prevent a Files-11 volume from dismounting. The conditions fall into the following categories:

Installed swap and page files
Installed images
Devices spooled to the volume
Open user files (any files not falling into one of the first three categories)

If the DISMOUNT command does not find any of these conditions, it performs the following operations:

Removes the volume from the user's list of mounted volumes, deletes the logical name (if any) associated with the volume, and decrements the mount count.
If the mount count equals zero after being decremented, the DISMOUNT command marks the volume for dismounting.
As soon as the volume is idle, that is, after the DISMOUNT command has determined that no user has any open files on the volume, the DISMOUNT command marks a Files-11 volume for dismounting, and dismounts the volume soon.
If the mount count does not equal zero after being decremented, the DISMOUNT command does not mark the volume for dismount (because the volume must have been mounted shared). In this case, the total effect for the issuing process is that the process is denied access to the volume and the logical name is deleted.
After a volume is dismounted, nonpaged pool is returned to the system. Paged pool is also returned if the volume was mounted using the /GROUP or /SYSTEM qualifiers.

If the DISMOUNT command does find open files or any other condition that prevents the volume from dismounting, it does not mark the volume for dismounting. Instead, the DISMOUNT command displays a message indicating that the volume cannot be dismounted, followed by messages indicating the conditions that exist and the number of instances of each condition.
The /OVERRIDE=CHECKS qualifier allows a volume to be marked for dismounting despite open files or other conditions. For example, marking a volume for dismounting prevents any new files from being opened. Also, when a volume is marked for dismounting, file-system caches are flushed. This activity is especially important when the system is shutting down and the file-system caches must be written to the disk.
If a volume is part of a Files-11 volume set and the /UNIT qualifier is not specified, the entire volume set will be dismounted.
If the volume was mounted with the /SHARE qualifier, it is not actually dismounted until all users who mounted it dismount it or log out. However, the DISMOUNT command deletes the logical name associated with the device.
If the device was allocated with an ALLOCATE command, it remains allocated after the volume is dismounted with the DISMOUNT command. If the device was implicitly allocated by the MOUNT command, the DISMOUNT command deallocates it.
If the volume was mounted with the /GROUP or the /SYSTEM qualifier, it is dismounted even if other users are currently accessing it. The GRPNAM and SYSNAM user privileges are required to dismount group and system volumes, respectively.

QUALIFIERS

/ABORT
Requires volume ownership or the user privilege VOLPRO (volume protection) to use this qualifier with a volume that was mounted with neither the /GROUP nor the /SYSTEM qualifier. Additionally requires the user privilege SHARE if the volume is mounted privately by a process other than the process issuing the DISMOUNT command.
Specifies that the volume is to be dismounted, regardless of who mounted it. The primary purpose of the /ABORT qualifier is to terminate mount verification. The DISMOUNT/ABORT command also cancels any outstanding I/O requests. If the volume was mounted with the /SHARE qualifier, the /ABORT qualifier causes the volume to be dismounted for all of the users who mounted it.
/CLUSTER
Dismounts a volume throughout a dual-architecture OpenVMS Cluster system. If you specify DISMOUNT/CLUSTER, the DISMOUNT command checks for open files or other conditions that will prevent a Files-11 volume on the local node from dismounting. If the DISMOUNT command does not find any open files or other conditions, it checks for conditions on all other nodes in the OpenVMS Cluster. If the DISMOUNT command finds one of the conditions on any node, it displays an error message identifying the device and the nodes on which the error occurred, followed by an error message indicating open files or other conditions on the volume.
After the DISMOUNT command successfully dismounts the volume on the local node, it dismounts the volume on every other node in the existing OpenVMS Cluster environment. If the system is not a member of a cluster, the /CLUSTER qualifier has no effect.
/OVERRIDE=CHECKS
Marks a Files-11 volume for dismounting even if files are open on the volume. If you specify DISMOUNT/OVERRIDE=CHECKS, the DISMOUNT command displays messages indicating any open files or other conditions that prevent dismounting, immediately followed by a message indicating that the volume has been marked for dismounting.
A substantial amount of time can pass between the time you enter the DISMOUNT/OVERRIDE=CHECKS command and the completion of the dismount operation. Always wait for the dismount to complete before you remove the volume. (To verify that the dismount has completed, enter the SHOW DEVICES command.) Note that the final phase of volume dismounting occurs in the file system, and all open files on the volume must be closed before the actual dismount can be done. Note also that the file system cannot dismount a volume while any known file lists associated with it contain entries.
/UNIT
Dismounts only one volume of a volume set on the specified device. By default, all volumes in a set are dismounted.

Note
Avoid dismounting the root volume of a volume set, because it contains the master file directory (MFD). It may be impossible to access files on a volume set if the MFD is not accessible.

/UNLOAD

/NOUNLOAD
Determines whether the device on which the volume is mounted is physically unloaded. If you specify the DISMOUNT command without the /UNLOAD or the /NOUNLOAD qualifier, the qualifier that you specified with the MOUNT command (either /UNLOAD or /NOUNLOAD) determines whether the volume is unloaded physically.

Examples

$ MOUNT MTA0: PAYVOL TAPE
   .
   .
   .
$ DISMOUNT TAPE

Previous | Next | Contents | [Home] | [Comments] | [Ordering info] | [Help]
  9996P013.HTM
  OSSG Documentation
  26-NOV-1996 11:17:12.31
Copyright © Digital Equipment Corporation 1996. All Rights Reserved.

Legal