/sys$common/syshlp/HELPLIB.HLB  —  CMS  DELETE

1  –  CLASS

    Deletes one or more classes from a CMS library.

       Format:

           DELETE CLASS  class-expression "remark"

1.1  –  Restrictions

    o  You cannot delete a class that contains any element
       generations unless you specify the /REMOVE_CONTENTS
       qualifier.

    o  You cannot delete a class that has read-only access. (Use the
       MODIFY CLASS/NOREAD_ONLY command to change the access to the
       class.)

1.2  –  Command Parameters

 class-expression

    Specifies the class or classes to be deleted from the CMS library.
    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.

1.3  –  Description

    The DELETE CLASS command deletes one or more classes from a CMS
    library. The class must exist and must not contain any element
    generations unless the /REMOVE_CONTENTS qualifier is specified.
    If the /REMOVE_CONTENTS qualifier is not specified and any
    generations belong to the class, CMS issues an error message and
    does not delete the class. If the /REMOVE_CONTENTS qualifier is
    not specified, use the REMOVE GENERATION command to remove element
    generations from a class before issuing the DELETE CLASS command.

    Even though a class is deleted, records of transactions that
    created and used the class are retained in the library history.
    You can reuse the deleted class name to create a new class.
    However, there is no distinction between the two classes in the
    project history, except that their transactions are separated by
    entries for DELETE CLASS and CREATE CLASS commands.

    To determine which generations belong to a class, use the SHOW
    CLASS command with the /CONTENTS qualifier.

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

    Controls whether CMS removes generations of elements from the
    specified class prior to deleting the class. When /REMOVE_CONTENTS
    is specified CMS displays an informational message for each element
    generation that is removed from the class.

1.5  –  Examples

    (1) CMS> DELETE CLASS PRE_RELEASE "no longer necessary"
        %CMS-S-DELETED, class DISKX:[PROJECT.CMSLIB]PRE_RELEASE deleted

      This command deletes the class named PRE_RELEASE.

    (2) CMS> REMOVE GENERATION *.* BETA*
        _Remark: beta sites converted to released product
        %CMS-I-GENREMOVED, generation 3 of element
        DISKX:[PROJECT.CMSLIB]INI.FOR removed from class
        DISKX:[PROJECT.CMSLIB]BETAFEB
        %CMS-I-GENREMOVED, generation 4 of element
        DISKX:[PROJECT.CMSLIB]SRC.FOR removed from class
        DISKX:[PROJECT.CMSLIB]BETAFEB
        %CMS-I-GENREMOVED, generation 3 of element
        DISKX:[PROJECT.CMSLIB]INI.FOR removed from class
        DISKX:[PROJECT.CMSLIB]BETAJAN
        %CMS-I-GENREMOVED, generation 2 of element
        DISKX:[PROJECT.CMSLIB]SRC.FOR removed from class
        DISKX:[PROJECT.CMSLIB]BETAJAN
        %CMS-S-REMOVALS, 4 removals completed

        CMS> DELETE CLASS BETA* "beta sites converted to released product"
        %CMS-I-DELETED, class DISKX:[PROJECT.CMSLIB]BETAFEB deleted
        %CMS-I-DELETED, class DISKX:[PROJECT.CMSLIB]BETAJAN deleted
        %CMS-S-DELETIONS, 2 classes deleted

      This example removes all element generations from all classes
      whose names begin with the string BETA, then deletes all of
      the empty classes. CMS does not prompt for confirmation during
      deletion unless you specify the /CONFIRM qualifier.

2  –  ELEMENT

    Deletes one or more elements from a CMS library.

       Format:

          DELETE ELEMENT  element-expression "remark"

2.1  –  Restrictions

    o  You cannot delete an element that belongs to a group or has a
       generation in a class.

    o  You cannot delete an element that has a generation reserved.

    o  You cannot restore a deleted element.

    o  You cannot delete an element that has a generation under
       review.

2.2  –  Command Parameters

 element-expression

    Specifies one or more elements that are to be deleted from the
    library. An element expression can be an element 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.

