VCS::CMSynergy::Helper - ancillary convenience functions
my $ccm_opts = VCS::CMSynergy::Helper::GetOptions;
This function extracts a set of common options from @ARGV and converts them to the corresponding options for "new" in VCS::CMSynergy. All options and arguments in @ARGV that it doesn't know about are left untouched.
@ARGV
It may be used to make all your CM Synergy scripts accept a uniform set of options:
use Getopt::Long; use Pod::Usage; use VCS::CMSynergy; use VCS::CMSynergy::Helper; ... # extract CM Synergy options from @ARGV my $ccm_opts = VCS::CMSynergy::Helper::GetOptions or pod2usage(); # process other options in @ARGV GetOptions(...) or pod2usage(); # start CM Synergy session my $ccm = VCS::CMSynergy->new( %$ccm_opts, RaiseError => 1, PrintError => 0); ...
The following options are recognized:
-D
--database
absolute database path; this option corresponds to option database for VCS::CMSynergy/start
database
VCS::CMSynergy/start
-H
--host
engine host; this option corresponds to option host for for VCS::CMSynergy/start
host
-U
--user
user; this option corresponds to option user for VCS::CMSynergy/start
user
-P
--password
user's password; this option corresponds to option password for for VCS::CMSynergy/start
password
--ui_database_dir
path name to which your database information is copied when you are running a remote client session; this option corresponds to option ui_database_dir for ccm start, it implies remote_client
ui_database_dir
remote_client
GetOptions returns a reference to a hash of options suitable for passing to "new" in VCS::CMSynergy. If no --database is specified
GetOptions
CCM_ADDR => $ENV{CCM_ADDR}
is added to the hash.
If any error is encountered during option processing the error is signalled using warn() and undef is returned.
warn()
undef
Note that all recognized single letter options are in uppercase so that scripts using VCS::CMSynergy::Helper::GetOptions still can use all lowercase letters for their own options.
VCS::CMSynergy::Helper::GetOptions
Here's the short description of recognized options that you can cut and paste into your script's POD:
CM Synergy Options: -D PATH | --database PATH database path -H HOST | --host HOST engine host -U NAME | --user NAME user name -P STRING | --password STRING user's password --ui_database_dir PATH path to copy database information to
To install VCS::CMSynergy, copy and paste the appropriate command in to your terminal.
cpanm
cpanm VCS::CMSynergy
CPAN shell
perl -MCPAN -e shell install VCS::CMSynergy
For more information on module installation, please visit the detailed CPAN module installation guide.