HELPLIB.HLB  —  CMS  MODIFY

1  –  CLASS

    Changes the characteristics of a specified class or classes.

       Format:

          MODIFY CLASS  class-expression /qualifier "remark"

1.1  –  Restrictions

    o  You cannot modify a class that has read-only access. If a
       class has read-only access, you must change it to NOREAD_
       ONLY access to change the contents of the class or any other
       characteristics.

    o  You must specify one or more of the following qualifiers:
       /NAME, /[NO]READ_ONLY, /REMARK.

1.2  –  Command Parameters

 class-expression

    Specifies the class being modified. A class expression can be a
    class name, a wildcard expression, or a list of these separated by
    commas.

 remark

    Specifies a character string to be logged in the history file with
    this command, usually used to explain why the command was entered.
    The remark is enclosed in quotation marks. If no remark was
    entered, a null remark ("") is logged. Note that this parameter
    and the string on the /REMARK qualifier are unrelated.

1.3  –  Description

    The MODIFY CLASS command changes the characteristics of one or
    more classes. You can alter the following characteristics:

    o  The name of the class.

    o  The access to the class (READ_ONLY or NOREAD_ONLY). You cannot
       change the contents, the name, or the remark of a class that
       has been set to READ_ONLY.

    o  The creation remark that is associated with the class.

    Use the SHOW CLASS command to display class characteristics.

1.4  –  Qualifiers

1.4.1    /CONFIRM

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you specify /CONFIRM and run CMS in interactive mode, CMS
    prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
    CMS executes the transaction.  If you type NO, QUIT, FALSE, 0,
    or press RETURN or CTRL/Z, no action is performed. If you type
    any other character, CMS continues to prompt until you type an
    acceptable response.

    CMS does not prompt for confirmation in batch mode.

1.4.2    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

1.4.3    /NAME=class-name

    Specifies the new name for the class. The new class name cannot
    be the same as an existing class or group name. If a previously
    used class or group name has been removed with the DELETE CLASS or
    DELETE GROUP command, you can reuse that name. Wildcards and comma
    lists are not allowed.

    If you specify the /NAME qualifier, you cannot use wildcards or a
    comma list in the class-name parameter, nor can you use a wildcard
    for the /NAME qualifier. You cannot change the name of a class
    that has read-only access.

1.4.4    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to CLASS
       CLASS (D)
       NOCLASS
       NONE--equivalent to NOCLASS

    You can specify either ALL, NONE, or the [NO]CLASS keyword.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

1.4.5    /READ_ONLY

1.4.6    /NOREAD_ONLY

    Establishes or alters the read-only attribute of a class. To
    change the characteristics of a read-only class, you must set
    the class to NOREAD_ONLY. NOREAD_ONLY is the default attribute of
    a class when it is created with the CREATE CLASS command.

1.4.7    /REMARK="string"

    Specifies a new remark to be substituted for the creation remark
    that is associated with the class. You cannot change the remark of
    a class that has been set to READ_ONLY.

1.5  –  Examples

    (1) CMS> MODIFY CLASS PRE_RELEASE/READ_ONLY "freeze internal version"
        %CMS-S-MODIFIED, class DISKX:[PROJECT.CMSLIB]PRE_RELEASE modified

      This command sets the class named PRE_RELEASE to READ_ONLY.

    (2) CMS> MODIFY CLASS PRE_RELEASE/NOREAD_ONLY/NAME=PRE_RELEASE_V3
        _Remark: include additional functions
        %CMS-S-MODIFIED, class DISKX:[PROJECT.CMSLIB]PRE_RELEASE modified

      This example renames class PRE_RELEASE to PRE_RELEASE_V3.
      Because PRE_RELEASE had been set to READ_ONLY, it is necessary
      to use the /NOREAD_ONLY qualifier to modify the class.

2  –  ELEMENT

    Changes the characteristics of a specified element or elements.

       Format:

          MODIFY ELEMENT element-expression /qualifier "remark"

