Rational ClearCase Commands Referenceannotate
apropos
catcr
catcs
cc.icon
cc.magic
cd
chactivity
chbl
checkin
checkout
checkvob
chevent
chflevel
chfolder
chmaster
chpool
chproject
chstream
chtype
chview
clearaudit
clearbug
cleardescribe
cleardiffbl
cleardiff
clearexport_ccase
clearexport_cvs
clearexport_pvcs
clearexport_rcs
clearexport_sccs
clearexport_ssafe
clearfsimport
cleargetlog
clearhistory
clearimport
clearjoinproj
clearlicense
clearmake
clearmake.options
clearmrgman
clearprojexp
clearprompt
cleartool
clearviewupdate
clearvobadmin
comments
config_ccase
config_spec
cptype
credmap
creds
deliver
describe
diffbl
diffcr
diff
dospace
edcs
endview
env_ccase
events_ccase
export_mvfs
exports_ccase
file
find
findmerge
fmt_ccase
getcache
get
getlog
help
hostinfo
init_ccase
ln
lock
lsactivity
lsbl
lscheckout
lsclients
lscomp
lsdo
lsfolder
lshistory
ls
lslock
lsmaster
lspool
lsprivate
lsproject
lsregion
lsreplica
lssite
lsstgloc
lsstream
lstype
lsview
lsvob
lsvtree
makefile_aix
makefile_ccase
makefile_gnu
makefile_pmake
makefile_smake
makefile_sun
man
merge
mkactivity
mkattr
mkattype
mkbl
mkbranch
mkbrtype
mkcomp
mkdir
mkelem
mkeltype
mkfolder
mkhlink
mkhltype
mklabel
mklbtype
mkpool
mkproject
mkregion
mkstgloc
mkstream
mktag
mktrigger
mktrtype
mkview
mkvob
mount_ccase
mount
msdostext_mode
mvfslog
mvfsstorage
mvfstime
mvfsversion
mv
omake
pathnames_ccase
permissions
profile_ccase
promote_server
protect
protectvob
pwd
pwv
query_language
quit
rebase
recoverview
reformatview
reformatvob
register
relocate
rename
reqmaster
reserve
rgy_backup
rgy_check
rgy_passwd
rgy_switchover
rmactivity
rmattr
rmbl
rmbranch
rmcomp
rmdo
rmelem
rmfolder
rmhlink
rmlabel
rmmerge
rmname
rmpool
rmproject
rmregion
rmstgloc
rmstream
rmtag
rmtrigger
rmtype
rmver
rmview
rmvob
schedule
schemes
scrubber
setactivity
setcache
setcs
setplevel
setsite
setview
shell
snapshot.conf
softbench_ccase
space
startview
type_manager
umount
uncheckout
unlock
unregister
unreserve
update
version_selector
view_scrubber
vob_restore
vob_scrubber
vob_sidwalk
vob_snapshot
vob_snapshot_setup
wildcards_ccase
winkin
xclearcase
xcleardiff
xmldiffmrg
APPLICABILITY
| Product | Command type |
|---|---|
| ClearCase | cleartool subcommand |
| ClearCase LT | cleartool subcommand |
| MultiSite | multitool
subcommand multiutil subcommand |
DESCRIPTION
This command displays a reference page, the table of contents for the online documentation, or the product tutorial. The documentation that is displayed depends on the command context.
This command does not require a product license.
Displaying Reference Pages
The man command displays a specified online reference page in HTML or ASCII (UNIX only) formats. For cleartool and multitool subcommands, you can use any valid command abbreviation or alias. For example:
| cmd-context man lscheckout | Abbreviation |
| cmd-context man lsch | Full command name |
| cmd-context man lsco | Alias |
UNIX—Using MANPATH
Reference pages are stored in subdirectories of ccase-home-dir/doc/man. The man subcommand modifies the environment to include a MANPATH variable set to this directory. It then executes the UNIX man(1) command in a subprocess. Thus, the shell from which you invoke cleartool need not have MANPATH set.
If, however, you want to use UNIX man directly, without going through cleartool or multitool, include ccase-home-dir/doc/man in your MANPATH. For example:
With UNIX man, you must match the reference page file name. The file names of cleartool subcommands have a ct+ prefix. The file names of multitool and multiutil subcommands have mt+ and mu+ prefixes, respectively.
| % man ct+describe | Correct |
| % man mt+syncreplica | Correct |
| % man clearmake | Correct (not a cleartool subcommand) |
| % man describe | Incorrect (cleartool subcommand) |
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.