apropos

Displays command summary information

APPLICABILITY

SYNOPSIS

• Extract information from the standard whatis file:

apr·opos topic ...

• Extract information from auxiliary whatis file:

apr·opos -glo·ssary [ topic-args ]

DESCRIPTION

This command does not require a product license.

The apropos command extracts information from the product-specific whatis file in ccase-home-dir/doc/man/. Use apropos as you use the standard UNIX whatis(1) or apropos(1) command. Alternatively, use the -glossary option to extract a glossary definition or other help information from the auxiliary whatis file.

RESTRICTIONS

None.

OPTIONS AND ARGUMENTS

Default: A lookup is performed in the standard whatis file.

topic ...

apropos makes a separate search for each topic character string in the standard whatis file. The string can occur anywhere within the line.

-glo·ssary [ topic-args ]

Combines all topic-args into a single character string, then displays all sections in the auxiliary whatis file whose header lines include this character string. Omitting the topic-args causes the entire auxiliary file to be displayed.

EXAMPLES

• Search for lines with the string "reserve" in the whatis file.

cleartool apropos reserve
reserve                  Convert an unreserved checkout to reserved
unreserve                Change a reserved checkout to unreserved

• Search for lines with the string "epoch" in the standard MultiSite whatis file.

multitool apropos epoch

chepoch    change epoch information
lsepoch    display epoch information

• Search in the auxiliary whatis file for glossary terms that include the phrase "symbolic link."

cleartool apropos -glossary symbolic link
+++ VOB symbolic link
An object, cataloged in a (version of a) directory element, whose
contents is a pathname. ClearCase does not maintain a version history
for a VOB symbolic link.

FILES

ccase-home-dir/doc/man/cc_whatis
ccase-home-dir/doc/man/cc_whatis.aux
ccase-home-dir/doc/man/ms_whatis
ccase-home-dir/doc/man/ms_whatis.aux

SEE ALSO

help, man