SysWorks©

SysWorks
Command Reference Manual


Previous Contents Index

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.


Examples

#1

$ UTLTOOLS ADD/PAGE_NUMBER FIN_RUN_DIR:FIN_MY_REPORT.LIS 200
      

Transfers control from your current process (which then hibernates) to the specified process.

The UTLTOOLS ATTACH and UTLTOOLS SPAWN commands cannot be used if your terminal has an associated mailbox.

Note that this command is only available for users with DCL access.


Format

UTLTOOLS ATTACH [process-name]


Parameters

process-name

Specifies the name of a parent process or spawned subprocess to which control passes. The process must already exist, be part of your current job, and share the same input stream as your current process. However, the process cannot be your current process or a subprocess created with the /NOWAIT qualifier.

Process names can contain from 1 to 15 alphanumeric characters. If a connection to the specified process cannot be made, an error message is displayed.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.


Qualifiers

/IDENTIFICATION=pid

Specifies the process identification (PID) of the process to which terminal control will be transferred. Leading zeros can be omitted.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.

/PARENT

Indicates that you want to attach to the parent process of your current process. If you did not access the UTLTOOLS utility by using the SPAWN command, an error message is displayed.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.


Examples

#1

$ UTLTOOLS ATTACH JONES_2
      

The ATTACH command transfers the terminal's control to the subprocess JONES_2.

#2

UTLTOOLS> ATTACH/IDENTIFICATION=30019
      

The ATTACH command switches control from the current process to a process having the PID 30019. Notice that because the /IDENTIFICATION qualifier is specified, the process-name parameter is omitted.


UTLTOOLS CHECKSUM

Generates the checksum one or more files. This command is similar to the DCL CHECKSUM command with the addition of some extra qualifiers.

Format

UTLTOOLS CHECKSUM filespec[,...]


Parameters

filespec[,...]

Specifies the names of one or more files for which checksums are to be generated. The first file specification must contain an explicit or default directory specification plus an explicit file name, file type, and version number. Subsequent file specifications need contain only a version number; the defaults will come from the preceding specification. The asterisk (*) and the percent sign (%) wildcard characters can be used in any of the file specification fields.

If you omit the directory specification or device name, the current default device and directory are assumed.

If the file specification contains a null version number (a semicolon (;) followed by no file version number), a version number of 0, or one or more spaces in the version number, the checksum for the latest version of the file is generated.

To generate the cheksum of more than one file, separate the file specifications with either commas (,) or plus signs (+).


Qualifiers

/BACKUP

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /BACKUP selects files according to the dates of their most recent backups. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /CREATED, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/BEFORE[=time]

Selects only those files dated prior to 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: TODAY (default), TOMORROW, or YESTERDAY. Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED (default), /EXPIRED or /MODIFIED.

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.

/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 using standard UIC format as described in the OpenVMS DCL Concepts Manual.

/CONFIRM

/NOCONFIRM (default)

Controls whether a request is issued before each checksum 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

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /CREATED selects files based on their dates of creation. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/EXCLUDE=(file-spec[,...])

