SysWorks©

SysWorks
Command Reference Manual


Previous Contents Index


DEVTOOLS CMS PROMOTE GENERATION

Promotes a CMS library generation from one class to another.

This command is useually used to promote a source from a developers specific scope into an application environment scope or from a variant scope into the mainline.


Format

DEVTOOLS CMS PROMOTE GENERATION element-name "remark"


Parameters

element-name

remark

Specifies a CMS remark. See CMS HELP INSERT GENERATION for more details.

Qualifiers

/PATH[=(generation-expression[,...])]

Specifies that generations of elements found in the first item of the generation expression search list should be promoted into the second expression in the search list. For this to succeed, the second expression must be based around a class, not a numeric generation.

If you omit /PATH and there is no appl_CMS_PATH logical name, or the resultant path has less than two expressions in its search list, an error is generated.

This qualifier overrides the action of the appl_CMS_PATH logical name.


DEVTOOLS CMS RENAME ELEMENT

Renames a CMS library element.

Format

DEVTOOLS CMS RENAME ELEMENT old-element-name new-element-name "remark"


Parameters

old-element-name

new-element-name

remark

Specifies a CMS remark. See CMS HELP COPY ELEMENT for more details.

Qualifiers

/CLASS=class-name

Specifies that the generation of the original element in specified class will be replaced by the same genaration of the new element.

If you omit /CLASS and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS RENAME doesn't replace any generation of the element into any class.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /PATH qualifier.

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

/PATH[=(generation-expression[,...])]

Specifies that the first generation of the original element found in the generation expression search list will be replaced by the same generation of the new element.

If you omit /CLASS and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS RENAME doesn't replace any generation of the element into any class.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /CLASS qualifier.

/SUBCONTEXT=(keyword=value,,,)

Specifies the various directories and libraries which will be checked for intermediate files to be deleted and the libraries which will be checked for modules to be deleted when an element is renamed in the CMS library 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 intermediate files and modules which will be deleted will include:

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 intermediate files and library modules associated when an element is renamed in the CMS library should be deleted.

See the /SUBCONTEXT qualifier for details about how to specify which directories will be searched for intermediate files.


DEVTOOLS CMS REPLACE

Replaces a reserved CMS library generation.

Format

DEVTOOLS CMS REPLACE old-element-name "remark"


Parameters

old-element-name

remark

Specifies a CMS remark. See CMS HELP REPLACE for more details.

Qualifiers

/BINARY

/NOBINARY (Default)

Specifies whether binary file types are forced to have standard binary file attributes during the DEVTOOLS ??? 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.

/CONFIRM

/NOCONFIRM (default)

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

/GENERATION[=generation-expression]

Specifies which reserved generation of the element is to be replaced. If you have more than one reservation of the same element generation, you must use the /IDENTIFICATION_NUMBER qualifier to replace the reservation.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name definedand there is only one reserved generation under your username, DEVTOOLS CMS REPLACE replaces that one generation.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /PATH qualifier.

/IDENTIFICATION_NUMBER=n

Specifies which reservation is to be replaced. This qualifier is required when you have multiple reservations of the same generation of an element. This qualifier is also required when multiple users have reserved the same generation of an element and you have BYPASS privilege or have been granted BYPASS access to the element by an access control list entry. /IDENTIFICATION_NUMBER can be used instead of /GENERATION when you have multiple reservations. Use the DEVTOOLS SHOW RESERVATIONS command to determine the identification number of each reservation. The identification number appears in parentheses at the beginning of each line.

/IF_CHANGED (Default)

/NOIF_CHANGED

Specifies whether a new generation is to be created only if the input file is different from the generation that was reserved. By default, a file must be different for a new generation to be created. This behaviour is the opposite of the standard CMS REPLACE command.

Regardless of whether a new generation is created, DEVTOOLS CMS deletes the input file from the specified location after the new generation is created (unless you specify the /KEEP or /RESERVE qualifier).

/INPUT[=file-specification]

Specifies a file to be used as input for the replacement transaction. If you use the /INPUT qualifier but you do not supply a file specification, DEVTOOLS CMS REPLACE searches your current default directory for a file with the same name as the element specified on the command line. When you specify /INPUT, DEVTOOLS CMS REPLACE deletes the input file from the specified location after the new generation is created (unless you specify the /KEEP or /RESERVE qualifier).

CMS must be able to match the input element list with the list of elements indicated by the element expression parameter. Thus, if you use wildcards in the /INPUT file specification to generate more than one input file, you must also use wildcards in the element expression parameter.

/PATH[=(generation-expression[,...])]

