OpenVMS DCL Dictionary

Document revision date: 19 July 1999

OpenVMS DCL Dictionary

Contents

Index

RENAME

Changes all or part of a file specification of an existing disk file or disk directory.

Format

RENAME input-filespec[,...] output-filespec

Parameters

input-filespec[,...]
Specifies the name of one or more files whose specifications are to be changed. The asterisk (*) and the percent sign (%) wildcard characters are allowed in the directory specification, file name, file type, or version number fields of the file specification. When wildcard characters are used, all files whose specifications satisfy the wildcard fields are renamed.
output-filespec
Provides the new file specification to be applied to the input file. The RENAME command uses the device, directory, file name, and file type of the input file as defaults for fields in the output file that are either unspecified, or are indicated by the asterisk (*) and the percent sign (%) wildcard characters. Wildcard characters in corresponding fields of the input and output file specification result in multiple rename operations. The RENAME command supplies output file version numbers in the following ways:

If the output file specification contains an explicit version number, that version number is used.
If the output file specification contains an asterisk (*) or a percent sign (%) wildcard character as the version number, the version number of the input file is used.
If the input file specification contains an asterisk (*) or a percent sign (%) wildcard character as the version number, the version number of each input file names a corresponding output file.
If no file exists with the same file name and type as the output file, the new file is assigned a version number of 1.
If a file already exists with the same file name and type as the output file, the next higher version number is used (unless the /NONEWVERSION qualifier is specified).

Description

The RENAME command changes the directory name, file name, file type, or version number of a file. The node and disk designation for the input file specification must be the same as that for the output file specification. In addition, you must have delete (D) access privileges to a file to rename the file. You cannot rename a file across a network.

Qualifiers

/BACKUP
Modifies the time value specified with the /BEFORE or the /SINCE qualifier. The /BACKUP qualifier selects files according to the dates of their most recent backups. This qualifier is incompatible with the /CREATED, /EXPIRED, and /MODIFIED qualifiers, which also allow you to select files according to time attributes. If you specify none of these four time qualifiers, the default is the /CREATED qualifier.
/BEFORE[=time]
Selects only those files dated prior to the specified time. You can specify time as 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 /BEFORE 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, refer to the OpenVMS User's Manual or the online help topic DCL_Tips (subtopic Date_Time).
/BY_OWNER[=uic]
Selects only those files whose owner user identification code (UIC) matches the specified owner UIC. The default UIC is that of the current process.
Specify the UIC by using standard UIC format as described in the OpenVMS Guide to System Security.
/CONFIRM

/NOCONFIRM (default)
Controls whether a request is issued before each rename operation to confirm that the operation should be performed on that file. The following responses are valid:

YES NO QUIT

TRUE FALSE Ctrl/Z

1 0 ALL

[Return]

You can use any combination of uppercase and lowercase letters for word responses. Word responses can be abbreviated to one or more letters (for example, T, TR, or TRU for TRUE), but these abbreviations must be unique. Affirmative answers are YES, TRUE, and 1. Negative answers include: NO, FALSE, 0, and pressing the Return key. Entering QUIT or pressing Ctrl/Z indicates that you want to stop processing the command at that point. When you respond by entering ALL, the command continues to process, but no further prompts are given. If you type a response other than one of those in the list, DCL issues an error message and redisplays the prompt.
/CREATED (default)
Modifies the time value specified with the /BEFORE or the /SINCE qualifier. The /CREATED qualifier selects files based on their dates of creation. This qualifier is incompatible with the /BACKUP, /EXPIRED, and /MODIFIED qualifiers, which also allow you to select files according to time attributes. If you specify none of these four time qualifiers, the default is the /CREATED qualifier.
/EXCLUDE=(filespec[,...])
Excludes the specified files from the rename operation. You can include a directory but not a device in the file specification. The asterisk (*) and the percent sign (%) wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you specify only one file, you can omit the parentheses.
/EXPIRED
Modifies the time value specified with the /BEFORE or the /SINCE qualifier. The /EXPIRED qualifier selects files according to their expiration dates. (The expiration date is set with the SET FILE/EXPIRATION_DATE command.) This qualifier is incompatible with the /BACKUP, /CREATED, and /MODIFIED qualifiers, which also allow you to select files according to time attributes. If you specify none of these four time qualifiers, the default is the /CREATED qualifier.
/INHERIT_SECURITY

/NOINHERIT_SECURITY (default)
Controls whether the security profile (UIC, protection code, and ACL) of the renamed file is altered. If you specify /INHERIT_SECURITY, a new security profile is generated, as if a new file had been created with the new file and directory names. Refer to the OpenVMS Guide to System Security or online help (Hints topic) for a description of how a profile is assigned.
/LOG

/NOLOG (default)
Displays the file specification of each file as it is renamed.
/MODIFIED
Modifies the time value specified with the /BEFORE or the /SINCE qualifier. The /MODIFIED qualifier selects files according to the dates on which they were last modified. This qualifier is incompatible with the /BACKUP, /CREATED, and /EXPIRED qualifiers, which also allow you to select files according to time attributes. If you specify none of these four time modifiers, the default is the /CREATED qualifier.
/NEW_VERSION (default)

/NONEW_VERSION
Assigns a new version number if an output file specification is the same as that of an existing file. The /NONEW_VERSION qualifier displays an error message if an output file specification is the same as that of an existing file. The asterisk (*) and the percent sign (%) wildcard characters appearing in the version field of an input or output file overrides these qualifiers.
/SINCE[=time]
Selects only those files dated after the specified time. You can specify time as 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, refer to the OpenVMS User's Manual or the online help topic DCL_Tips (subtopic Date_Time).
/STYLE=keyword
Specifies the file name format for display purposes.
The valid keywords for this qualifier are CONDENSED and EXPANDED. Descriptions are as follows:

Keyword Explanation

CONDENSED (default) Displays the file name representation of what is generated to fit into a 255-length character string. This file name may contain a DID or FID abbreviation in the file specification.

EXPANDED Displays the file name representation of what is stored on disk. This file name does not contain any DID or FID abbreviations.

The keywords CONDENSED and EXPANDED are mutually exclusive. This qualifier specifies which file name format is displayed in the output message, along with the confirmation if requested.
File errors are displayed with the CONDENSED file specification unless the EXPANDED keyword is specified.
Refer to the OpenVMS Guide to Extended File Specifications for more information.

Keyword	Explanation
CONDENSED (default)	Displays the file name representation of what is generated to fit into a 255-length character string. This file name may contain a DID or FID abbreviation in the file specification.
EXPANDED	Displays the file name representation of what is stored on disk. This file name does not contain any DID or FID abbreviations.

Examples

#1
$ RENAME AVERAGE.OBJ OLDAVERAGE

The RENAME command in this example renames the highest existing version of the file AVERAGE.OBJ to OLDAVERAGE.OBJ. If no file named OLDAVERAGE.OBJ currently exists, the new file is assigned a version number 1.

#2
$ RENAME/NONEW_VERSION SCANLINE.OBJ;2 BACKUP.OBJ

The RENAME command in this example renames the file SCANLINE.OBJ;2 to BACKUP.OBJ;2. The /NONEW_VERSION qualifier ensures that, if BACKUP.OBJ;2 already exists, the RENAME command does not rename the file, but instead reports the error.

#3
$ RENAME .TXT; .OLD;

The RENAME command in this example renames all versions of all files with the file type TXT to have the file type OLD. The file names and version numbers are not changed.

#4
$ RENAME WATER.TXT [.MEMOS]

The RENAME command in this example changes the directory name of WATER.TXT from your default directory to the MEMOS subdirectory. (The RENAME command moves the file to another directory.)

#5
$ RENAME [MALCOLM.TESTFILES]SAVE.DAT []TEST

The RENAME command in this example renames the file SAVE.DAT in the directory MALCOLM.TESTFILES to TEST.DAT. The new file is moved to the current default directory.

#6
$ RENAME/LOG $_From: DATA.,INFO. $_To: NEW %RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.AAA;1 renamed to _DISK0:[SYSTEM]NEW.AAA;1 %RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.BBB;1 renamed to _DISK0:[SYSTEM]NEW.BBB;1 %RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.CCC;1 renamed to _DISK0:[SYSTEM]NEW.CCC;1 %RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.001;1 renamed to _DISK0:[SYSTEM]NEW.001;1 %RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.002;1 renamed to _DISK0:[SYSTEM]NEW.002;1 %RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.003;1 renamed to _DISK0:[SYSTEM]NEW.003;1 $

$ RENAME/LOG
$_From:      DATA.*,INFO.*
$_To:        NEW
%RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.AAA;1 renamed to _DISK0:[SYSTEM]NEW.AAA;1
%RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.BBB;1 renamed to _DISK0:[SYSTEM]NEW.BBB;1
%RENAME-I-RENAMED, _DISK0:[SYSTEM]DATA.CCC;1 renamed to _DISK0:[SYSTEM]NEW.CCC;1
%RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.001;1 renamed to _DISK0:[SYSTEM]NEW.001;1
%RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.002;1 renamed to _DISK0:[SYSTEM]NEW.002;1
%RENAME-I-RENAMED, _DISK0:[SYSTEM]INFO.003;1 renamed to _DISK0:[SYSTEM]NEW.003;1
$

In this example, three files exist with the file name of DATA, and three files have the file name of INFO. This RENAME command illustrates the asterisk (*) wildcard character in the input file names and the use of temporary default file types and version numbers on the output files. The result is the renaming of all six files as displayed by the /LOG qualifier.

#7
$ RENAME NODE1::DISK2:[SMITH]ASSEMSHT.EXE NODE1::DISK3:[JONES]ASSEMBLYSHEET.EXE

The RENAME command in this example renames the file ASSEMSHT.EXE in the SMITH directory on remote node NODE1 and disk DISK3 to ASSEMBLYSHEET.EXE in the JONES directory on the same remote node and disk. You can rename a file on another node and disk only if the new file resides on that same node and disk.

REPLY

Broadcasts a message to a terminal or terminals.
See the qualifier descriptions for restrictions.

Format

REPLY [message-text]

Parameter

message-text
Specifies the text of the message. The text must be 1 to 511 characters. Enclose the text in quotation marks (" ") if it contains spaces, special characters, or lowercase characters.

Description

All users with OPER (operator) privilege can use the REPLY command to communicate with system users. The REPLY command does the following:

Displays messages at users' terminals.
Responds to user requests.
Responds to magnetic tape file system requests.
Enables and disables operator status on a terminal (if the operator communication process [OPCOM] is running).
Closes the operator's log file and opens a new one (if OPCOM is running).

You must always use one or more qualifiers with the REPLY command in order for it to be meaningful. If you use the REPLY command without using any qualifiers, an error message is returned. When you use the REPLY command for any purpose other than displaying messages at users' terminals, you must also use the /ENABLE=keyword qualifier. See the description of the /ENABLE qualifier to determine the appropriate keyword (or keywords) for your purpose.
Displaying Messages at Users' Terminals

To contact one or more system users, the operator enters one of the following REPLY commands:

REPLY/ALL message-text
REPLY/TERMINAL=(terminal-name[,...]) message-text
REPLY/USERNAME[=(username[,...])] message-text

The /ALL qualifier sends a message to all terminals that are on line and are connected to the OpenVMS system or OpenVMS Cluster. Generally, when an important message is to be broadcast, such as information about a system shutdown, you should use the /ALL qualifier.
The /TERMINAL qualifier sends a message to one or more specific terminals on the system or cluster.
The /USERNAME qualifier sends a message to terminals at which one or more system or cluster users are logged in.
Note that the /TO qualifier is not used under these three circumstances, because the operator is not replying to a specific request from either the file system or a user.
To broadcast to a terminal other than your own, you must have OPER privilege. The REPLY command is not complete until all terminals you are broadcasting to have received the message.
Responding to User Requests

When a user enters the REQUEST/REPLY command, the process associated with the requesting user's terminal is put in a wait state until the operator responds by using one of the following REPLY commands:

REPLY/ABORT=identification-number message-text
REPLY/PENDING=identification-number message-text
REPLY/TO=identification-number message-text

The /ABORT qualifier indicates that the user's request has been canceled.
The /PENDING qualifier sends a message to the user and keeps the user's process in a wait state until the request can be fulfilled or aborted.
The /TO qualifier indicates that the user's request has been fulfilled.
When a user enters the REQUEST/REPLY command, the message is displayed at the system console terminal. For example:
%OPCOM, 24-DEC-1998 09:49:24.47, request 3, from user SYSTEM _TTB6:, This is a sample request
The user cannot enter any further commands until the operator responds using the /ABORT or the /TO qualifier, or until the user aborts the request. If the operator does not respond and the user does not abort the request, the request is repeated at 5-minute intervals on the operator's terminal until the operator replies.
The REPLY command is an essential part of the procedures that operators must use in order for users to gain access to tape and disk volumes.
Responding to File System Requests

When a multivolume tape volume reaches the end-of-tape (EOT) mark, the magnetic tape file system suspends processing and sends a message to the operator to mount the next tape. The operator responds using one of the following REPLY commands:

REPLY/TO=identification-number label
REPLY/INITIALIZE_TAPE=identification-number label
REPLY/BLANK_TAPE=identification-number label
REPLY/ABORT=identification-number

