1 – CLASS
Creates one or more empty classes.
Format:
CREATE CLASS class-name[,...] "remark"
1.1 – Command Parameters
class-name
Specifies a name for the class. CMS reports an error if you
specify a name that is already used for an existing class or
group. (Class and group names must be unique.) If a previously
used class or group name has been removed with the DELETE CLASS or
DELETE GROUP command, you can reuse that name with CREATE CLASS. A
class name can also be a list of class names separated by commas.
Wildcards are not allowed.
remark
Specifies a character string for the creation remark of the class
to be logged in the history file with this command. The remark
is enclosed in quotation marks. If no remark was entered, a null
remark ("") is logged.
1.2 – Description
The CREATE CLASS command establishes a class. After a class is
created, you can place any related set of element generations
in that class by using the INSERT GENERATION command. The CREATE
CLASS command does not automatically place any generations in the
created class.
1.3 – Qualifiers
1.3.1 /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.3.2 /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. If you
specify /OCCLUDE=NOCLASS, CMS creates a class in every library in
the search list.
1.4 – Examples
(1) CMS> CREATE CLASS INTERNAL_RELEASE "for internal use only"
%CMS-S-CREATED, class DISKX:[PROJECT.CMSLIB]INTERNAL_RELEASE created
This command creates a class named INTERNAL_RELEASE. Once the
class name is established, element generations can be placed in
the class with the INSERT GENERATION command.
(2) CMS> CREATE CLASS FTEST1,FTEST2,V1 "for external release"
%CMS-I-CREATED, class DISKX:[PROJECT.CMSLIB]FTEST1 created
%CMS-I-CREATED, class DISKX:[PROJECT.CMSLIB]FTEST2 created
%CMS-I-CREATED, class DISKX:[PROJECT.CMSLIB]V1 created
%CMS-S-CREATES, 3 creations completed
This command creates the three classes FTEST1, FTEST2, and V1.
2 – ELEMENT
Creates one or more new elements in a CMS library from an existing
file.
Format:
CREATE ELEMENT element-expression "remark"
2.1 – Restrictions
o If you specify the /NOTES qualifier, you must also specify the
/POSITION qualifier on the same command line.
2.2 – Command Parameters
element-expression
Specifies one or more elements to be created. If you do not
specify the /INPUT qualifier (or if you specify /INPUT without
a value), the element name must correspond to an existing file
in your current default directory. The name cannot be the same as
any existing element name in the library. Do not use the file name
00CMS because this name is reserved for library control files.
Generation 1 of the new element is created. An element expression
can also be a list of element names separated by commas, or a
wildcard expression.
remark
Specifies a character string for the creation remark of the
element to be logged in the history file with this command. The
remark is stored with both the element and its first generation.
The remark is enclosed in quotation marks. If no remark was
entered, a null remark ("") is logged.
2.3 – Description
The CREATE ELEMENT command creates the first generation of a new
element by moving the input file into a CMS library. By default,
CMS searches for the file in your current default directory.
You can direct CMS to use a file in a different directory by
specifying the /INPUT qualifier. After the element is created, CMS
deletes all versions of the file used to create the new element.
If you specify either the /KEEP or /RESERVE qualifiers, CMS does
not delete the file.
When you create an element, you can also define the history,
concurrent, notes, position, reference copy, and review attributes
for the element or establish a reservation.
CMS stores the creation date and time, the revision date and time,
file attributes, and the file revision number of the file used to
create generation 1 of the new element. When you fetch or reserve
a generation of an element, CMS restores the times, attributes,
and file revision number associated with the file used to create
the element generation. You can also display this information by
using the SHOW GENERATION/FULL command.
To change the creation remark associated with the element or
generation 1 of the element, use the MODIFY ELEMENT or MODIFY
GENERATION command, respectively.
2.4 – Qualifiers
2.4.1 /CONCURRENT (D)
Specifies whether this element can have multiple reservations.
After you have created the element, you grant or deny concurrent
access by using the MODIFY ELEMENT command.
2.4.2 /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.3 /HISTORY="string"
Establishes the history attribute for the element. If an element
has the history attribute, its history 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.4 /INPUT[=file-specification]
Specifies the file to be used to create the element. When you
specify an alternative location for the input file, CMS deletes
the file from the alternative location (unless you specify /KEEP
or /RESERVE). If you do not specify this qualifier, CMS searches
your current default directory for a file with the same name as
specified with the element expression parameter on the command
line. Wildcards are allowed.
CMS must be able to create a unique element for each file in the
input file list. Thus, if you use wildcards in the /INPUT file
specification to specify more than one input file, you must also
use wildcards in the element-name parameter.
2.4.5 /KEEP
Controls whether CMS deletes all versions of the file used to
create the new element. If you specify /KEEP, CMS does not delete
the file.
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 /NOTES="string"
Establishes the notes attribute for the element. If an element has
the 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. If
you specify /NOTES, you must also specify /POSITION.
2.4.8 /POSITION=n
Establishes the position attribute; that is, the character
position where the note generated by the /NOTES qualifier begins
on the line. The value n is required and must be an integer in
the range 1 to 511. The /NOTES qualifier is required with the
/POSITION qualifier.
The note is placed to the right of the text of the line. 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 eight characters thereafter.)
2.4.9 /REFERENCE_COPY
2.4.10 /NOREFERENCE_COPY
Controls whether CMS maintains a reference copy of the element.
You must have established a reference copy directory.
The presence of the reference copy attribute for an element is
inherited from the library, that is, if a reference copy directory
is established for the library, by default, the attribute is
enabled for the element. You can override the reference copy
attribute by specifying /NOREFERENCE_COPY.
If a reference copy directory has been established for the CMS
library, CMS creates a reference copy of the new element and
updates the reference copy directory each time you create a new
main line generation of that element. When CMS places a file in
the reference copy directory, it also deletes any earlier versions
of that file in the reference copy directory.
2.4.11 /RESERVE
Controls whether the new element is to be reserved after it is
created. When you specify /RESERVE, CMS does not delete the file
used to create the element. Generation 1 of the newly created
element is automatically reserved.
If you omit both the /RESERVE and the /KEEP qualifiers, CMS
deletes all versions of the file used to create the element.
2.4.12 /REVIEW
Specifies that new generations of the element are marked for
review. By default, new generations of the element are marked
for review only if the reserved generation was either rejected
or has a review pending. If you specify CREATE ELEMENT/REVIEW,
generation 1 of the element is also marked for review.
You can change the review attribute with the MODIFY ELEMENT
command.
2.4.13 /BINARY
Controls whether CMS has to create an element of type binary
or text. When you specify this qualifier, CMS creates the element
in binary format irrespective of file properties.
If you do not specify this qualifier, CMS decides on its own
whether to create binary element or text element depending on
file properties.
2.5 – Example
CMS> CREATE ELEMENT INIT.FOR "initialization routines"
%CMS-S-CREATED, element DISKX:[PROJECT.CMSLIB]INIT.FOR created
This command creates an element named INIT.FOR from a file
with the same name in the current default directory, and
then deletes all versions of that file in the current default
directory.
3 – GROUP
Creates one or more empty groups.
Format:
CREATE GROUP group-name[,...] "remark"
3.1 – Command Parameters
group-name
Specifies a name for the group. CMS reports an error if you
specify an existing group or class name. (Group and class names
must be unique.) However, if a previously used group or class name
has been removed with the DELETE GROUP or DELETE CLASS command,
you can reuse that name with CREATE GROUP. A group name can also
be a list of group names separated by commas. Wildcards are not
allowed.
remark
Specifies a character string for the creation remark of the group
to be logged in the history file with this command. The remark
is enclosed in quotation marks. If no remark was entered, a null
remark ("") is logged.
3.2 – Description
The CREATE GROUP command establishes a group. After a group is
created, you can place any related set of elements or groups in
that group by using the INSERT ELEMENT or INSERT GROUP command.
The CREATE GROUP command does not automatically place any elements
or groups in the created group.
3.3 – Qualifiers
3.3.1 /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.3.2 /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. If you
specify /OCCLUDE=NOGROUP, CMS creates a group in every library in
the search list.
3.4 – Example
CMS> CREATE GROUP TIME_TST "files for time tests"
%CMS-S-CREATED, group DISKX:[PROJECT.CMSLIB]TIME_TST created
This command creates a group named TIME_TST. Once the group
name is established, elements can be placed in the group with
the INSERT ELEMENT command.
4 – LIBRARY
Creates one or more new CMS libraries in one or more existing
empty directories. You can have only one CMS library in each
directory.
Format:
CREATE LIBRARY directory-specification[,...] "remark"
4.1 – Restrictions
o You cannot specify both the /AFTER and the /BEFORE qualifiers
on the same command line.
4.2 – Command Parameters
directory-specification
Specifies one or more valid OpenVMS directories. Each directory must
not contain any files. A directory that is to be used as a CMS
library cannot be your current default directory. If you specify
more than one OpenVMS directory, you must separate the directory
specifications with commas. Wildcards are not allowed.
remark
Specifies a character string for the creation remark of the new
library to be logged in the history file with this command. The
remark is enclosed in quotation marks. If no remark was entered, a
null remark ("") is logged in the history file.
4.3 – Description
The CREATE LIBRARY command builds CMS control files in a
directory so that it can be used as a CMS library. After you have
established a library with the CREATE LIBRARY command, you can
issue CMS commands to manipulate the library. When you issue the
CREATE LIBRARY command, your current CMS library is automatically
set to the library or libraries specified. You can use CREATE
LIBRARY only once on a library.
You can create more than one library at a time by specifying the
CREATE LIBRARY command with more than one directory specification.
The directory specifications must be separated by commas.
When you execute this command, CMS defines a logical name that
begins with CMS$. These names are used by subsequent CMS commands.
You should not define logical names beginning with CMS$ because
this prefix is reserved for use by CMS.
4.4 – Qualifiers
4.4.1 /AFTER[=directory-specification]
Instructs CMS to insert new libraries into the existing library
search list immediately following the existing specified
directory. The specified directory must be in the existing
library search list. If you omit the directory specification,
CMS automatically adds the libraries (in the order you specify) to
the end of the list. You cannot specify both /AFTER and /BEFORE on
the same command line. If neither /AFTER or /BEFORE is specified,
the CREATE LIBRARY command's library list supersedes any existing
search list.
4.4.2 /BEFORE[=directory-specification]
Instructs CMS to insert new libraries into the existing library
search list immediately in front of the existing specified
directory. The specified directory must be in the existing
library search list. If you omit the directory specification, CMS
automatically adds the libraries (in the order you specify) to the
front of the list. You cannot specify both /AFTER and /BEFORE on
the same command line. If neither /AFTER nor /BEFORE is specified,
the CREATE LIBRARY command's library list supersedes any existing
search list.
4.4.3 /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.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.4.4 /CREATE_DIRECTORY
Instructs CMS to create a directory to contain the library if the
directory does not already exist. /NOCREATE_DIRECTORY is the default.
4.4.5 /EXTENDED_FILENAMES
Used to create a CMS library that allows the use of extended file
names. This qualifier is only available on OpenVMS V7.2 and later.
Use /NOEXTENDED_FILENAMES to create a CMS library that does not allow
the use of extended file names. /NOEXTENDED_FILENAMES is the default.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.4.6 /KEEP
Instructs CMS to not delete all versions of a file used to create
a new element or generation. /NOKEEP is the default.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.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.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.4.8 /LONG_VARIANT_NAMES
Used to create a CMS library that allows the use of long variant names.
Use /NOLONG_VARIANT_NAMES to create a CMS library that does not allow
the use of long variant names. /NOLONG_VARIANT_NAMES is the default.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.4.9 /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
should it be a subdirectory of a CMS library directory. If you use
the CREATE LIBRARY command to create a search list 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 creates one library
for the entire search list, not one library for each library in
the search list. Wildcards are not allowed.
/NOREFERENCE_COPY is the default.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.4.10 /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 ORIGINAL keyword 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 STORAGE-TIME keyword 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.
Use MODIFY LIBRARY to change this attribute on an existing library.
4.5 – Examples
(1) CMS> CREATE LIBRARY [RELEASE.CMSLIB] "follows development library"
%CMS-S-CREATED, CMS Library DISKX:[RELEASE.CMSLIB] created
This command creates a CMS library in the subdirectory
[RELEASE.CMSLIB]. The library does not contain any elements
yet. Subsequent CMS commands refer to the library contained
in [RELEASE.CMSLIB] until the user logs out or issues a SET
LIBRARY or another CREATE LIBRARY command.
(2) CMS> CREATE LIBRARY [DOC.PRE.CMSLIB],[DOC.TESTA.CMSLIB],
[DOC.FNL.CMSLIB] "creating doc lib"
This example creates three CMS libraries in the subdirectories
[DOC.PRE.CMSLIB], [DOC.TESTA.CMSLIB], and [DOC.FNL.CMSLIB], and
sets the library search list to the three libraries, in that
order.