lstype

Lists a VOB's type objects.

Applicability


Product	Command type
VersionVault	cleartool subcommand
VersionVault Remote Client	rcleartool subcommand


Platform
UNIX®
Linux®
Windows®

Synopsis

List type objects:

lstype [ –local ] [ –l/ong | –s/hort | –fmt format | –nos/tatus ]

[ –obs/olete ]
{ –kin/d type-kind [ –inv/ob vob-selector ] [ –uns/orted ]

| type-selector ...

}
On Windows®, with cleartool only—List type objects graphically:

lstype –g/raphical [ –kin/d type-kind ] [ –inv/ob vob-selector ]

Description

The lstype command lists information about one or more of a VOB's type objects.

Obsolete type objects

Type objects can be rendered obsolete with the lock –xxtype –obsolete command. lstype lists an obsolete type object only if you either specify its name with a type-name argument or use the –obsolete option.

Restrictions

None.

Options and arguments

Listing local copies of global types

Default: In addition to types in the specified VOB, lstype lists all global types in associated administrative VOBs.
–local: Lists ordinary types and local copies of global types.

Listing format

Default: A type object listing looks like this:
2006-11-07 sakai element type "text_file"
–l/ong: Expands the listing to include any type-specific parameters (for example, that a label type is one-per-element or that an element type inherited its type manager from the text_file supertype and so on.)
For attribute types, hyperlink types, and label types, lstype –longshows the instance mastership of the type (whether the type's mastership can be shared by multiple replicas), even if the VOB is not replicated.
–s/hort: Restricts the listing to type names only.
–fmt format-string: Lists information using the specified format string.
–nos/tatus: Implies the –short option and prints out all the type names regardless of lock status.
–uns/orted: Do not sort the results. The results are displayed much sooner and are effectively ordered by creation date.

Listing obsolete types

Default: If you do not specify any type-name argument, only the nonobsolete types of the specified kind are listed.
–obs/olete: Includes obsolete type objects in the listing when you do not specify any individual type objects with type-name arguments. Has no effect if you specify one or more type-name arguments.

Specifying the kind of type object

Default: None.
–kin/d type-kind: A kind of type object. All objects of this kind are listed. type-kind can be one of:
attype, brtype, eltype, hltype, lbtype, trtype

Specifying the VOB

Default

Lists type objects in the VOB that contains the current working directory.

–inv/ob vob-selector

The VOB whose type objects are to be listed. Specify vob-selector in the form [vob:] pname-in-vob.


`pname-in-vob`	Path name of the VOB tag (whether or not the VOB is mounted) or of any file system object within the VOB (if the VOB is mounted)

Specifying individual type objects

Default

None.

type-selector ...

One or more names of type objects. The listing includes only the named objects. Specify type-selector in the form [type-kind:] type-name[@vob-selector]

Specifying individual type objects
	One of
`type-kind`	attype	Attribute type
	brtype	Branch type
	eltype	Element type
	hltype	Hyperlink type
	lbtype	Label type
	trtype	Trigger type
`type-name`	Name of the type object.
`vob-selector`	Object-selector for a VOB, in the same format as with –invob, above.

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.

The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.

In cleartool single-command mode, cmd-context represents the UNIX system and Linux shells or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

List all branch types defined in the VOB containing the current working directory.
cmd-context lstype –kind brtype
—12-15T09:34 jenny branch type "main" "Predefined branch type used to represent the main branch of elements." —12-08T12:12 jackson branch type "test" "test development branch" —12-08T12:12 jackson branch type "patch2" —12-08T12:12 jackson branch type "patch3" —12-08T12:12 jackson branch type "rel2_bugfix"
List all label types defined in the current VOB. Use the short format, and include obsolete label types.
cmd-context lstype –kind lbtype –obsolete –short
BACKSTOP CHECKEDOUT LATEST REL1 (obsolete) REL2 REL3 V2.7.1 (obsolete)

Note that the listing includes the three predefined label types, BACKSTOP, LATEST, and CHECKEDOUT.
List information about a particular user-defined element type, in long format.
cmd-context lstype –long eltype:c_source
element type "c_source" 2006-12-08T12:12:38 by Chuck Jackson (test user) (jackson.dvt@oxygen) owner: jackson group: dvt scope: this VOB (ordinary type) type manager: text_file_delta (inherited from type "text_file") supertype: text_file meta-type of element: file element
List information about a particular trigger type, in long format.
cmd-context lstype –long trtype:trig1
trigger type "trig1" 2006-12-08T12:14:08 by jackson.dvt@oxygen owner: jackson group: dvt element trigger pre-operation MODIFY_ELEM action: -exec checkcmt
List information about a particular hyperlink type.
cmd-context lstype –long hltype:design_spec
hyperlink type "design_spec" 2006-12-08T12:13:31 by Chuck Jackson (test user) (jackson.dvt@oxygen) "source to design document" instance mastership: unshared owner: jackson group: dvt scope: this VOB (ordinary type)
List the name, lock status, master replica, and scope of all label types in the VOB /vobs/stage. (The command line, including the quoted format string, constitutes a single input line. The input line below is broken to improve readability. Spaces are significant.)
cmd-context lstype –fmt "%n\n\tLock status: %[locked]p\n\t Master replica: %[master]p\n\tScope: %[type_scope]p\n" -kind lbtype
V3.BL3 Lock status: unlocked Master replica: lex Scope: ordinary V3.BL4 Lock status: locked Master replica: lex Scope: global V4.0.DOC Lock status: unlocked Master replica: doc_clone Scope: ordinary V4.0.HELP Lock status: unlocked Master replica: doc_clone Scope: ordinary
List the name, kind, and creation comment of a particular trigger type.
cmd-context lstype -fmt "%n\t%[trigger_kind]p\n\t%c" trtype:cmnt
cmnt element trigger prompt user for comment