2.3  –  Description

    The DELETE ELEMENT command deletes an element from a CMS library.
    If the element is set to /REFERENCE_COPY and there is a current
    reference copy directory for the CMS library, CMS deletes the
    corresponding file from the reference copy directory.

    There cannot be any existing reservations for the element.
    The element cannot be a member of a group, nor can one of its
    generations belong to a class, or be under review. If one of
    the element's generations is under review, use the CANCEL
    REVIEW command to remove it from the review list. If an element
    is reserved, you must unreserve or replace it before you can
    delete the element. If the element belongs to any groups or
    has generations in any classes, use the REMOVE ELEMENT or REMOVE
    GENERATION command to remove it.

    Even though an element is deleted, records of transactions that
    created and used the element are retained in the library history.
    You can reuse the deleted element name to create a new element.
    However, there is no distinction between the two elements in the
    library history, except that their transactions are separated by
    entries for DELETE ELEMENT and CREATE ELEMENT commands.

2.4  –  Qualifiers

2.4.1    /CONFIRM (D)

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you 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 or QUIT or press RETURN, 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.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.

2.4.3    /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
       ELEMENT (D)
       NOELEMENT
       NONE--equivalent to NOELEMENT

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

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

2.5  –  Example

    CMS> DELETE ELEMENT INITX.FOR "x-version no longer required"
    Delete element INITX.FOR? [Y/N] (N): Y
    %CMS-I-DELETED, element DISKX:[PROJECT.CMSLIB]INITX.FOR deleted
    %CMS-S-DELETIONS, 1 deletion completed

      This example uses INITX.FOR as an experimental module; when it
      is no longer needed, it can be deleted from the library.

3  –  GENERATION

    Deletes one or more generations of an element.

       Format:

          DELETE GENERATION  element-expression "remark"

3.1  –  Restrictions

    o  You cannot delete generation 1 of an element.
    o  You cannot delete a generation that has variants off it.
    o  You cannot delete a generation that has a review pending.
    o  You cannot delete a generation that is reserved.
    o  You cannot delete a generation that is in a class.
    o  All generations in the specified range of generations to be
       deleted must be on the same line of descent.
    o  You cannot use /GENERATION in combination with /AFTER, /BEFORE,
       /FROM, or /TO.
    o  You cannot specify /AFTER and /FROM on the same command line.
    o  You cannot specify /BEFORE and /TO on the same command line.

3.2  –  Command Parameters

 element-expression

    Specifies one or more generations of an element. 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.

3.3  –  Description

    The DELETE GENERATION command removes information about one or
    more generations of an element. Once a generation is deleted, it
    cannot be restored to its former place in the element in the CMS
    library. You can, however, archive the contents of the generation
    using the /ARCHIVE qualifier and later restore the contents of the
    generation.

    If the generation or range of generations to be deleted has a
    direct descendant generation (that is, a descendant generation on
    the same line of descent), then the changes associated with those
    generations are combined, and then those changes are combined
    with the changes in the descendant generation. If there is
    no descendant generation, that is, the generation or range of
    generations to be deleted is at the end of the line of descent,
    then the changes associated with those generations are discarded.

    You can specify a single generation with the /GENERATION
    qualifier. /GENERATION=1+ is the default. You can also specify
    a range of generations with either the /AFTER or /FROM qualifier
    to delimit the beginning of a range, and either the /BEFORE or /TO
    qualifier to delimit the end of a range. These sets of qualifiers
    can be paired to specify ranges with inclusive or exclusive
    endpoints (see the restriction section).

    If you delete the latest generation on the main line of descent of
    an element that has the reference copy attribute, CMS deletes the
    generation's reference copy and creates a new reference copy that
    corresponds to the generation that is now the latest generation on
    the main line of descent.

3.4  –  Qualifiers

3.4.1    /AFTER[=generation-expression]

    Specifies the start of a range of generations that are to be
    deleted, excluding the specified generation. You cannot specify
    both /AFTER and /FROM or both /AFTER and /GENERATION. You must
    specify the end of the range with either the /BEFORE or /TO
    qualifier.

3.4.2    /ARCHIVE=[file-specification]

    Specifies a file to which CMS writes archived generation
    information. If the file specification is omitted, CMS creates
    a file for each with the same name as the element and the .CMS_
    ARCHIVE file type and places it in your default directory.

3.4.3    /BEFORE[=generation-expression]

    Specifies the end of a range of generations that are to be
    deleted, excluding the specified generation. You cannot specify
    both /BEFORE and /TO or both /BEFORE and /GENERATION. You must
    specify the start of the range with either the /AFTER or /FROM
    qualifier.

3.4.4    /CONFIRM (D)

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you 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 or QUIT or press RETURN, 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.5    /FROM[=generation-expression]

    Specifies the start of a range of generations that are to be
    deleted, including the specified generation. You cannot specify
    both /FROM and /AFTER or both /FROM and /GENERATION. You must
    specify the end of the range with either the /BEFORE or /TO
    qualifier.

