mktag

Creates a tag for a view or VOB

APPLICABILITY

SYNOPSIS

• ClearCase and Attache on UNIX-Create a tag for a dynamic view:

mktag -vie·w -tag dynamic-view-tag [ -tco·mment tag-comment ]

[ -rep·lace | -reg·ion network-region ] [ -nst·art ] [ -nca·exported ]
[ -hos·t hostname -gpa·th global-storage-pname ] dynamic-view-storage-pname

• ClearCase and Attache on Windows-Create a tag for a dynamic view:

mktag -vie·w -tag dynamic-view-tag [ -tco·mment tag-comment ]

[ -rep·lace | -reg·ion network-region ] [ -nst·art ]
[ -hos·t hostname -gpa·th global-storage-pname ] dynamic-view-storage-pname

• ClearCase and Attache-Create a tag for a snapshot view:

mktag -vie·w -tag snapshot-view-tag [ -tco·mment tag-comment ]

[ -rep·lace | -reg·ion network-region ] [ -nst·art ]
[ -hos·t hostname -gpa·th global-storage-pname
| -ngpath [ -host hostname ] ] snapshot-view-storage-pname

• ClearCase and Attache on UNIX-Create a VOB-tag:

mktag -vob -tag vob-tag [ -tco·mment tag-comment ]

[ -rep·lace | -reg·ion network-region ] [ -opt·ions mount-options ]
[ -pub·lic ] [ -pas·sword tag-registry-password ] [ -nca·exported ]
[ -hos·t hostname -gpa·th global-storage-pname
| -ngp·ath [ -hos·t hostname ] ] vob-storage-pname

• ClearCase and Attache on Windows-Create a VOB-tag:

mktag -vob -tag vob-tag [ -tco·mment tag-comment ]

[ -rep·lace | -reg·ion network-region ] [ -opt·ions mount-options ]
[ -pub·lic ] [ -pas·sword tag-registry-password ] ·
[ -hos·t hostname -gpa·th global-storage-pname
| -ngp·ath [ -hos·t hostname ] ] vob-storage-pname

• ClearCase LT-Create a view-tag:

mktag -vie·w -tag view-tag [ -tco·mment tag-comment ] [ -rep·lace ] [ -nst·art ]

snapshot-view-storage-pname

• ClearCase LT-Create a VOB-tag:

mktag -vob -tag vob-tag [ -tco·mment tag-comment ] [ -rep·lace ] vob-storage-pname

DESCRIPTION

For an existing view or VOB, the mktag command creates or replaces an entry in the registry. A view or VOB gets one tag when it is created with mkview or mkvob.

ClearCase and Attache-Using mktag

In ClearCase and Attache, you can use mktag to create additional tags, enabling access from multiple network regions. Each network region needs its own tag for a view or VOB. A single region cannot have multiple tags for the same VOB. (Multiple tags for a view are valid, but not recommended.) However, a single tag can be assigned to multiple regions with multiple mktag commands. See the Administrator's Guide for a discussion of network regions.

By default, creating a view-tag activates the view on your host, by implicitly performing a startview command. This does not occur if your host is not in the tag's assigned network region, or if you use the -nstart option. For a dynamic view, creating the view-tag also activates the view. However, creating a VOB-tag does not activate the VOB; use mount for this purpose.

ClearCase LT-Using mktag

In ClearCase LT, mktag is used to replace a tag. mktag -view activates the view unless you use the -nstart option.

RESTRICTIONS

Identities: In ClearCase and Attache, you must be the VOB owner to create a private VOB-tag. In ClearCase LT, no special identity is required.

Locks: No locks apply.

Mastership: (Replicated VOBs) No mastership restrictions.

OPTIONS AND ARGUMENTS

SPECIFYING THE KIND OF TAG TO REPLACE.  Default: None.

-vie·w

Specifies a view-tag.

-vob

Specifies a VOB-tag.

SPECIFYING THE TAG.  Default: None.

-tag dynamic-view-tag | snapshot-view-tag

A name for the view, in the form of simple file name.

-tag vob-tag

ClearCase and Attache-Either a standard full pathname, which specifies the location at which the VOB will be mounted; or a name for the VOB, in the form of an absolute single-component pathname (for example, /big_vob). If the region is a ClearCase LT region (these regions are named CCLT), the VOB-tag must be in the form of an absolute single-component pathname.

ClearCase LT-A name for the VOB, in the form of an absolute single-component pathname; for example, \big_vob.

-tco·mment tag-comment

Adds a comment to the tag's entry in the registry. Use the -long option with lsvob or lsview to display the tag comment.

OVERWRITING AN EXISTING TAG.  Default: None.

-rep·lace

Replaces an existing tag registry entry with a new entry. (No error occurs if the tag does not exist.) You can use this option to change the tag comment and access paths. You cannot use -replace to change an existing tag's name; to do this, delete the tag with rmtag and then use mktag.

ClearCase and Attache-This option also enables you to convert private VOBs to public and vice versa, and to change startview behavior. (To change a private VOB to public, you must provide the tag-registry password. To change a public VOB to private, you must be the VOB owner.)