Specifies that the first reserved generation found in the generation expression search list of the element should be replaced. If you have more than one reservation of the same element generation, you must use the /IDENTIFICATION_NUMBER qualifier to replace the reservation.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined and there is only one reserved generation under your username, DEVTOOLS CMS REPLACE replaces that one generation.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /GENERATION qualifier.


DEVTOOLS CMS REPORT

Generates a report about a CMS library.

The report can be used to highlight errors in class memberships which will cause other SysWorks commands to behave incorrectly.


Format

DEVTOOLS CMS REPORT


Qualifiers

/DISPLAY=(display-option[,...])

DISPLAY=ALL

Specifies which elements should be displayed. The display-options are:
ALL List all elements
ERROR List elements with errors
NEW List new elements i.e. those which occurs in any mainline or variant class spacified bit not in the release class
UNUSED List unused elements i.e. those not used in any class

/MAINLINE=(class-name[,...])

Specifies which classes should be checked for mainline generations.

The order of the classes implies the order of the generations i.e. the generation in each class in the list must be logicall greater than or equal to the generation in the previous class in the list.

If a release class is specified and a generation in it is present for an element, the generation if the first mainline class specified must be at least one greater than the generation in the release class.

/OUTPUT[=file-specification]

Directs DEVTOOLS CMS REPORT to write output to the specified file. If you omit the /OUTPUT qualifier (or if you specify /OUTPUT but do not provide a file specification), DEVTOOLS CMS REPORT directs output to the default output device (SYS$OUTPUT).

/RELEASE=release-class-name

Specifies which class should be used as the baseline release class.

/VARIANT=(class-name[,...])

Specifies which classes should be checked for variant generations.

The order of the classes implies the order of the generations i.e. the generation in each class in the list must be logically greater than or equal to the generation in the previous class in the list.

If a release class is specified and a generation in it is present for an element, the generation if the first variant class specified must be an A variant of the generation in the release class.


DEVTOOLS CMS RESERVE

Reserves an element from the CMS library.

Format

DEVTOOLS CMS RESERVE element-name "remark"


Parameters

element-name

remark

Specifies a CMS remark. See CMS HELP RESERVE for more details.

Qualifiers

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

/GENERATION[=generation-expression]

Specifies a particular generation of the element that is to be reserved.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS RESERVE reserves the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /PATH qualifier.

/MERGE=merge-gen-expr

/NOMERGE (Default)

/OUTPUT[=file-specification]

Directs DEVTOOLS CMS RESERVE to write output to the specified file. If you omit the /OUTPUT qualifier (or if you specify /OUTPUT but do not provide a file specification), DEVTOOLS CMS RESERVE creates a file with the same name as the element.

If you reserve more than one element (by specifying wildcards or a group name for the element expression parameter), and you do not specify wildcards in the output file specification, DEVTOOLS CMS RESERVE creates successive versions of the file indicated by /OUTPUT.

/PATH[=(generation-expression[,...])]

Specifies that the first generation found in the generation expression search list of the element should be reserved.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS RESERVE reserves the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /GENERATION qualifier.

/PROMOTION_CHECK (Default)

/NOPROMOTION_CHECK

Specifies whether generations which are not the latest in their tree can be reserved.

If /PROMOTION_CHECK is specified explicitly or by default, attempting to reserve a generation which is not the latest in its tree will cause an error.

/SUBCONTEXT=(keyword=value,,,)

Specifies the various directories and libraries which will be checked for intermediate files to be deleted and the libraries which will be checked for modules to be deleted when a generation is reserved from the CMS library 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 intermediate files and modules which will be deleted will include:

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 intermediate files and library modules associated when a generation is reserved from the CMS library should be deleted.

See the /SUBCONTEXT qualifier for details about how to specify which directories will be searched for intermediate files.


DEVTOOLS CMS SHOW CLASS

Show CMS classes.

This option works the same way as its equivalent CMS command.


Format

DEVTOOLS CMS SHOW CLASS [class-name]


DEVTOOLS CMS SHOW ELEMENT

Show CMS elements.

Format

DEVTOOLS CMS SHOW ELEMENT [element-name]


DEVTOOLS CMS SHOW GENERATION

Show CMS generations.

Format

DEVTOOLS CMS SHOW GENERATION [element-name]


Parameters

element-name


Qualifiers

/ANCESTORS

Displays the transaction records of the specified element generation and all of its ancestors. The transaction records are listed in reverse chronological order. If you do not specify a particular generation, the list begins with the latest generation on the main line of descent.

The ancestors of a main line generation are all the preceding generations back to the first generation of an element. The ancestors of a variant-line generation are all preceding generations on the variant line of descent, and any generations back to the first generation on the main line.

