SysWorks
Command Reference Manual

Contents

Index

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

/SUBCONTEXT=(keyword=value,,,)

Specifies the various alternative directories which may be checked for files to be preprocessed.

By default the directories are those associated with the application.

Specifies the subcontext in which the command or commands within a subcontext block should execute.

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

By default the directories are those associated with the application.

/SYMBOLS

/NOSYMBOLS (Default)

Controls whether DCL symbol values are used for a variable value when the variable is not set within the source.

By default, /NOSYMBOLS is assumed.

/VARIABLES

/NOVARIABLES

Controls whether variables are substituted or not.

If this qualifier is not specified, the file type of the input file determies the default behaviour. File types which default to /VARIABLES include all HTML file type variants. All other files types default to /NOVARIABLES.

DCL Rules

The compression rules for DCL include:

Convert lowercase to uppercase.
Compress white space to a single space.
Remove trailing comments unless a double exclamation point (!!) is used, in which case the comment is left as is.
Leave lines not starting with a dollar sign ($) alone except where they are a continuation line.
Leave quoted strings alone.
Remove blank command (i.e. only having the dollar sign ($)) and continuation lines (i.e. only having the continuation character (-)).

HTML Rules

The compression rules for HTML include:

Compress white space to a single space.
Remove comments unless a double exclamation point (!!) is used, in which case the comment is left as is.
Leave quoted strings alone.
Remove blank lines.

Merge Rules

The following rules apply for merge operations:

The merge directives %APPEND and %INCLUDE may be included anywhere in a comment in a source file.
These directives must be in uppercase.
Following a merge directive is a file specification. The defaults for this are the context work directory and a file type of .xxx_APP for %APPEND or .xxx_INC for %INCLUDE where xxx is the source file type less any trailing _SRC suffix.
Merge processing preceeds compression processing. This means that combining the two will work and that the comments which directed the merge will be removed.
Merge directives may be nested up to 10 files deep.
Files included by the %INCLUDE directive immediately follow the directive line and the same file may be included multiple times.
Files appended with the %APPEND directive are placed after the entire source file in the output file. Multiple %APPEND directives for the same file result in only one copy of the file being appended. Files are generally appended in the order of their associated <>CODE_EXMAPLE>(%APPEND) directives.

Examples

#1
$ DEVTOOLS PROCEESS/COMPRESS=DCL/LOG FIN_TST_COPY.COM [.TMP] %SWRK-I-FILGEN, DISK_DEV3:[FIN.WRK.SLJ.TMP]FIN_TST_COPY.MMS_INC generated

DEVTOOLS RENAME

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

Format

DEVTOOLS 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 DEVTOOLS 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 DEVTOOLS 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).

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

/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 rename operation.
Valid items include:

Item Usage

RDT Revision date time

/RLF (Default)

/NORLF
Specifies whether related file specification handling is used during the DEVTOOLS rename 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.
/SUBCONTEXT=(keyword=value,,,)
Specifies the various directories and libraries which will be checked for associated files to be deleted and the libraries which will be checked for modules to be deleted when a file is renamed and the /TIDY qualifier (which must also be specified) is used.
For an element with a name and type of the form NAME.TYPE, the associated files and modules which will be deleted will include:

NAME.*;* in the documentation directory;
NAME*.*;* in the library directory;
NAME.*;* in the software directory;
NAME.TYPE;* in the work directory.
NAME in the image library.
NAME in the MMS library.
NAME in the object library.
NAME in the text library.

By default the directories and libraries are those associated with the application.
See the UTLTOOLS FETCH SUBCONTEXT command for more details about the keywords and their values.
/TIDY

/NOTIDY (default)
Specifies that files and library modules associated when a file is renamed should also be deleted.
See the /SUBCONTEXT qualifier for details about how to specify which directories will be searched for associated files.

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

Item	Usage
RDT	Revision date time

Examples

#1
$ DEVTOOLS RENAME ABC.* DEF.*

DEVTOOLS SCAN

Scans a set of sources in order to generate various lists of targets.
This command is primarily used to implement the BUILD SCAN phase.

Format

DEVTOOLS SCAN source-filespec[,...]

Parameters

