fmt_ccase

%[ min ][.max ][ MODIFIER [, ... ] ]keyletter

The conversion specification format closely resembles that of the C-language function printf():

• Percent sign (%)
• (Optional) A minimum and/or maximum field display width specifier, of the form min.max (see the section Specifying field width.)
• (Optional for some conversion specs) One or more modifier characters (uppercase) that specify one or more variants and/or a bracket-enclosed parameter (see the %a conversion specification)
• A key letter (lowercase), which indicates the kind of data to display

Unlike printf() specifiers, conversion specifications are not replaced by arguments supplied elsewhere on the command line; they are replaced automatically by cleartool, usually with field values extracted from event records.

These are the conversion specifications:

%a

All attached attributes. Attributes are listed as attr-name=value pairs. These pairs are enclosed in parentheses and separated by a comma-space combination (,SPACE). Variants:

%Na	No commas. Suppress the parentheses and commas in attribute list output; separate multiple attributes with spaces only.
%Sa	Value only. Display attribute values only (rather than attr=value)
%[attype]a	This attribute only. Display only the specified attribute, if it has been attached to the object

%c

Comment string. The user-supplied or system-generated comment stored in an event record. A newline character is appended to the comment string for display purposes only. Variant:

%Nc	No newline. Do not append a newline character to the comment string.

%d

Date/Time. The time stamp of the operation or event, in the format specified by the locale setting of the computer. The following are variants of %d:

%Sd	(Short) Date only.
%Vd	(Very long) Day of week, date, and time, in long format, where the month and day of the week are spelled out rather than abbreviated. The locale setting determines the exact format in which the date is displayed.
%Nd	(Numeric) Date and time in numeric form — yyyymmdd.time (time reported in 24-hour format).
%Ad	Age in days.
%MAd	Age in months.
%BAd	Age as a bar graph (longer bars for more recent events). A bar graph is drawn as a sequence of 0-5 number signs (#), representing the elapsed time since the reported operation as follows:
	#####	Less than a week
	####	Less than a month
	###	Less than three months
	##	Less than six months
	#	Less than a year
		More than a year
%OAd	Age as a bar graph (longer bars for older events). A bar graph is drawn as a sequence of 0-5 number signs (#), representing the elapsed time since the reported operation as follows:
	#####	More than a year
	####	Less than a year
	###	Less than six months
	##	Less than three months
	#	Less than a month
		Less than a week

%e

Event kind; a brief description of the event. The event kind is derived from an event record's name, object kind, and operation kind fields. Sample event kinds:

create version
create branch
make hyperlink "Merge" on version
make label "REL2" on version
lock branch type

%f

Checked-out version information: For an element checked out to your view, the version ID of the checked-out element; for an element that is not checked out to your view, displays nothing. Variants:

%Rf	Checkout status — reserved or unreserved.
%Tf	View tag: The view tag of the view that checked out the element.
%[text]f	Text: Displays text as a prefix to the version ID.

%h

Name of the host where the event originated (the host on which the user %u was running that user caused the event). The host name is as reported by uname(2) (UNIX and Linux) or as stored in the ComputerName key in the Windows Registry (Windows).

For a VOB replica, %h displays the name of the host at which the mkreplica –export command that created the replica was entered. For the original replica in a family, this is the host where the original VOB was located when the first mkreplica –export command was entered.

%l

Labels: For versions, all attached labels; the null string otherwise. Labels are output as a comma-separated list, enclosed in parentheses. A <SPACE> character follows each comma. Variants:

%Cl	Max labels: Specify the maximum number of labels to display with the max-field-width parameter (see Specifying field width). If there are more labels, "..." is appended to the output. If no max-field-width is specified, the maximum default value is 3.
%Nl	No commas: Suppress the parentheses and commas in label list output; separate labels with spaces only.

%m

Object kind: The kind of object involved in the operation. For example:

• file
• element
• branch
• version
• stream
• derived object
• branch type
• label type

Variant:

%Km	Object selector kind; for example, brtype or lbtype. For more information about object selectors, see the cleartool reference page.

%n

Name of object: For a file system object, the extended path name (including the version ID for versions, and the DO ID for derived objects); for a type object, its name. Variants:

%Dn	Database identifier (DBID): The unique database identifier of the object.
%En	Element name: For a file system object, its standard file or element name, or its path name; for a type object, its name.
%Ln	Leaf name: For any named object, its simple name. The terminal node of a path name. This modifier can be combined with others.
%On	Object identifier (OID): The unique identifier of a VOB object.
%Sn	Short name: For a version, a short form of the version ID: branch-pathname/version-number. For other objects, the null string.
%PSn	Predecessor Short name: For a version, a short form of the predecessor version's version ID: branch-pathname/version-number. For other objects, the null string.
%Vn	Version ID: For a version or derived object, the version ID; for other objects, the null string.
%PVn	Predecessor Version ID: For a version, the predecessor version's version ID; for other objects, the null string.
%Xn	Extended name: Same as default %n output, but for checked-out versions, append the extension @@\branch-pathname\CHECKEDOUT. For non-file-system objects, prints the object selector. For more information about object selectors, see the cleartool reference page.

%o

Operation kind: The operation that caused the event to take place; commonly, the name of a cleartool subcommand. For example:

mkelem
mklabel
checkin
checkout

See the events_ccase reference page for a complete list of operations and the commands that cause them.

%[p]p

Property value: Displays the value of the property specified in square brackets. If multiple values are returned, they are separated by spaces.

%[p]Xp

Extended property value: Displays the long form of the value of the property specified in square brackets. Not all property values have both long and short forms. Versions, in particular, are always displayed as though X had been specified.

%[p]Cp

Separate list items with a comma as well as a space.

%[p]Qp

Enclose path names in quotation marks.

The following tables list variants and the objects to which they apply. For VersionVault variants, see Table 1. For variants related to objects that are protected by Access Control Lists (ACLs), see Table 2. For UCM variants, see Table 3. For MultiSite variants, see Table 4.

Table 1. Variants for VersionVault objects

Variant	Applies to	Description
%[name]p	All objects	Same as %n, including variants.
%[object_kind]p	All objects	Kind of object. For example: version, file element, directory element, versioned object base, replica, branch type, and so on.
%[locked]p	All objects that can be locked	Lock status of the object: locked, unlocked, or obsolete.
%[activity]p	Versions	Activity whose change set contains the specified version.
%[version_predecessor]p	Versions	Version ID (branch path name and version number) of the version's predecessor version.
%[type]p	Versions, elements	Name of version or element's element type (for a list of element types, see type_manager); not to be confused with the object kind (for which the conversion specification is %m).
%[triggers]p	Elements	List of trigger types attached to element. Does not list all-element triggers. The list is displayed in the following format: (trtype, trtype, trtype, ...)
%[triggers]Np	Elements	Suppresses parentheses and commas.
%[pool]p	Elements, shared derived objects	For an element, name of source pool. For a shared DO, name of DO pool.
%[pool]Cp	Elements	Name of cleartext pool.
%[pool]Dp	Shared derived objects	Name of derived object pool.
%[pool]Sp	Elements	Name of source pool.
%[DO_kind]p	Derived objects	Kind of derived object: shared, unshared, non-shareable.
%[DO_ref_count]p	Derived objects	Reference count for derived object.
%[slink_text]p	VOB symbolic links	Target of symbolic link, as displayed by cleartool ls.
%[slink_text]Tp	VOB symbolic links	Target of symbolic link, after link is traversed.
%[type_scope]p	Metadata object types	Object type's scope. ordinary means that use of the type is limited to the current (or specified) VOB. global means that the VOB is an administrative VOB and the type can be used in any client VOB of the administrative VOB or in any client VOB of a lower-level administrative VOB within an administrative VOB hierarchy. local copy means that the type has been copied to the VOB from the administrative VOB that contains the master version of the type's definition.
%[type_constraint]p	Branch types, label types	Constraint on type object: one version per element or one version per branch.
%[trigger_kind]p	Trigger types	Kind of trigger type: element trigger, all element trigger, type trigger.
%[msdostext_mode]p	VOBs	State of MS-DOS text mode setting for VOB: enabled or disabled.
%[group]p		Group name.
%[owner]p (Windows only)		Login name of the object's current owner.
%[owner]Fp		Login name of the objects‘ current owner. The optional F argument lists the owner's full name.
%[hlink:filter]p	hyperlinks	Displays the hyperlink source and target, with an arrow pointing from the source to the target. The optional H argument lists only the hyperlink names. You can optionally specify a filter string, preceded by a colon. This filter if present, restricts the output to names that match the filter string. Case is considered when matching the string.
%[aliases]ACQp	Files	Displays the file name and aliases. Path names can be quoted, separated by commas, or both. Specify A to include aliases displayed by describe -all. This variant does not apply to directories, but only to hard-linked files.
%[permissions]p	File system objects	Displays the object's permissions using the standard "rwx" notation.
%[flevel]p	VOBs	Displays the feature level of the VOB.
%[universal_selector]p\n	All objects	An object identifier that persists, even if the object is renamed. The output is of the form oid:oid@vobuuid:vobuuid.

Table 2. Variants for ACL-protected VersionVault objects

Variant	Applies to	Description
%[rolemap]Xp	VOB object, policy, rolemap, directory elements, file elements	Rolemap that protects this object, optionally displayed in long format (X).
%[policy]Xp	Rolemap	Policy that this rolemap implements, optionally displayed in long format (X).
%[objects_protected]CQNp	Rolemap	Space-separated list of objects protected by this rolemap, optionally separated by comma ( C ), new-line (N), and enclosed in quotes (Q).
%[implementing_rolemaps]CNQXp	Policy	Space-separated list of rolemaps that implement this policy, optionally separated by comma ( C ), new-line (N), enclosed in quotes (Q) and displayed in long format (X).

The variants in Table 3 apply only to UCM objects.

Table 3. Variants for UCM objects

Variant	Applies to	Description
%[contrib_acts]CXp	UCM activities	List of activities that contributed to the change set of an integration activity
%[crm_state]p	UCM activities	The activity's state
%[headline]p	UCM activities	The activity's headline
%[name_resolver_view]p	UCM activities	A "best guess" view for resolving the names of versions in a change set
%[stream]Xp	UCM activities	The stream that contains the activity
%[versions]CQp	UCM activities	List of versions in activity's change set
%[view]p	UCM activities	The view that the activity is set in
%[activities]CXp	UCM baselines	The baseline's activities
%[bl_stream]Xp	UCM baselines	The stream in which the baseline is created
%[component]Xp	UCM baselines	The component associated with the baseline
%[components]CXp	UCM streams	The components for which the stream has foundation baselines
%[mod_comps]CXp	UCM streams	The modifiable components for which the stream has foundation baselines
%[non_mod_comps]CXp	UCM streams	The non-modifiable components for which the stream has foundation baselines
%[depends_on]Cp	UCM baselines	The baselines that the composite baseline directly depends on
%[depends_on_closure]Cp	UCM baselines	All of the baselines in the full dependence graph of a composite baseline
%[member_of]Cp	UCM baselines	The composite baselines of which the baseline is a direct member
%[member_of_closure]Cp	UCM baselines	All composite baselines of which the baseline is a direct or indirect member
%[label_status]p	UCM baselines	The label status of a baseline: full, incremental, unlabeled, no versions to label, or initially labeled
%[plevel]p	UCM baselines	The baseline's promotion level
%[predecessor]p	UCM baselines	The baseline's predecessor
%[initial_bl]Xp	UCM components	Initial baseline of the component
%[root_dir]p	UCM components	The root directory for the component
%[contains_folders]CXp	UCM folders	Subfolders of the folder
%[contains_projects]CXp	UCM folders	Projects contained by the folder
%[folder]Xp	UCM folders	The parent folder for the folder
%[def_rebase_level]p	UCM projects	The promotion level required of a baseline before it can be used as the source of a rebase operation
%[dstreams]CXp	UCM projects	The project development streams
%[folder]Xp	UCM projects	The parent folder for the project
%[istream]Xp	UCM projects	The project integration stream
%[mod_comps]CXp	UCM projects	The modifiable components for a project
%[model]p	UCM projects	The project's model
%[rec_bls]CXp	UCM projects	The recommended baselines of a project's integration stream
%[plevels]p	UCM PVOBs	The promotion levels defined by the PVOB
%[activities]CXp	UCM streams	Activities that are part of the stream
%[config_spec]p	UCM streams	Config spec of object
%[def_deliver_tgt]Xp	UCM streams	The default stream that the stream will deliver to
%[dstreams]CXp	UCM streams	The child streams of an integration stream or a development stream
%[found_bls]CXp	UCM streams	The foundation baselines for the stream
%[latest_bls]CXp	UCM streams	Latest baseline in each component in a stream's configuration
%[project]Xp	UCM streams	The project the stream is part of
%[read_only]p	UCM streams	read only if the stream is read-only, empty otherwise
%[rec_bls]CXp	UCM streams	The recommended baselines of an integration stream or a parent development stream
%[views]p	UCM streams	Views attached to the stream
%[policies]Cp	UCM streams and projects	Policies for a stream or project, in the form keyword setting, where keyword is a UCM policy keyword and setting is one of enabled or disabled.
%[latest_versions]CQNUp	UCM activities	List of the latest versions in an activity's change set. 'N' is optionally separate by new-line (same as for %[objects_protected]CQNp in Table 2). 'U' is a new modifier to display version in universal selector format (as detailed in Table 1 for %[universal_selector]p) and only applies to this new %[latest_versions]p specifier.

The variants in Table 4 apply only to objects in replicated VOBs (HCL VersionVault MultiSite product).

%[c]t

Starting column number: Starts printing at the column number specified in square brackets. An overflow condition exists if the current position on the line is beyond the starting column number. By default, when an overflow condition occurs, the %t directive is ignored. Variants:

%[c]Nt	When an overflow condition occurs, print a newline and resume printing at the starting column number.
%[c]St	When an overflow condition occurs, print one space before printing the next value.
%[c]Tt	When an overflow condition occurs, print a tab before printing the next value.

%u

Login name of the user associated with the event. Variants:

%Fu	Full name of the user. This information is taken from the password database.
%Gu	Group name of the user.
%Lu	Login name and group of the user, in the form user.group.

%%

Percent character (%).

A conversion specification can include an optional field width specifier, which assigns a minimum and/or maximum width, in characters, to the data field display. For example, the conversion specifier %10.15Lu will display, for each output line, the user's login name and group with a minimum of 10 characters (space padded if necessary) but not more than 15.

Usage rules:

• A single number is interpreted as a minimum width.
• To supply only a maximum width, put a decimal point before the number (for example, %.10En) or a zero and decimal point (%0.10En).
• To specify a constant display width, set the minimum and maximum widths to the same value (%20.20c).
• Values smaller than the specified minimum width are aligned on the right (padded left). A negative minimum width value (%–20.20c) aligns short values on the left.
• Values longer than the specified maximum width are truncated from the right. A negative maximum width value (%15.–15Sn) truncates long values from the left.
• A maximum width specifier has special meaning when used with the %Cl specifier. For example, %.5Cl prints a version's first five labels only, followed by "...".