/DESCENDANTS

Displays the transaction records of the specified element generation and of all its descendants. The transaction records are listed in reverse chronological order. If you do not specify a particular generation, the list begins with generation 1.

The descendants of a generation consist of all the successor generations, including those that on variant lines of descent. Thus, you can use this command to determine whether any variant lines of descent exist for a particular element.

/FORMAT="string"

Controls whether the output of the DEVTOOLS CMS SHOW GENERATION command is formatted. You can use the /FORMAT qualifier in combination with the /OUTPUT qualifier to set up a command file. With this command file, you can execute a DEVTOOLS CMS command or a DCL command on a specified set of elements (such as all elements in a class).

The format string can contain printing characters; within the format string, the command recognizes the following substitution sequences:
Sequence Usage
#D, #d File creation date and time
#E, #e Element name
#G, #g Generation number
#M, #m File revision date and time
#T, #t Generation creation date and time

Note that the substitution sequences may be in any case. For each line of output (one line per generation), the command displays the format string and replaces each occurrence of a substitution sequence with the appropriate element name, generation number or date and time value, respectively. To include a number sign in the output line, type it twice (##). When you specify the /FORMAT qualifier, the command does not generate the heading normally produced by the DEVTOOLS CMS SHOW GENERATION command.

To set up a command file, you specify a format string consisting of a command, including the dollar sign ($) prompt and a format parameter (#E or #G) (for example, /FORMAT="$ DEVTOOLS CMS FETCH #E/GENERATION=#G"). Use the /OUTPUT qualifier to direct the output to a command file. When you execute the DEVTOOLS CMS SHOW GENERATION command with these qualifiers, the command creates a command file containing a list of FETCH commands that use each element in the denoted set as parameters.

/GENERATION[=generation-expression]

Specifies the generation about which you want information.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS SHOW GENERATION displays information about the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /PATH qualifier.

/PATH[=(generation-expression[,...])]

Specifies that the first generation found in the generation expression search list of the element is the generation about which you want information.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS SHOW GENERATION displays information about the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /GENERATION qualifier.


DEVTOOLS CMS SHOW GROUP

Show CMS groups.

This option works the same way as its equivalent CMS command.


Format

DEVTOOLS CMS SHOW GROUP [group-name]


DEVTOOLS CMS SHOW HISTORY

Show CMS history.

This option works the same way as its equivalent CMS command.


Format

DEVTOOLS CMS SHOW HISTORY


DEVTOOLS CMS SHOW RESERVATIONS

Show CMS reservations.

Format

DEVTOOLS CMS SHOW RESERVATIONS


DEVTOOLS CMS UNRESERVE

Unreserves a CMS generation.

Format

DEVTOOLS CMS UNRESERVE element-name "remark"


Parameters

element-name

remark

Specifies a CMS remark. See CMS HELP UNRESERVE for more details.

Qualifiers

/GENERATION[=generation-expression]

Specifies a particular generation of the element that is to be unreserved.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS UNRESERVE unreserves the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /PATH qualifier.

/PATH[=(generation-expression[,...])]

Specifies that the first generation found in the generation expression search list of the element should be unreserved.

If you omit /GENERATION and /PATH and there is no appl_CMS_PATH logical name defined, DEVTOOLS CMS UNRESERVE unreserves the most recent generation on the main line of descent.

This qualifier overrides the action of the appl_CMS_PATH logical name.

This qualifier is incompatible with the /GENERATION qualifier.


DEVTOOLS COMPILE

Invokes the COMPILE utility. See COMPILE for details.

DEVTOOLS CONVERT/GENERATE

Converts source files into a target format.

This generic command is primarily used to convert sources into MMS scripts.


Format

DEVTOOLS CONVERT/GENERATE source-filespec[,...] [target-filespec]


Parameters

source-filespec[,...]

Specifies the name of an existing file to be converted. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you do not specify the device or directory, the DEVTOOLS CONVERT/GENERATE 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 is generated from the source file.

If you do not specify the device or directory, the DEVTOOLS CONVERT/GENERATE 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

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

/CHECK_SUBCONTEXT (default)

/NOCHECK_SUBCONTEXT

Specifies whether the context directory subcontext (i.e. the presence of appropriate directory structures) should be checked. The directories which must exist to form a valid directory subcontext are the library, software and work directories.

By default, /CHECK_SUBCONTEXT is assumed.

The /NOCHECK_SUBCONTEXT qualifier is useful if a command based on DEVTOOLS CONVERT/GENERATE (such as the REDUCE convenience command) is used outside an application environment context.

/CONFIRM

/NOCONFIRM (default)

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


Previous Next Contents Index