source-filespec[,...]
Specifies the names of files to be included in the output lists. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you do not specify the device or directory, the DEVTOOLS SCAN command uses your current default device and directory. If you specify more than one file, separate the file specifications with a commas (,).
If the /CMS qualifier is used, this parameter inclcates a list of elements to be scanned.
The most command forms of this parameter are either a directory followed by *.* or *.*/CMS. These are the two forms used by the BUILD SCAN phase.

Qualifiers

/ARCHITECTURE[=ALPHA|VAX]/NOARCHITECTURE (default)
Specifies whether architecture specific sources (i.e those with a file name ending in -ALPHA or -VAX) should be handled specially and which architecture should be used.
If /NOARCHITECTURE is specified or assumed by default, file names are not checked for the architecture suffix.
Conversions behave as for the architecture of the node on which the command is executing.
If /ARCHITECTURE is specified, files which are specific to other architectures (i.e -ALPHA on VAX and -VAX on Alpha) are ignored. Files which are appropriate to the architecture of the node on which the command is executing are copied to the library directory with the architecture specific suffix removed and analysis is performed from there (rather than the work directory).
Conversions behave as for the architecture of the node on which the command is executing.
If /ARCHITECTURE=type is specified, behaviour is as if /ARCHITECTURE was specified on a node of the specified architecture. This is useful, for example, in testing the behaviour for OpenVMS Alpha from a VAX.
/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.
/CMS

/NOCMS (default)
Specifies that the parameter to which this qualifier is applied is a set of generations in the CMS library rather than files in a directory.
By default, files assumed.
/CONFIRM

/NOCONFIRM (default)
Controls whether a request is issued before each scan 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.
/DATABASE[=(product[,...])]

/NODATABASE
Specifies whether to include the generation of scripts to assist with builing a database.
Valid products include:

DEFAULT
MYSQL
ORACLE
PGSQL
RDB

Currently, the default database is RDB.
If /NODATABASE is specified, no database scripts are generated. If /DATABASE is specified, without any products, /DATABASE=DEFAULT is assumed. If neither /DATABASE nor /NODATABASE are specified, database scripts will only ge generated if appropriate sources are detected.
/DOCUMENTATION_FILE_TYPES
Specifies which source file types cause the target within a generated MMS script to be in the documentation directory rather than the software directory.
By default, /DOCUMENTATION_FILE_TYPES=(.DECW$BOOKSHELF_SRC.INX_LIST.RND.RNH.RNM.RNR. SDML) is assumed.
/EXCLUDE=(file-spec[,...])
Excludes the specified files from the scan 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.
/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.
/PATH=class-name
Specifies that the first generation of each element found in the generation expression search list rather than all elements should for the set of objects being considered. This qualifier is used only in conjunction with the /CMS qualifier.
/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

SysWorksCommand Reference Manual

/SUBCONTEXT=(keyword=value,,,)

/SYMBOLS

/NOSYMBOLS (Default)

/VARIABLES

/NOVARIABLES

DCL Rules

HTML Rules

Merge Rules

Examples

DEVTOOLS RENAME

Format

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

Parameters

input-filespec[,...]

output-filespec

Qualifiers

/BACKUP

/BEFORE[=time]

/BY_OWNER[=uic]

/CONFIRM

/NOCONFIRM (default)

/CONTEXT=(keyword=value,,,)

/CREATED

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

/EXPIRED

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

/NOLOG

/MODIFIED

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

/NORETAIN (Default)

/RLF (Default)

/NORLF

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

/SINCE=[time]

/SUBCONTEXT=(keyword=value,,,)

/TIDY

/NOTIDY (default)

Examples

DEVTOOLS SCAN

Format

DEVTOOLS SCAN source-filespec[,...]

Parameters

source-filespec[,...]

Qualifiers

/ARCHITECTURE[=ALPHA|VAX]/NOARCHITECTURE (default)

/BACKUP

/BEFORE[=time]

/BY_OWNER[=uic]

/CMS

/NOCMS (default)

/CONFIRM

/NOCONFIRM (default)

/CONTEXT=(keyword=value,,,)

/CREATED

/DATABASE[=(product[,...])]

/NODATABASE

/DOCUMENTATION_FILE_TYPES

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

/EXPIRED

/MODIFIED

/PATH=class-name

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

/SINCE=[time]

SysWorks
Command Reference Manual