3.4.6    /GENERATION[=generation-expression]

    Specifies a particular generation of the element to be deleted. By
    default, the most recent generation on the main line of descent is
    deleted. You cannot combine /GENERATION with any of the following
    qualifiers: /FROM, /TO, /AFTER, and /BEFORE.

3.4.7    /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.8    /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
       ELEMENT (D)
       NOELEMENT
       NONE--equivalent to NOELEMENT

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

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

3.4.9    /TO[=generation-expression]

    Specifies the end of a range of generations that are to be
    deleted, including the specified generation. You cannot specify
    both /TO and /BEFORE or both /TO and /GENERATION. You must specify
    the start of the range with either the /AFTER or /FROM qualifier.

3.5  –  Examples

    (1) CMS> DELETE GENERATION/NOCONFIRM SAMPLE.PAS/GENERATION=5B1
        _Remark: Delete variant line
        %CMS-S-GENDELETED, 1 generation of element
        DISKX:[PROJECT.CMSLIB]SAMPLE.PAS deleted

      This command deletes generation 5B1 of the element SAMPLE.PAS.
      The /NOCONFIRM qualifier directs CMS to suppress the prompt
      confirming the operation.

    (2) CMS> DELETE GENERATION SAMPLE.*/AFTER=V1/BEFORE=V2
        _Remark: delete generations between released versions
        Delete 5 generations after V1(1) before V2(7) of element SAMPLE.PAS?
        [Y/N] (N): Y
        %CMS-S-GENDELETED, 5 generations of element
        DISKX:[PROJECT.CMSLIB]SAMPLE.PAS deleted

      This command deletes all generations of the element after the
      generation in class V1 and before the generation in class V2,
      excluding the two generations in classes V1 and V2.

    (3) CMS> DELETE GENERATION SAMPLE.PAS/AFTER=1/BEFORE=V1
        _Remark: delete a range
        %CMS-E-NOGENDELETED, no generations of
        DISKX:[PROJECT.CMSLIB]SAMPLE.PAS deleted
        -CMS-E-VARINRANGE, range has variants

        CMS> DELETE GENERATION/ARCHIVE/FROM=2A1/TO=2A1+/NOCONFIRM SAMPLE.PAS
        _Remark: delete the variant range and archive the deleted generations
        %CMS-S-GENDELETED, 3 generations of element
        DISKX:[PROJECT.CMSLIB]SAMPLE.PAS deleted

      The first command specifies that all generations be deleted
      between generation 1 and the generation in class V1. CMS could
      not delete the generations, however, because it found variants
      for the indicated generations.

      The second command specifies a range of generations to be
      deleted from and including the variant generation 2A1 to
      and including the latest variant generation of the element
      SAMPLE.PAS. In this case, CMS deleted 3 generations of the
      element. The /ARCHIVE qualifier directs CMS to save the deleted
      generations in an archive file in your default directory.

      To display the descendants of a generation and the
      classes containing the generations, use the SHOW
      GENERATION/DESCENDANTS/MEMBER command.

4  –  GROUP

    Deletes one or more groups from a CMS library.

       Format:

          DELETE GROUP  group-expression "remark"

4.1  –  Restrictions

    o  You cannot delete a group that contains any elements or groups
       unless you specify the /REMOVE_CONTENTS qualifier.
    o  You cannot delete a group that belongs to another group.
    o  You cannot delete a group that has read-only access. (Use the
       MODIFY GROUP/NOREAD_ONLY command to change the access to the
       group.)

4.2  –  Command Parameters

 group-expression

    Specifies the group or groups to be deleted. A group expression
    can be one or more group names, 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.

4.3  –  Description

    The DELETE GROUP command deletes a group from a CMS library. If
    the group is not empty and the /REMOVE_CONTENTS qualifier is
    not specified, or if the group belongs to another group, CMS
    returns an error and does not delete the group.

    Even though a group is deleted, records of transactions that
    created and used the group are retained in the library history.
    You can reuse the deleted group name to create a new group.
    However, there is no distinction between the two groups in the
    library history, except that their transactions are separated by
    entries for DELETE GROUP and CREATE GROUP commands.

    To determine which elements and groups belong to a group, use the
    SHOW GROUP command with the /CONTENTS qualifier.

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

    Controls whether CMS removes elements and groups from the specified
    group prior to deleting the group. When /REMOVE_CONTENTS is
    specified CMS displays an informational message for each element or
    group that is removed from the group.

