View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
David Boyce > ClearCase-SyncTree > synctree


Annotate this POD


New  3
Open  0
View/Report Bugs


synctree - Normalize a tree of flat files with a tree of ClearCase elements


  synctree -sbase /tmp/newcode -dbase /vobs_tps/xxx

Take all files located under /tmp/newcode, remove the leading "/tmp/newcode" from each of their pathnames, and place the remaining relative paths under "/vobs_tps/xxx" as versioned elements, leaving them checked out.

  synctree -cr -yes -ci -sbase /vobs/hpux/bin -dbase /vobs_rel/hpux/bin

Sync all files under "/vobs_rel/hpux/bin" with those in "/vobs/hpux/bin", making sure to preserve their CR's. Suppress interactive prompting and check in all work when done.

  synctree -sb /A/B -db /X/Y -map /A/B/foo /X/Y/bar /A/B/here /X/Y/there

Take 'foo' from directory /A/B and check it in as 'bar' in /X/Y. Similarly, create an element /X/Y/there with the contents of /A/B/here.


Synctree brings a VOB area into alignment with a specified set of files from a source area. It's analogous in various ways to clearfsimport, citree, and clearexport/clearimport; see the COMPARISONS section below. Synctree is useful if you have a ClearCase tree that must be kept in sync with a CVS tree during a transition period, or for overlaying releases of third-party products upon previous ones, or exporting deliverable DO's from a nightly build to a release VOB while preserving config records (CR's) and labels, or similar.

The default operation is to mkelem all files which exist in <src> but not in <dest>, modify any files which exist in both but differ, but not to remove files which are present in <dest> and not in <src>. Adding the -rmname flag will cause this removal to happen as well and thus make the <src> and <dest> areas identical.

Synctree need not run in a view context itself but the directory named by the -dbase flag must provide a view context. The branching behavior of any checkouts performed will be governed by that view's config spec. The -dbase directory need not exist, as long as it lies under a mounted VOB tag and in a view context. In other words, synctree can auto-create the destination directory tree.

The list of source files to operate on may be provided with the -flist option or it may come from @ARGV. Any directories encountered on the command line will be traversed recursively. If no source-file-list is provided, the directory specified with -sbase is used as the default.

File paths may be given as relative or absolute. Destination paths are determined as follows: all source filenames are first turned into absolute paths if necessary, then the source preface given with the -sbase parameter is removed and replaced with the value of -dbase to produce the destination pathname (but see FILE MAPPING below).

ClearCase symbolic links are supported, even on Windows. Note that, unless you use the -rellinks flag, the text of the link is transported verbatim from source area to dest area; thus relative symlinks may no longer resolve in the destination area.

Consider using the -n flag the first time you use this on a valued VOB, even though nothing irreversible (rmelem, rmbranch, rmver, rmtype, etc.) is ever done by synctree. And by the same token use -yes and -ci with care.


Not all options are described here, only those requiring elaboration beyond the -help summary. Run synctree -help for a full option summary.


Synctree has lots of support for remapping filenames. The options can be pretty confusing and thus deserve special treatment here.

Filename mapping is enabled with the -map flag. Without -map, a list of files provided on the command line is interpreted as a set of from files; their to paths are derived via s/^sbase/dbase/ and thus the file basenames cannot change. In the presence of -map the arguments are instead interpreted as a hash alternating from and to names. Thus

  synctree -sb /etc -db /vobs_st/etc /etc/passwd /etc/group

would make two files under /vobs_st/etc called passwd and group, whereas

  synctree -sb /etc -db /vobs_st/etc -map /etc/passwd /vobs_st/etc/foo

would create one file (/vobs_st/etc/foo) which is a copy of /etc/passwd. Alternatively the mapping may be specified with a literal =>:

  synctree -sb /etc -db /vobs_st/etc -map '/etc/passwd => /vobs_st/etc/foo' ...

but note that this must be quoted against shell expansion. The => style is also allowed in files specified via -flist, thus:

  synctree -sb /etc -db /vobs_st/etc -flist - << EOF
  /etc/passwd => /vobs_st/etc/foo
  /etc/group  => /vobs_st/etc/bar


Synctree is comparable to citree and clearfsimport. It is similar to citree but has more options and runs on both Windows (including Cygwin) and UNIX. It has the following advantages over clearfsimport:

However, unless you need one of the above features the supported, integrated solution (clearfsimport) is generally preferable. And of course some of these features may eventually be supported by clearfsimport; check current documentation.



The special flag -/dbg=1 will cause all underlying cleartool commands to be printed as they are run (this is actually a feature of the Argv module on which synctree is built). Please run in this mode and include all output when reporting problems.

Note also the -/ipc=1 flag, which uses a common background cleartool process, for improved performance. In this mode, cleartool commands are prefixed with =&gt; instead of the default +.


David Boyce <dsbperl AT>


Copyright (c) 2000-2010 David Boyce. All rights reserved. This Perl program is free software; you may redistribute and/or modify it under the same terms as Perl itself.


perl(1), "perldoc ClearCase::SyncTree"

syntax highlighting: