Copyright Digital Equipment Corp. All rights reserved.
Qualifiers
/ALIAS
/ALIAS save-set-spec (default)
/NOALIAS
NOTE
Use the /ALIAS qualifier only when you are restoring very
old save sets (from OpenVMS Version 6.2 or earlier). The
current default behavior is correct in nearly every other
situation. If you are in doubt about using this qualifier,
contact your VSI support representative.
/ASSIST
/ASSIST (default)
/NOASSIST
Allows operator or user intervention during a BACKUP operation if
a magnetic tape mount request fails or if an operation requires
another volume. The /ASSIST qualifier causes BACKUP to send
messages to operator terminals when a failure occurs during
a BACKUP mount request or when an operation requires another
volume. The default is /ASSIST.
If you specify /NOASSIST, mount messages appear on your terminal
and are not sent to the operator. The /NOASSIST qualifier has no
effect if the logical name SYS$COMMAND points to a device that
is not a terminal (as is the case when you run BACKUP in a batch
job).
/BACKUP
Selects files according to the BACKUP date written in the file
header record by the BACKUP/RECORD command. Use this qualifier
with the /BEFORE or /SINCE qualifier, either of which provides
the system time value BACKUP uses to determine whether to process
a file.
When you use /BACKUP with /BEFORE, files with a BACKUP date prior
to the specified date or time are selected. Files with no BACKUP
date (that is, /RECORD was not specified when the file was saved
or copied) are also selected.
When you use /BACKUP with /SINCE, files with a BACKUP date equal
to or later than the specified date or time are selected. Files
with no BACKUP date (that is, /RECORD was not specified when the
file was saved or copied) are not selected.
Use the /BACKUP file-selection qualifier only with Files-11
Structure Levels 2 and 5 volumes. You cannot use /BACKUP with the
/CREATED, /MODIFIED, or /EXPIRED qualifiers in an image operation
or in a physical operation.
/BEFORE
/BEFORE=time
Selects files dated earlier than the date and time you specify.
Specify the date and time as a delta time or as an absolute time
using the format [dd-mmm-yyyy[:]][hh:mm:ss.cc]. You can also use
one of the following reserved words to specify the date and time:
BACKUP The BACKUP date of the file written by a previous
BACKUP/RECORD operation (available only on Files-11
Structure Levels 2 or 5 volumes)
TODAY The current day, month, and year at 00:00:00.0
o'clock
TOMORROW 24 hours after midnight last night
YESTERDAY 24 hours before midnight last night
The /BEFORE qualifier is not valid in incremental restore
operations.
/BLOCK_SIZE
/BLOCK_SIZE=n
Specifies the output block size, in bytes, for data records in
BACKUP save sets and in disk-to-disk copies. You can specify a
block size between 2048 and 65,535 bytes. BACKUP may adjust this
value according to the constraints of the BACKUP format.
The default block size for magnetic tapes is 8192 bytes. The
default for disks is 32,256 bytes.
For a disk-to-disk operation, the block size specifies the
internal size of the copy buffers. The default block size in
this case is 33,040 bytes.
/BRIEF
Causes the /LIST qualifier to display the file specification,
size (in blocks), and creation date for each file in the save
set. The /BRIEF qualifier is valid only with the /LIST qualifier
and is the default format for BACKUP listings.
/BUFFER_COUNT
/BUFFER_COUNT=n
This qualifier is obsolete. You can still specify the /BUFFER_
COUNT qualifier, although it has no effect. (This ensures that
command procedures containing this qualifier will still operate
correctly.) VSI recommends that you remove the /BUFFER_COUNT
qualifier from command procedures.
/BY_OWNER
/BY_OWNER[=[uic]]
/BY_OWNER[=option]
As an input file-selection qualifier, /BY_OWNER causes BACKUP
to process files owned by the specified UIC. Specify the UIC as
octal numbers or in alphanumeric format (in the form [g,m]). Note
that the UIC specification must include the brackets. UIC formats
are described in the OpenVMS User's Manual. If you specify this
qualifier without a UIC, the default UIC is the current process
UIC. If you do not specify this qualifier, BACKUP processes all
files on the volume.
As an output file qualifier, /BY_OWNER redefines the owner UIC
for each file restored during the operation. As an output save-
set qualifier, /BY_OWNER specifies the owner UIC of the save set.
If you omit the /BY_OWNER qualifier, the save set receives the
UIC of the current process. To use /BY_OWNER as an output save-
set qualifier, you must have the SYSPRV user privilege or the UIC
must be your own.
/COMMENT
/COMMENT=string
Places the string that you supply into the BACKUP summary record
of the output save set. Enclose the string in quotation marks ("a
string") if it contains a space or nonalphanumeric characters. A
DCL command can contain a maximum of 1024 characters.
/COMPARE
Causes BACKUP to compare the contents of the first parameter
with the contents of the second parameter. The first parameter
can be a Files-11 file, a wildcard character representing a
group of files, a BACKUP save set, or a disk device. The second
parameter must be a Files-11 disk file or files, or a Files-11
disk device. Unless you also specify the /PHYSICAL qualifier, the
disk volume must be a Files-11 volume. If a file does not compare
successfully, BACKUP displays an error message.
/CONFIRM
Displays prompts on your terminal for confirmation before
processing each file. If you want the file to be processed, enter
Y or YES and press Return.
/CONVERT
/CONVERT
/NOCONVERT
Converts ODS-5 file names to ODS-2 file names. To preserve the
output volume as ODS-2, you must also use the /NOINIT qualifier.
Be aware that all ODS-5 file attributes are lost if you convert
from an ODS-5 file name to an ODS-2 file name.
You can also use the /NOCONVERT qualifier.
/CRC
/CRC (default)
/NOCRC
As an input save-set qualifier, /CRC causes the software cyclic
redundancy check (CRC) encoded in the save set's data blocks
to be checked (/CRC) or ignored (/NOCRC). If you ignore the CRC
encoding, you reduce processing time at the risk of increasing
data error.
As an output save-set qualifier, /CRC specifies that software
CRC checking code is to be computed and stored in the data blocks
of the output save set. To disable CRC checking, use the /NOCRC
qualifier.
/CREATED
Selects files according to the value of the creation date field
in each file header record.
Use this qualifier with the /BEFORE or /SINCE qualifier, either
of which provides the system time value BACKUP uses to determine
whether to process a file.
/DATA_FORMAT
/DATA_FORMAT=COMPRESS
Use this qualifier for creating compressed save sets.
You can specify the /DATA_FORMAT qualifier anywhere on the
BACKUP command line. The value "=COMPRESS" is required syntax.
A compressed save set may be considerably smaller than
the original data being saved, depending on the content
of the data within the input files. More CPU time is
required to process a compressed save set.
BACKUP uses the ZLIB compression algorithm. The extent
of processing done during compression can be modified
using the /ZLIB_LEVEL qualifier.
When restoring a save set, the /DATA_FORMAT qualifier is
not required. BACKUP will correctly choose to decompress
a compressed save set or simply restore a non-compressed
save set.
/DELETE
Specifies that a BACKUP save or copy operation is to delete the
selected input files from the input volume after all files have
been successfully processed.
Sufficient user privilege is required to delete files. If you use
/DELETE with the /VERIFY qualifier, files that fail verification
are not deleted.
/DENSITY
/DENSITY=n
Specifies the recording density of the output magnetic tape. Use
a value that is supported by the magnetic tape drive.
If you do not specify the /DENSITY qualifier, the default density
is the current density of the magnetic tape drive. You must
specify the output save-set qualifier /REWIND with /DENSITY.
/ENCRYPT
/ENCRYPT=([key] [,ALGORITHM=algorithm])
Creates and restores encrypted save sets. Specify the /ENCRYPT
qualifier anywhere on the BACKUP command line.
NOTE
Standalone BACKUP, which is a version of the BACKUP utility
that runs without the support of the OpenVMS operating
system, does not support the /ENCRYPT qualifier.
Optionally, you can specify either a key name or a key value, but
not both. If you have already defined a key value using the DCL
command ENCRYPT/CREATE_KEY, you can specify
/ENCRYPT=NAME=key-name
to identify the key name that was created and stored in the
key storage table.
To define a key value interactively, specify
/ENCRYPT=VALUE=key-value
where key-value is one of the following:
o 1 to 243 alphanumeric characters enclosed in quotation
marks (""). Dollar signs ($) and underscores (_) are valid
characters. The key is not case sensitive.
o A hexadecimal constant using the digits 0 to 9 and A to F.
NOTE
For additional security, specify the /ENCRYPT qualifier with
no parameters and press Return. The command prompts you for
a key value. When you enter a value, the software does not
echo what you type and, for verification, prompts you to
retype the value.
/EXACT_ORDER
Depending on the other qualifiers you specify on the command
line, the /EXACT_ORDER qualifier allows you to perform the
following actions:
o Specify the exact order of tape volume labels that you want to
use in a BACKUP operation.
o Preserve the existing volume label on a tape.
o Prevent previous volumes of a multivolume save operation from
being overwritten.
/EXCLUDE
/EXCLUDE=(file-spec[,...])
Excludes files that otherwise meet the selection criteria for
a save or copy operation. If you specify more than one file,
separate the file specifications with commas and enclose the list
in parentheses.
Do not use a device specification when defining the files to be
excluded. You can use most standard wildcard characters, but you
cannot use wildcard characters denoting latest versions of files
(;) or relative versions of files (;-n).
If you specify directory files (files with the file type .DIR),
your command is processed but the directory files are not
excluded (they are processed).
You cannot use the /EXCLUDE qualifier in image restore
operations.
/EXPIRED
Selects files according to the value of the expiration date field
in each file header record.
Use this qualifier with the /BEFORE or /SINCE qualifier, either
of which provides the system time value BACKUP uses to determine
whether to process a file.
/FAST
Processes an input Files-11 disk using a fast file scan. The fast
file scan reads the index file on the Files-11 disk specified
by the input specifier and creates a table of files that match
the qualifiers you specified. A fast file scan is most useful
when the input specifier includes most files on the volume and
file-selection qualifiers (such as those that perta