The /TO qualifier indicates that the file system request has been fulfilled. When the request from the magnetic tape file system specifies a volume label, the operator mounts the specified tape and enters the REPLY/TO command. However, if the file system requests a new volume, the operator can reuse a scratch volume by mounting it and by entering the REPLY/INITIALIZE_TAPE command. The operator also can mount a blank volume and then enter the REPLY/BLANK_TAPE command. In any case, the operator may add the message "label" to the REPLY command to specify the volume's label. The quotation marks (" ") are required syntax.
If the request is "REMOUNT" or "MOUNT NEW", the label is required in the message text. If the request is "MOUNT", no label is needed.
The /ABORT qualifier indicates that the file system request has been canceled.
Enabling and Disabling Operator Status on a Terminal

Any terminal connected to the operating system can be established as an operator's terminal if OPCOM is running. When an operator who is logged in to an account with OPER (operator) privilege enters the REPLY/ENABLE command at the designated terminal, that terminal can be used to respond to user requests and to monitor device status. Such a terminal retains operator status until it is specifically disabled, or until the end of the current interactive session, if it was established as a temporary operator's terminal (see the description of the /TEMPORARY qualifier).
Operator messages are printed on the system console terminal unless that terminal is explicitly disabled as an operator's terminal.
When the operator enters the REPLY/ENABLE command, OPCOM confirms that the terminal has been enabled. For example:
$ REPLY/ENABLE
%OPCOM, 24-DEC-1998 10:22:19.75, operator status for operator OPA0 CENTRAL, PRINTER, TAPES, DISKS, DEVICES, CARDS, NETWORK, CLUSTER, LICENSE, OPER1, OPER2, OPER3, OPER4, OPER5, OPER6, OPER7, OPER8, OPER9, OPER10, OPER11, OPER12
When the operator enters the REPLY/DISABLE command, OPCOM uses the following message to confirm that the terminal is no longer an operator terminal:
%OPCOM, 24-DEC-1998 10:03:23.48, operator disabled, operator OPA0
To grant specific operator status on a particular terminal, the operator includes one or more keywords after the /ENABLE qualifier. For example, to establish a terminal as an operator terminal that can receive messages pertaining to mounting and dismounting tapes and disks, the operator enters the following:
$ REPLY/ENABLE=(DISKS,TAPES)
%OPCOM, 24-DEC-1998 10:04:00.18, operator enabled, operator OPA0 $ %OPCOM, 24-DEC-1998 10:04:00.47, operator status for operator OPA0 TAPES, DISKS
OPCOM confirms that the terminal has operator status for tape and disk messages.
To discontinue specific operator status, the operator includes one or more keywords after the /DISABLE qualifier. For example, to inhibit an operator terminal from receiving messages pertaining to mounting and dismounting disks, the operator enters the following command:
$ REPLY/DISABLE=DISKS
%OPCOM, 24-DEC-1998 10:04:30.83, operator status for operator OPA0 TAPES
Note that OPCOM lists the specific operator status still assigned to the terminal.
When an operator disables operator status on all terminals, including the system console terminal, OPCOM records all subsequent messages in the operator log file, except user requests and messages requiring an operator reply.
%OPCOM-S-OPRNOTIF, operator notified, waiting. 10:06:03.25 %OPCOM-S-OPREPLY, %OPCOM 24-DEC-1998 10:06:03:25, no operator coverage
To determine the operator status and to obtain a list of pending requests for a particular terminal, the operator enters the following command:
$ REPLY/STATUS
This command also shows all outstanding requests for this operator.
Closing the Operator's Log File and Opening a New One

To close the current operator's log file and open a new one, the operator enters the REPLY/LOG command. If OPCOM is running, all subsequent messages are recorded in the new log file. To close the current log file without opening a new one, the operator enters the REPLY/NOLOG command. All subsequent messages are not recorded until the operator enters the REPLY/LOG command.

Qualifiers