STARTING THE VIEW.  Default for ClearCase and Attache: Starts the view_server process on the host where the view storage location resides, if it isn't already running. For a dynamic view, creating a view-tag also makes the view active on your host, making the view-tag appear as a directory entry in the viewroot directory. Default for ClearCase LT: Starts the view_server process on the ClearCase LT server host.

-nst·art

Suppresses starting of the view_server process.

MARKING A VIEW OR VOB FOR EXPORT. Default: The view-tag or VOB-tag is not marked for export.

-nca·exported

Marks the view-tag or VOB-tag in the registry as an export view or VOB. See the mkview and mkvob reference pages for more information. This option applies to dynamic view environments only.

SPECIFYING A NETWORK REGION.  Default: Creates a tag in the local host's network region. (Use the hostinfo -long command to list a host's network region.) See the Administrator's Guide for a discussion of network regions.

-reg·ion network-region

Creates the tag in the specified network region. An error occurs if the region does not already exist. An error occurs if the VOB already has a tag in the specified network region.

SPECIFYING MOUNT OPTIONS.  Default: No mount options are included in the VOB registry entry for a new VOB-tag.

-opt·ions mount-options

(VOB-tags only. You must be root (UNIX) or a member of the ClearCase administrators group to use this option.) Specifies mount options to be used when the VOB is activated through this VOB-tag. See the mkvob and mount reference page for syntax details.

PUBLIC VS. PRIVATE VOB.  Default: Creates a private VOB-tag (does not apply to view-tags). An error occurs if you are not the VOB owner.

-pub·lic

Creates a public VOB-tag. See the mkvob reference page for a discussion of public and private VOBs.

-pas·sword tag-registry-password

Specifies the VOB-tag password, which is required to create a public tag or to create a private tag when you include suid as an argument to -options.

In these cases, if you do not include a password, you are prompted for it. The value you specify is checked against the tag registry password; an error occurs if there is no match. For more information, see the Administrator's Guide.

NOTE: The VOB-tags for a given VOB must all be private, or all be public.

SPECIFYING CLIENT ACCESSIBILITY INFORMATION.  Default: Derived from dynamic-view-storage-pname or snapshot-view-storage-pname for a view tag, or from vob-storage-pname for a VOB-tag.

-hos·t hostname

-gpa·th global-pname

-ngp·ath

See the mkstgloc reference page for general information on these options; note, however, that the view or VOB for which you are making a tag need not necessarily reside in a server storage location created with mkstgloc.

To create a tag for a VOB or view that resides on a supported network attached storage (NAS) device, you must specify the option set, -host -gpath. (NAS devices must be specially configured for use with ClearCase. See the Administrator's Guide for details.)

The information you provide is written to the registry exactly as you specify it.

SPECIFYING THE PATH TO THE VOB OR VIEW STORAGE.  Default: None.

dynamic-view-storage-pname

snapshot-view-storage-pname

vob-storage-pname

Specifies the path to an existing storage directory for a view or a VOB (the directory may be in a server storage location; see mkstgloc).

ClearCase and Attache-The pathname must specify a location on a host where the ClearCase installation is not client-only. For storage intended for snapshot views or VOBs to be accessed only through snapshot views, the pathname must be a UNC name only if there is a global path to the server storage location (that is, you have not specified -ngpath).

ClearCase and Attache on Windows-For storage intended for dynamic views or VOBs they access, the pathname must be a UNC name.

NAS devices providing storage for ClearCase on UNIX or Windows- The pathname must specify a location on the NAS device that is accessible to all ClearCase hosts in the region.

ClearCase, ClearCase LT, and Attache on Windows-The pathname must not be within a Windows special share, such as the share that is designated by drive$ and that allows administrators to access the drive over the network.

ClearCase LT-The pathname must be located on the ClearCase LT server host and must be must be a UNC name.

EXAMPLES

The UNIX 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 shell or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt. In Attache, cmd-context represents the workspace prompt.

NOTE: In the UNIX examples that follow, arguments and output that show multicomponent VOB tags are not applicable to ClearCase LT, which recognizes only single-component VOB tags. In this manual, a multicomponent VOB tag is by convention a two-component VOB tag of the form /vobs/vob-tag-leaf-for example, /vobs/src. A single-component VOB tag consists of a leaf only-for example, /src. In all other respects, the examples are valid for ClearCase LT.

• For the network region europe, assign the new view-tag view5 to an existing view storage area.

cmd-context mktag -view -tag view5 -region europe /net/gw/host3/view_store/view5.vws

• For the network region europe, register an existing VOB with a public VOB-tag.

cmd-context mktag -vob -tag \us_east1 -region europe -public -password tagPword ^
\\earth\vb_store\vob1.vbs

• Convert a private VOB to a public VOB, by replacing its private VOB-tag with a public one.

cmd-context mktag -vob -tag \publicvob -replace -public ^
-pass tagPword \\saturn\vobs\private.vbs

• Mark an existing view and VOB for export.

cmd-context mktag -view -tag bugfix -replace -ncaexported /net/neon/views/bugfix.vws

cmd-context mktag -vob -tag /vobs/dev -replace -ncaexported /net/pluto/vobstore/dev.vbs

SEE ALSO

lsview, lsvob, mkstgloc, mkview, mkvob, rmtag, startview