2.1  –  Restrictions

    o  You cannot modify an element if it is set to read-only access.
    o  You can modify only the reference copy, remark, and review
       attributes of an element that has a generation reserved.
    o  If you specify /NOTES, you must also specify /POSITION on the
       same command line.
    o  You must specify one or more of the following qualifiers:

          /[NO]CONCURRENT
          /[NO]HISTORY
          /NAME
          /[NO]NOTES
          /POSITION
          /[NO]REFERENCE_COPY
          /REMARK
          /[NO]REVIEW

2.2  –  Command Parameters

 element-expression

    Specifies one or more elements to be modified. An element
    expression can be an element name, a group name, a wildcard
    expression, or a list of these separated by commas.

 remark

    Specifies a character string to be logged in the history file with
    this command, usually used to explain why the command was entered.
    The remark is enclosed in quotation marks. If no remark was
    entered, a null remark ("") is logged. Note that this parameter
    and the string on the /REMARK qualifier are unrelated.

2.3  –  Description

    The MODIFY ELEMENT command changes the characteristics of one or
    more elements. You can alter the following characteristics:

    o  The concurrent attribute of the element
    o  The history string that is inserted in the element history when
       the element is reserved or fetched
    o  The element name
    o  The notes string and related position attribute
    o  The reference copy attribute of the element
    o  The creation remark that is associated with the element
    o  The review attribute

    Use the SHOW ELEMENT command to display element characteristics.

    If the history, notes, or position attribute is modified on an
    element that has the reference copy attribute, CMS creates an
    updated reference copy for the element.

2.4  –  Qualifiers

2.4.1    /CONCURRENT

2.4.2    /NOCONCURRENT

    Specifies whether this element can have multiple reservations. If
    you do not specify this qualifier, the existing concurrent access
    is not changed.

2.4.3    /CONFIRM

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you specify /CONFIRM and run CMS in interactive mode, CMS
    prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
    CMS executes the transaction.  If you type NO, QUIT, FALSE, 0,
    or press RETURN or CTRL/Z, no action is performed. If you type
    any other character, CMS continues to prompt until you type an
    acceptable response.

    CMS does not prompt for confirmation in batch mode.