/ABORT=identification-number
Sends a message to the user or magnetic tape file system corresponding to the unique identification number and cancels the request.
/ALL
Requires OPER (operator) privilege.
Broadcasts a message to all terminals that are attached to the system or cluster. These terminals must be turned on and have broadcast-message reception enabled. The /ALL qualifier is incompatible with the /USERNAME and /TERMINAL qualifiers.
/BELL
Rings a bell at the terminal receiving a message when entered with the /ALL, the /TERMINAL, or the /USERNAME qualifier; two bells when entered with the /URGENT qualifier; and three bells when entered with the /SHUTDOWN qualifier.
/BLANK_TAPE=identification-number
Requires VOLPRO (volume protection) privilege.
Sends a message to the magnetic tape file system indicated by the identification number to override the checking of volume label information. The volume label must be specified in the message-text parameter. The current terminal must be enabled as an operator terminal for TAPES.
/DISABLE[=(keyword[,...])]
Requires OPER (operator) privilege. Requires OPER and SECURITY privileges for security messages.
If the operator communication manager (OPCOM) is running, restores to normal (that is, nonoperator) status the terminal at which the command is entered. The /DISABLE qualifier cannot be entered from a batch job. To restrict the types of messages displayed on an operator's terminal, specify one of the following keywords:

CARDS Inhibits messages sent to the card readers.

CENTRAL Inhibits messages sent to the central system operator.

CLUSTER Inhibits messages from the connection manager pertaining to cluster state changes.

DEVICES Inhibits messages pertaining to mounting disks.

DISKS Inhibits messages pertaining to mounting and dismounting disk volumes.

LICENSE Inhibits messages pertaining to software licenses.

NETWORK Inhibits messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.

OPER1 to OPER12 Inhibits messages sent to operators identified as OPER1 to OPER12.

PRINTER Inhibits messages pertaining to print requests.

SECURITY Inhibits messages pertaining to security events; requires SECURITY privilege.

TAPES Inhibits messages pertaining to mounting and dismounting tape volumes.

When an operator logs out from a remote or a dial-in terminal, the operator terminal is automatically disabled.
/ENABLE[=(keyword[,...])]
Requires OPER (operator) privilege. Requires OPER and SECURITY privileges for security messages.
Designates as an operator's terminal the terminal at which the REPLY command is entered, if OPCOM is running. The /ENABLE qualifier cannot be entered from a batch job. To enable the following types of messages displayed on an operator's terminal, specify one of the following keywords:

CARDS Displays messages sent to the card readers.

CENTRAL Displays messages sent to the central system operator.

CLUSTER Displays messages from the connection manager pertaining to cluster state changes.

DEVICES Displays messages pertaining to mounting disks.

DISKS Displays messages pertaining to mounting and dismounting disk volumes.

LICENSE Diplays messages pertaining to software licenses.

NETWORK Displays messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.

OPER1 to OPER12 Displays messages sent to operators identified as OPER1 to OPER12.

PRINTER Displays messages pertaining to print requests.

SECURITY Allows messages pertaining to security events; requires SECURITY privilege.

TAPES Allows messages pertaining to mounting and dismounting tape volumes.

/INITIALIZE_TAPE=identification-number
Sends a message to the magnetic tape file system indicated by the identification number to initialize a magnetic tape volume. This qualifier can be used whenever the file system requests the mounting of a new volume. The system performs normal protection and expiration checks before initializing the volume. The current terminal must be enabled as an operator terminal for TAPES.

Previous Next Contents Index

privacy and legal statement

9996PRO_042.HTML

CARDS	Inhibits messages sent to the card readers.
CENTRAL	Inhibits messages sent to the central system operator.
CLUSTER	Inhibits messages from the connection manager pertaining to cluster state changes.
DEVICES	Inhibits messages pertaining to mounting disks.
DISKS	Inhibits messages pertaining to mounting and dismounting disk volumes.
LICENSE	Inhibits messages pertaining to software licenses.
NETWORK	Inhibits messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.
OPER1 to OPER12	Inhibits messages sent to operators identified as OPER1 to OPER12.
PRINTER	Inhibits messages pertaining to print requests.
SECURITY	Inhibits messages pertaining to security events; requires SECURITY privilege.
TAPES	Inhibits messages pertaining to mounting and dismounting tape volumes.

CARDS	Displays messages sent to the card readers.
CENTRAL	Displays messages sent to the central system operator.
CLUSTER	Displays messages from the connection manager pertaining to cluster state changes.
DEVICES	Displays messages pertaining to mounting disks.
DISKS	Displays messages pertaining to mounting and dismounting disk volumes.
LICENSE	Diplays messages pertaining to software licenses.
NETWORK	Displays messages pertaining to networks; the keyword CENTRAL must also be specified to inhibit network messages.
OPER1 to OPER12	Displays messages sent to operators identified as OPER1 to OPER12.
PRINTER	Displays messages pertaining to print requests.
SECURITY	Allows messages pertaining to security events; requires SECURITY privilege.
TAPES	Allows messages pertaining to mounting and dismounting tape volumes.