4.5  –  Example

    CMS> DELETE GROUP TIME_TST "superseded by comparison tests"
    %CMS-S-DELETED, group DISKX:[PROJECT.CMSLIB]TIME_TST deleted

      This command deletes the group named TIME_TST.

5  –  HISTORY

    Deletes all or part of the library history.

       Format:

          DELETE HISTORY  "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 DELETE HISTORY command deletes all or part of the library
    history. By default, CMS writes the deleted history records to
    a file named HISTORY.DMP in your current default directory. CMS
    cannot access this file as a history file.

    The DELETE HISTORY command does not delete the library creation
    history record.

    Whenever you delete some of the library history, CMS records two
    transactions. As with other commands that modify the contents of
    the library, CMS records the deletion transaction. In addition,
    CMS logs a REMARK transaction at the point that corresponds to
    the /BEFORE value. If you do not specify the /BEFORE qualifier,
    the default is /BEFORE=current-time. The REMARK transaction
    record includes the following remark: "PREVIOUS HISTORY DELETED".
    Both the REMARK and the DELETE HISTORY transactions are unusual
    transactions. When you use the SHOW HISTORY command, CMS
    identifies unusual transactions by displaying an asterisk (*)
    in the first column of the transaction record.

5.3  –  Qualifiers

5.3.1    /BEFORE=date-time

    Deletes all of the history information before a specified time. A
    single entry is made in the history file specifying that a section
    of the history data has been removed. This entry is made at the
    location in the history file where the lines were deleted.

    The time value can be an absolute, delta, or combination time
    value, or one of the following keywords: TODAY, TOMORROW, or
    YESTERDAY.  If the time value is a future value, CMS uses the
    current time.

5.3.2    /CONFIRM (D)

    Controls whether CMS prompts you for confirmation before each
    transaction.

    When you 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 or QUIT or press RETURN, 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.

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

5.3.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 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.5    /OBJECT=object-expression

    Specifies an object about which history information is to be
    deleted. The object expression can be one or more class names,
    element names, group names, a wildcard expression, or a list of
    any of these, separated by commas. If you do not specify an object
    expression, CMS deletes all classes, elements, and group
    transaction records in the library subject to the constraints
    imposed by other qualifiers.

5.3.6    /OUTPUT[=file-specification]

    Directs CMS 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), CMS creates a file named HISTORY.DMP in your
    current default directory.

5.3.7    /TRANSACTIONS=(keyword,...)

5.3.8    /NOTRANSACTIONS=(keyword,...)

    Deletes all transaction records generated by a specific command.
    You can specify the following keywords with this qualifier:

    ACCEPT   FETCH     REMOVE
    ALL      INSERT    REPLACE
    CANCEL   MARK      RESERVE
    COPY     MODIFY    REVIEW
    CREATE   REJECT    SET
    DELETE   REMARK    UNRESERVE
                       VERIFY

    If you specify more than one keyword, you must enclose the keyword
    list in parentheses. The /TRANSACTIONS qualifier directs CMS
    to delete transaction records for only the listed keywords. The
    /NOTRANSACTIONS qualifier directs CMS to delete transaction records
    for all keywords except the listed keywords. If you omit the
    /TRANSACTIONS qualifier (or if you specify /TRANSACTIONS but do
    not provide any keywords), CMS deletes transaction records for all
    transaction types.

5.3.9    /USER=username

    Deletes all transaction records created by the specified user.

5.4  –  Example

    CMS> DELETE HISTORY/BEFORE=TODAY "old history in HISTORY.DMP"
    Confirm DELETE HISTORY/BEFORE=10-MAY-1988 [Y/N] (N): y
    %CMS-S-HISTDEL, 89 history records deleted

      This example deletes all of the library history prior to
      the current day. The following shows the first few records
      contained in the HISTORY.DMP file:

          Deleted dump for CMS Library DISKX:[PROJECT.CMSLIB]

            6-MAR-1988 17:07:50 SNAKE  CREATE ELEMENT OUTPUT.FOR
                  "ASCII format"
            6-MAR-1988 17:26:10 MARTIN CREATE ELEMENT INIT.FOR
                  "init routines"
            8-MAR-1988 12:33:09 LISA   RESERVE INIT.FOR(1) "change
                  header offset"
            9-MAR-1988 17:34:04 LISA   REPLACE INIT.FOR(2) "header
                  offset and additional free space added"
              .
              .
              .

      The CREATE LIBRARY transaction is not deleted from the library
      history.
Close Help