SysWorks©

SysWorks
Command Reference Manual
Previous Contents Index

By default, /QUEUE=SYS$BATCH is assumed with the /BATCH qualifier.

Use of the /QUEUE qualifier is compatable only with the /BATCH qualifier.

/REMOTE=node[,...]

Specifies that the DEVTOOLS DO command be executed on one or more remote nodes. Note that the behaviour of the /INTERACTIVE and /LOG qualifiers changes when this qualifier is used.

The following special keywords may be used in place of the node list:
Keyword Action to be perfomed on each
ALL Depends on the logical SWRK_TELL_ALL_TYPE which should have a value of one of the other special keywords.
CLUSTER Node within the cluster.
CLUSTERS Cluster within the network or security domain.
NODES Node within the network or security domain.

/SUBPROCESS

Specifies that the DEVTOOLS DO command should be executed in the context of a sub-process of the current process.

Use of the /SUBPROCESS qualifier is incompatible with /BATCH, /DETACHED, /INTERACTIVE and /REMOTE.

/SYNCHRONIZE=job-entry

Specifies that a SYNCHRONIZE command is to be used in the DEVTOOLS DO job before the DEVTOOLS DO command is executed, in order to wait until another batch job has finished.

Use of the /SYNCHRONIZE qualifier is compatable only with the /BATCH qualifier.

/TERMINAL

Specifies in conjunction with /REMOTE that the remote command execution should have a terminal window context. The /WINDOW qualifier should also be used.

/USERNAME=vms-username

When specified with the /BATCH qualifier the /USERNAME qualifier is applied when submitting the DEVTOOLS DO command to batch.

Without the /BATCH qualifier the /USERNAME qualifier specifies the user under which the command should be executed. This qualifier (without /BATCH) causes the /MOVE qualifier to be assumed by default.

Note that the use of this qualifier requires the CMKRNL privilege.

/VERIFY

/NOVERIFY (Default)

Specifies whether the command is verified (i.e. displayed in the output stream) before it is executed.

By default, the command is not verified.

/VARIANT=var-ltr

Specifies the application variant under which the command should be executed. This qualifier causes the /MOVE qualifier to be assumed by default.

/VERSION=vsn-cod

Specifies the application version under which the command should be executed. This qualifier causes the /MOVE qualifier to be assumed by default.

/WAIT/NOWAIT

Controls whether the system waits until the command is completed before allowing more commands to be entered. The /NOWAIT qualifier allows you to enter new commands while the original command is running.

Used in conjunction with the /SUBPROCESS qualifier, this qualifier is similar to using the DCL SPAWN/WAIT qualifier.

Used in conjunction with the /BATCH qualifier, this qualifier is similar to using the DCL SYNCHRONIZE command.

This qualifier is ignored when used with the /INTERACTIVE and /DETACHED qualifiers.

/WINDOW

Specifies in conjunction with /REMOTE that the remote command execution should have a display window context.

Examples

#1 

$ HOME
  DISK_USER5:[JONES_AB] 
$ DEVTOOLS DO/APPLICATION=FIN/ENVIRONMENT=DEV SHOW LOGICAL CMS$LIB
  DISK_DEV7:[FIN.WRK.JONES_AB] 
  Executing application FIN in DEV's ENTER.COM 
   "CMS$LIB" = "FIN_SRC_ROOT:[CMSLIB]" (LNM_FIN_DEV) 
  Executing application FIN in DEV's EXIT.COM 
  DISK_USER5:[JONES_AB] 
  Executing user JONES_AB's HOME.COM 
$

Note that the /MOVE qualifier was not explicitly used. It was assumed by default because of the presence of the /APPLICATION and /ENVIRONMENT qualifiers.

DEVTOOLS END SUBCONTEXT

Ends a subcontext block. All files opened as part of the subcontext such as an object library are closed.

Format

DEVTOOLS END SUBCONTEXT

DEVTOOLS EXIT

Exits the DEVTOOLS utility. You can also exit from DEVTOOLS by pressing [Ctrl/Z].

Format