2.4.4    /HISTORY="string"

    Establishes the history attribute for the element. If an element
    has a history attribute, its history (which is similar to that
    produced by the ANNOTATE command) is included in the file when you
    retrieve it with the FETCH or RESERVE command.

    The quoted string specifies the format of the history. The quoted
    string must contain the characters #H or #B (lowercase is allowed)
    and can contain other printing characters. To include a quotation
    mark in the output history string, type it twice (""). To include
    a number sign (#) in the output history string, type it twice
    (##).

2.4.5    /NOHISTORY

    Deletes any existing history attribute. If both /HISTORY and
    /NOHISTORY are omitted, any existing history attribute remains
    unchanged.

2.4.6    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

2.4.7    /NAME=element-name

    Specifies the new name for the element. The new element name
    cannot be the same as an existing element name. Do not use the
    file name 00CMS because this name is reserved for CMS. If you
    specify the /NAME qualifier, you cannot use wildcards or a comma
    list in the element-name parameter, nor can you use a wildcard for
    the /NAME qualifier.

    If an element is set to /REFERENCE_COPY, CMS creates a new
    reference copy of the element in the reference copy directory.

2.4.8    /NOTES="string"

    Establishes the notes attribute for the element. If an element
    has a notes attribute, notes are appended to the lines of the file
    when it is retrieved by the FETCH or RESERVE command.

    The quoted string specifies the format of the note. The quoted
    string can contain text or the characters #G (or #g), or both.

2.4.9    /NONOTES

    Cancels any current notes attribute and the corresponding position
    attribute.

    If both /NOTES and /NONOTES are omitted, any existing notes
    attribute remains unchanged.

2.4.10    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to (ELEMENT, GROUP)
       ELEMENT (D)
       NOELEMENT
       GROUP (D)
       NOGROUP
       NONE--equivalent to (NOELEMENT, NOGROUP)

    You can specify either ALL or NONE, or any combination of the
    [NO]ELEMENT and [NO]GROUP keywords.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

2.4.11    /POSITION=n

    Establishes the position attribute; that is, the character
    position at which the note generated by the /NOTES qualifier is to
    begin on the line. A file that has a position attribute must have
    a notes attribute. Thus, the /POSITION qualifier can be used only
    if the element already has an established notes attribute, or the
    /NOTES qualifier is used on the same MODIFY ELEMENT command.

    The value n is required and must be an integer in the range 1 to
    511. If the length of the line is less than n, the note appears
    at position n. If the length of the line is greater than or equal
    to n, the note is placed at the next tab stop after the end of
    the line. (Tab stops are at position 9 and every 8 characters
    thereafter.)

    If you omit /POSITION, any current position attribute remains
    unchanged.

2.4.12    /REFERENCE_COPY

2.4.13    /NOREFERENCE_COPY

    Controls whether a new reference copy of an element is created or
    deleted.  If you specify /REFERENCE_COPY, CMS creates a new
    reference copy of the element in the reference copy directory and
    updates the current reference copy directory whenever you create a
    new main line generation of the element.  If you specify
    /NOREFERENCE_COPY, CMS deletes the existing reference copy of the
    element.  The reference copy directory must be established before
    you issue the MODIFY ELEMENT/REFERENCE_COPY command. Use the MODIFY
    LIBRARY/REFERENCE_COPY command to establish the reference copy
    directory.

    Controls whether CMS creates a new reference copy of an element
    whenever you create a new main line generation of the element. If
    you specify /NOREFERENCE_COPY, CMS deletes the existing reference
    copy.

    To establish the reference copy directory, use the MODIFY
    LIBRARY/REFERENCE_COPY command.

2.4.14    /REMARK="string"

    Specifies a new remark to be substituted for the creation remark
    that is associated with the element.

2.4.15    /REVIEW

2.4.16    /NOREVIEW

    Controls whether new generations of the element are marked for
    review. If you specify /REVIEW, new generations of the element are
    marked for review. If you specify /NOREVIEW, new generations are
    marked only if the reserved generation is either rejected or has a
    review pending. If you do not specify this qualifier, the existing
    review attribute is not changed.

    To determine whether an element has the review attribute enabled,
    use the SHOW ELEMENT/FULL command.

2.5  –  Examples

    (1) CMS> MODIFY ELEMENT INIT.FOR/NOCONCURRENT
        _Remark: no more changes, other than those already discussed
        %CMS-S-MODIFIED, element DISKX:[PROJECT.CMSLIB]INIT.FOR modified

      This example sets the element INIT.FOR to NOCONCURRENT access.
      This means that only one person can reserve the element at a
      time.

    (2) CMS> MODIFY ELEMENT/REVIEW EXAMPLE.SDML
        _Remark: team should review all changes before performing build
        %CMS-S-MODIFIED, element DISKX:[PROJECT.CMSLIB]EXAMPLE.SDML modified

      This example marks the latest generation of the element
      EXAMPLE.SDML for review, and adds it to the review pending
      list. To display what generations are pending review, use the
      SHOW REVIEWS_PENDING command.

3  –  GENERATION

    Changes the characteristics of a specified generation or
    generations.

       Format:

          MODIFY GENERATION  element-expression /qualifier "remark"

3.1  –  Restrictions

    o  You must specify one of the following qualifiers: /GENERATION
       or /REMARK.

3.2  –  Command Parameters

 element-expression

    Specifies one or more elements whose generations are to be
    modified. An element expression can be an element name, a group
    name, a wildcard expression, or a list of these separated by
    commas.

 remark

    Specifies a character string to be logged in the history file with
    this command, usually used to explain why the command was entered.
    The remark is enclosed in quotation marks. If no remark was
    entered, a null remark ("") is logged. Note that this parameter
    and the string on the /REMARK qualifier are unrelated.

3.3  –  Description

    The MODIFY GENERATION command changes the remark that is
    associated with a particular generation of one or more
    elements. Use the SHOW GENERATION command to display generation
    characteristics.

    This command does not change a generation's review status. See
    the ACCEPT GENERATION, CANCEL GENERATION, MARK GENERATION, REJECT
    GENERATION, and REVIEW GENERATION commands for more information.

3.4  –  Qualifiers

3.4.1    /CONFIRM

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you specify /CONFIRM and run CMS in interactive mode, CMS
    prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
    CMS executes the transaction.  If you type NO, QUIT, FALSE, 0,
    or press RETURN or CTRL/Z, no action is performed. If you type
    any other character, CMS continues to prompt until you type an
    acceptable response.

    CMS does not prompt for confirmation in batch mode.

3.4.2    /GENERATION[=generation-expression]

    Specifies which generation of the element is to be modified. If
    you omit /GENERATION, CMS modifies the most recent generation on
    the main line of descent.

3.4.3    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

3.4.4    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to (ELEMENT, GROUP, CLASS)
       ELEMENT (D)
       NOELEMENT
       GROUP (D)
       NOGROUP
       CLASS (D)
       NOCLASS
       NONE--equivalent to (NOELEMENT, NOGROUP, NOCLASS)

    You can specify either ALL or NONE, or any combination of the
    [NO]ELEMENT, [NO]GROUP, and [NO]CLASS keywords.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

3.4.5    /REMARK="string"

    Specifies a new remark to be substituted for the creation
    (replacement) remark that is associated with the generation. This
    qualifier is required.

3.5  –  Example

    CMS> MODIFY GENERATION/GENERATION=5/REMARK="Obsolete"
    _Element expression: SPEC.TXT
    _Remark: Marked obsolete
    %CMS-S-MODIFIED, generation 5 modified

      This command specifies a new remark to be substituted for the
      creation remark of generation 5 of element SPEC.TXT. You must
      also specify the element expression, and its associated remark,
      which is logged in the history file.

4  –  GROUP

    Changes the characteristics of the specified group or groups.

       Format:

          MODIFY GROUP  group-expression /qualifier "remark"

4.1  –  Restrictions

    o  You cannot change the attributes of a group that has been set
       to READ_ONLY. If a group has read-only access, you must change
       it to NOREAD_ONLY to change any other characteristics.

    o  You must specify one or more of the following qualifiers:
       /NAME, /[NO]READ_ONLY, or /REMARK.

4.2  –  Command Parameters

 group-expression

    Specifies the group to be modified. A group expression can be a
    group name, a wildcard expression, or a list of these separated by
    commas.

 remark

    Specifies a character string to be logged in the history file with
    this command, usually used to explain why the command was entered.
    The remark is enclosed in quotation marks. If no remark was
    entered, a null remark ("") is logged. Note that this parameter
    and the string on the /REMARK qualifier are unrelated.

4.3  –  Description

    The MODIFY GROUP command changes the characteristics of one or
    more groups. You can alter the following characteristics:

    o  The name of the group.
    o  The access to the group (READ_ONLY or NOREAD_ONLY). You cannot
       change the contents of a group that has been set READ_ONLY.
    o  The creation remark that is associated with the group.

    Use the SHOW GROUP command to display group characteristics.

4.4  –  Qualifiers

4.4.1    /CONFIRM

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you specify /CONFIRM and run CMS in interactive mode, CMS
    prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
    CMS executes the transaction.  If you type NO, QUIT, FALSE, 0,
    or press RETURN or CTRL/Z, no action is performed. If you type
    any other character, CMS continues to prompt until you type an
    acceptable response.

    CMS does not prompt for confirmation in batch mode.

4.4.2    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

4.4.3    /NAME=group-name

    Specifies the new name for the group. You cannot change the
    name of a group that has been set to READ_ONLY. The new group
    name cannot be the same as an existing group or class name.
    Wildcards and comma lists are not allowed. If you specify the
    /NAME qualifier, you cannot use wildcards or a comma list in the
    group name parameter, nor can you use a wildcard for the /NAME
    qualifier.

4.4.4    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to GROUP
       GROUP (D)
       NOGROUP
       NONE--equivalent to NOGROUP

    You can specify either ALL, NONE, or the [NO]GROUP keyword.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

4.4.5    /READ_ONLY

4.4.6    /NOREAD_ONLY

    Establishes or alters the read-only attribute of a group. To
    change the characteristics of a READ_ONLY group, you must set
    the class to NOREAD_ONLY. NOREAD_ONLY is the default attribute of
    a group when it is created with the CREATE GROUP command.

4.4.7    /REMARK="string"

    Specifies a new remark to be substituted for the creation remark
    that is associated with the group.

4.5  –  Example

    CMS> MODIFY GROUP TESTS/READ_ONLY "coordinate before changing
    contents"
    %CMS-S-MODIFIED, group DISKX:[PROJECT.CMSLIB]TESTS modified

      This command sets the group TESTS to READ_ONLY. Once the group
      is set to READ_ONLY, the contents cannot be changed.

5  –  LIBRARY

    Establishes or removes the connection between the current CMS
    library and a reference copy directory.

       Format:

          MODIFY LIBRARY  /qualifier "remark"

5.1  –  Command Parameters

 remark

    Specifies a character string to be logged in the history file
    with this command, usually used to explain why the command was
    entered. The remark is enclosed in quotation marks. If no remark
    was entered, a null remark ("") is logged.

5.2  –  Description

    The MODIFY LIBRARY command establishes or removes the connection
    between the current CMS library and a reference copy directory.
    The reference copy directory cannot be a CMS library. This command
    does not add files to or delete any files from a reference
    copy directory. Once you establish a reference copy directory
    for a library, subsequent transactions that create new element
    generations on the main line of descent also update the reference
    copy directory (provided the element is set to /REFERENCE_COPY).

    You must use the MODIFY ELEMENT/NOREFERENCE_COPY command on
    the elements in the library before you can use the MODIFY
    LIBRARY/NOREFERENCE_COPY command.

    If you specify MODIFY LIBRARY/REFERENCE_COPY and the reference
    copy directory is already set, CMS first verifies all the files
    found in that directory. The contents of the directory must
    exactly correspond with the elements that have /REFERENCE_COPY
    set in the CMS library. If elements are set with /NOREFERENCE_
    COPY and there are existing reference copies for those elements,
    CMS advises you to use VERIFY/REPAIR. No further operations are
    allowed until the reference copies have been repaired.

    Use the SHOW LIBRARY command to display library characteristics.

5.3  –  Qualifiers

5.3.1    /CONCURRENT (D)

    Specifies whether elements in a library can have multiple
    reservations by setting the concurrent attribute on the library.
    Use /NOCONCURRENT to disallow multiple reservations. If this
    qualifier is not specified the status of this attribute remains
    unchanged.

5.3.2    /EXTENDED_FILENAMES

    Change the attribute of a CMS library to allow the use of extended
    file names. This qualifier is only available on OpenVMS V7.2 and
    later. Use /NOEXTENDED_FILENAMES to change the attribute to disallow
    the use of extended file names. If this qualifier is not specified
    the status of this attribute remains unchanged.

5.3.3    /KEEP

    Instructs CMS to not delete all versions of a file used to create
    a new element or generation. If this qualifier is not specified
    the status of this attribute remains unchanged.

5.3.4    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

5.3.5    /LONG_VARIANT_NAMES

    Change the attribute of a CMS library to allow the use of long
    variant names. Use /NOLONG_VARIANT_NAMES to change the attribute
    to disallow the use of long variant names. If this qualifier is
    not specified the status of this attribute remains unchanged.

5.3.6    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to OTHER
       OTHER (D)
       NOOTHER
       NONE--equivalent to NOOTHER

    You can specify either ALL, NONE, or the [NO]OTHER keyword.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

5.3.7    /REFERENCE_COPY=directory-specification

    Specifies a valid OpenVMS directory to be used for reference copies
    of library elements. The directory cannot be a CMS library, nor
    can it be a subdirectory of a CMS library directory. If you use
    the MODIFY LIBRARY command on a search list consisting of more
    than one library, you should specify a reference copy directory
    for each library in the search list. If you specify only one
    reference copy directory for more than one library, CMS uses one
    reference copy directory for the entire search list, not one
    reference copy directory for each library in the search list.

    Use the /NOREFERENCE_COPY qualifier to remove the connection
    between the current CMS library and the current reference copy
    directory. Wildcards are not allowed.

5.3.8    /REVISION_TIME[=option]

    Controls whether CMS uses the original file revision time or the
    file storage time when a file is retrieved from the CMS library.
    The options field can contain of the following keywords:

       ORIGINAL (D)
       STORAGE_TIME

    Use the keyword ORIGINAL to indicate that the original revision
    time of files placed in a CMS library should be restored unchanged
    upon their retrieval.  This is the default behavior.

    Use the keyword STORAGE_TIME to indicate that the time when a file
    was stored in a CMS library (through a CREATE ELEMENT or REPLACE
    transaction) should be substituted for its original revision time
    upon retrieval.

5.4  –  Example

    CMS> MODIFY LIBRARY/REFERENCE_COPY=[WORK.REFCOPY] "current
    test area"
    %CMS-S-MODIFIED, library [WORK.CODELIB] modified

      This command establishes the reference copy directory
      [WORK.REFCOPY] for the current CMS library. In addition, to
      update the reference copy directory, an element must be set to
      /REFERENCE_COPY. Thus, if these two conditions are met, each
      transaction that creates a new main line element generation
      also updates the reference copy directory.

6  –  RESERVATION

    Changes the characteristics of a specified reservation.

       Format:

          MODIFY RESERVATION  element-expression /qualifier "remark"

6.1  –  Restrictions

    o  You must specify the following qualifier: /REMARK.

6.2  –  Command Parameters

 element-expression

    Specifies one or more elements whose reservation reservations are
    to be modified. An element expression can be an element name, a
    group name, a wildcard expression, or a list of these separated by
    commas.

 remark

    Specifies a character string to be logged in the history file with
    this command, usually used to explain why the command was entered.
    The remark is enclosed in quotation marks. If no remark was
    entered, a null remark ("") is logged. Note that this parameter
    and the string on the /REMARK qualifier are unrelated.

6.3  –  Description

    The MODIFY RESERVATION command changes the remark that is
    associated with a particular reservation of one or more
    elements. Use the SHOW RESERVATIIONS command to display
    reservation characteristics.

6.4  –  Qualifiers

6.4.1    /CONFIRM

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you specify /CONFIRM and run CMS in interactive mode, CMS
    prompts you for confirmation. If you type YES, ALL, TRUE, or 1,
    CMS executes the transaction.  If you type NO, QUIT, FALSE, 0,
    or press RETURN or CTRL/Z, no action is performed. If you type
    any other character, CMS continues to prompt until you type an
    acceptable response.

    CMS does not prompt for confirmation in batch mode.

6.4.2    /GENERATION[=generation-expression]

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

6.4.3    /IDENTIFICATION_NUMBER=n

    Specifies which reservation is to be modified. This qualifier
    is required when you have multiple reservations of the same
    generation of an element. /IDENTIFICATION_NUMBER can be used
    instead of /GENERATION when you have multiple reservations. Use
    the SHOW RESERVATIONS command to determine the identification
    number of each reservation. The identification number appears
    before the user name.

6.4.4    /LOG (D)

    Controls whether CMS displays success and informational messages
    on the default output device. By default, if the command executes
    successfully, CMS displays a success message. If you specify
    /NOLOG, success and informational messages are suppressed. Any
    warning, error, or fatal error messages are displayed regardless
    of whether /LOG or /NOLOG is specified.

6.4.5    /OCCLUDE[=option,...]

    Controls whether CMS selects the first instance of the specified
    object, or all instances of the specified object in the library
    search list. The options field contains one or more keywords
    associated with the name of the object. The options field can
    contain the following keywords:

       ALL--equivalent to (ELEMENT, GROUP, CLASS)
       ELEMENT (D)
       NOELEMENT
       GROUP (D)
       NOGROUP
       CLASS (D)
       NOCLASS
       NONE--equivalent to (NOELEMENT, NOGROUP, NOCLASS)

    You can specify either ALL or NONE, or any combination of the
    [NO]ELEMENT, [NO]GROUP, and [NO]CLASS keywords.

    By default, CMS performs occlusion for all objects; that is, CMS
    selects only the first occurrence of a specified object.

6.4.6    /REMARK="string"

    Specifies a new remark to be substituted for the remark that is
    associated with the reservation. This qualifier is required.

6.5  –  Example

    CMS> MODIFY RESERVATION/GENERATION=5/REMARK="Add new feature"
    _Element expression: SPEC.TXT
    _Remark: Modify the reservation remark
    %CMS-S-MODIFIED, reservation SPEC.TXT modified

      This command specifies a new remark to be substituted for the
      reservation remark that was specified when generation 5 of
      element SPEC.TXT was reserved. You must also specify the element
      expression, and its associated remark, which is logged in the
      history file.
Close Help