Excludes the specified files from the checksum operation. You can include a directory but not a device in the file specification. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /EXPIRED selects files according to their expiration dates. (The expiration date is set with the SET SECURITY/EXPIRED command.) The /EXPIRED qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/LOG[=(option[,...]) (default)

/NOLOG

Outputs messages to the output file depending upon the option(s) specified.

The following log options are available:
Option Meaning
[NO]ALL Log all information. This is the default action.
[NO]ERROR Log errors.
[NO]NONE Don't log any information. This is the equivalent to /NOLOG.
[NO]NOTFOUND Log files that were not found.
[NO]SUCCESS Log files that were checksumed.

/MODIFIED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /MODIFIED selects files according to the dates on which they were last modified. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /EXPIRED. If you specify none of these four time modifiers, the default is /CREATED.

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

Allows you to select files based on a number of criteria. Choose one of the following keywords:
ACL
NOACL
Selects files that have an associated ACL or files that do not (NOACL keyword).
ATTRIBUTES=(option[,...]) Selects files which have particular attributes. The following options are supported:
Option Description
[NO]BACKUP Selects files which have backups enabled (BACKUP) or disabled (NOBACKUP)
LRL=MAXIMUM=size Selects files which have a longest record size less than or equal to the specified value.
LRL=MINIMUM=size Selects files which have a longest record size greater than or equal to the specified value.
ORG=type Selects files which have the specified organization. Valid organizations include:
  • DIRECT
  • INDEXED
  • RELATIVE
  • SEQUENTIAL
RFM=type Selects files which have the specified record format. Valid record formats include:
  • STREAM
  • STREAMCR
  • STREAMLF
  • UNDEFINED
  • VARIABLE
  • VFC
FILE=(option[,...]) Selects portions of the file specification for display purposes. 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
Selects files that are online or shelved.
PRESHELVED
NOPRESHELVED
Selects files that are preshelved or not preshelved.
SHELVABLE
NOSHELVABLE
Selects files that are shelvable or not shelvable.
SIZE=(option[,...]) Selects files according to their size. Possible options are:
Option Description
MAXIMUM=n Selects 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 selected.
MINIMUM=n Selects 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 selected.
(MINIMUM=n, MAXIMUM=n) Selects files whose block size falls within the specified MINIMUM and MAXIMUM range.

/SINCE=[time]

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

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.


Examples

#1

$ UTLTOOLS CHECKSUM FIN_LIB_DIR:*.MMS_INC
      


UTLTOOLS COPY

Copies a file or a set of files to a target file. This command is similar to the DCL COPY command with the addition of some extra qualifiers.

Format

UTLTOOLS COPY input-filespec[,...] output-filespec


Parameters

input-filespec[,...]

Specifies the name of an existing file to be copied. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you do not specify the device or directory, the UTLTOOLS COPY command uses your current default device and directory.

output-filespec

Specifies the name of the output file into which the input is copied.

You must specify at least one field in the output file specification. If you do not specify the device or directory, the UTLTOOLS COPY command uses your current default device and directory. The UTLTOOLS COPY command replaces any other missing fields (file name, file type, version number) with the corresponding field of the input file specification. If you specify more than one input file, the UTLTOOLS COPY command generally uses the fields from the first input file to determine any missing fields in the output file.

You can use the asterisk (*) wildcard character in place of any two of the following: the file name, the file type, or the version number. The UTLTOOLS COPY command uses the corresponding field in the related input file to name the output file.


Qualifiers

/BACKUP

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /BACKUP selects files according to the dates of their most recent backups. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /CREATED, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/BEFORE[=time]

Selects only those files dated prior to 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: TODAY (default), TOMORROW, or YESTERDAY. Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED (default), /EXPIRED or /MODIFIED.

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.

/BINARY

/NOBINARY (Default)

Specifies whether binary file types are forced to have standard binary file attributes during the UTLTOOLS copy operation. The standard binary file attributes are the equivalent to those set by the command UTLTOOLS SET FILE/ATTRIBUTES=(RFM=FIX,LRL=512,RAT=NONE).

By default, file attributes are not forced to the standard binary file attributes.

/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 using standard UIC format as described in the OpenVMS DCL Concepts Manual.

/CONFIRM

/NOCONFIRM (default)

Controls whether a request is issued before each copy 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

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /CREATED selects files based on their dates of creation. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/EXCLUDE=(file-spec[,...])

Excludes the specified files from the copy operation. You can include a directory but not a device in the file specification. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /EXPIRED selects files according to their expiration dates. (The expiration date is set with the SET SECURITY/EXPIRED command.) The /EXPIRED qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/LOG[=(option[,...]) (default)

/NOLOG

Outputs messages to the output file depending upon the option(s) specified.

The following log options are available:
Option Meaning
[NO]ALL Log all information. This is the default action.
[NO]ERROR Log errors.
[NO]NONE Don't log any information. This is the equivalent to /NOLOG.
[NO]NOTFOUND Log files that were not found.
[NO]SUCCESS Log files that were copied.

/MODIFIED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /MODIFIED selects files according to the dates on which they were last modified. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /EXPIRED. If you specify none of these four time modifiers, the default is /CREATED.

/RECORD

/NORECORD (Default)

Specifies whether file contents should be explicily copied in record mode.

When a file is copied to or from a record oiriented device, the contents are always copied in record mode. When copied from and to a block oriented device, such as a disk, the default behaviour is to copy in block mode. This qualifier can be used to force the contents to be copied in record mode.

For operating systems or file systems which don't have specific support for record mode, the qualifier has no effect.

By default, /NORECORD is assumed.

/RETAIN=(item[,...])

/NORETAIN (Default)

Specifies whether certain file attributes are retained during the UTLTOOLS copy operation.

Valid items include:
Item Usage
CDT Creation date and time
RDT Revision date time

/RLF (Default)

/NORLF

Specifies whether related file specification handling is used during the UTLTOOLS copy operation.

By default, /RLF is assumed.

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

Allows you to select files based on a number of criteria. Choose one of the following keywords:
ACL
NOACL
Selects files that have an associated ACL or files that do not (NOACL keyword).
ATTRIBUTES=(option[,...]) Selects files which have particular attributes. The following options are supported:
Option Description
[NO]BACKUP Selects files which have backups enabled (BACKUP) or disabled (NOBACKUP)
LRL=MAXIMUM=size Selects files which have a longest record size less than or equal to the specified value.
LRL=MINIMUM=size Selects files which have a longest record size greater than or equal to the specified value.
ORG=type Selects files which have the specified organization. Valid organizations include:
  • DIRECT
  • INDEXED
  • RELATIVE
  • SEQUENTIAL
RFM=type Selects files which have the specified record format. Valid record formats include:
  • STREAM
  • STREAMCR
  • STREAMLF
  • UNDEFINED
  • VARIABLE
  • VFC
FILE=(option[,...]) Selects portions of the file specification for display purposes. 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
Selects files that are online or shelved.
PRESHELVED
NOPRESHELVED
Selects files that are preshelved or not preshelved.
SHELVABLE
NOSHELVABLE
Selects files that are shelvable or not shelvable.
SIZE=(option[,...]) Selects files according to their size. Possible options are:
Option Description
MAXIMUM=n Selects 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 selected.
MINIMUM=n Selects 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 selected.
(MINIMUM=n, MAXIMUM=n) Selects files whose block size falls within the specified MINIMUM and MAXIMUM range.

/SINCE=[time]

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

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.

/SEQUENTIAL

/NOSEQUENTIAL (Default)

Specifies whether file contents should be explicily converted to sequential format.

When a file is copied to or from a record oiriented device, the contents are always converted to sequential format, if necessary. When copied from and to a block oriented device, such as a disk, the default behaviour is to copy in block mode, which preserves any internal file organization. This qualifier can be used to force the contents to be converted to sequential format.

For some files, the format of the file is derived from the file type. For example, the file MYDATA.LOG-GZ is assumed to be a GZIPped log file. By default, the result of a copy will still be a GZIPped log file. Using the /SEQUENTIAL qualifier will effectively GUNZIP the file, converting it into a log file.

By default, /NOSEQUENTIAL is assumed.


Examples

#1

$ UTLTOOLS COPY *ABC*.* *DEF*.*
      


Previous Next Contents Index