DEVTOOLS EXIT

Parameters

None.

Qualifiers

None.

DEVTOOLS HELP

Enables you to obtain information about the DEVTOOLS utility.

To obtain information about all of the DEVTOOLS commands, enter the following command: 


       DEVTOOLS> HELP

To obtain information about individual commands or topics, enter the HELP command followed by the command or topic name.

Format

DEVTOOLS HELP topic

Parameters

topic

Indicates a topic about which you want information. To display the list of available topics, enter the HELP command at the DEVTOOLS> prompt.

Qualifiers

None.

DEVTOOLS MOVE

Moves a file or a set of files to a target file. This command behaves like a DCL RENAME command if the source and target files are on the same device or like a combination of the DCL COPY and DELETE commands if on different devices. In each case the DEVTOOLS MOVE command also supporters some extra qualifiers.

Format

DEVTOOLS MOVE input-filespec[,...] output-filespec

Parameters

input-filespec[,...]

Specifies the name of one or more existing files to be moved. 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 moved.

output-filespec

Specifies the name of the output file to which the input is moved. The DEVTOOLS MOVE 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 move operations. The DEVTOOLS MOVE command supplies output file version numbers in the following ways:

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 DEVTOOLS move operation. The standard binary file attributes are the equivalent to those set by the command DEVTOOLS 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 move 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 move 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 moved.

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

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

/NORETAIN (Default)

Specifies whether certain file attributes are retained during the DEVTOOLS move 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 DEVTOOLS move 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.

Examples

#1 

$ DEVTOOLS MOVE *ABC*.* *DEF*.*

DEVTOOLS PREPROCESS

Preprocesses a source file or set of source files into a target file.

Format

DEVTOOLS PREPROCESS source-file-spec[,...] target-filespec

Parameters

source-filespec[,...]

Specifies the name of an existing file to be preprocesses. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you do not specify the device or directory, the DEVTOOLS PREPROCESS command uses your current default device and directory. If you specify more than one file, separate the file specifications with a commas (,).

target-filespec

Specifies the name of the target file which results from preprocessing the source file.

If you do not specify the device or directory, the DEVTOOLS PREPROCESS command uses your current default device and directory. The command replaces any other missing fields (file name, file type, version number) with the corresponding field of the source file specification. If you specify more than one source file, the command generally uses the fields from the first source file to determine any missing fields in the target 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.

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

/COMPRESS=(option[,...])

/NOCOMPRESS (Default)

Controls which types of compression are to be performed during the preprocessing.

Valid options include:
Option Meaning
DCL Compress according to DCL rules - see below for more details.
HTML Compress according to HTML rules - see below for more details.

By default, /NOCOMPRESS is assumed.

/CONFIRM

/NOCONFIRM (default)

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

/CONTEXT=(keyword=value,,,)

Specifies the context in which the command should execute.

By default the current context is assumed.

See the UTLTOOLS FETCH SUBCONTEXT command for more details about the keywords and their values.

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

/LIST[=file-spec]

/NOLIST

Controls whether an output listing is created, and optionally provides an output file specification for the listing file.

If you issue the CONVERT command interactively, the converter, by default, does not create a listing file. When /NOLIST is present, either explicitly or by default, errors are reported on the current output device.

If you execute the CONVERT command in a batch job, /LIST is the default. When you specify /LIST, you can control the defaults applied to the output file specification by the placement of the qualifier in the command. See the OpenVMS DCL Concepts Manual for more information on entering output file qualifiers.

The default file type provided for listing files is LIS.

No wildcard characters are allowed in the file specification.

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

/MERGE=(option[,...])

/NOMERGE (Default)

Controls which types of merging are to be performed during the preprocessing.

Valid options include:
Option Meaning
ALL Process all merge files.
APPEND Process %APPEND merge files.
INCLUDE Process %INCLUDE merge files.

By default, /NOMERGE is assumed.

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

/REMOVE (Default)

/NOREMOVE

Controls whether substitutions cause the removal of the substitution command.

By default, /REMOVE 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.

Previous Next Contents Index