install.pod

   1 =pod
   2
   3 =head1 Installation Instructions for C<vss2svn.pl>
   4
   5 =head2 INSTALLATION
   6
   7 =head3 vss2svn.pl Script
   8
   9 There is no installation routine for the script itself; simply copy it to any folder such as C<C:\vss2svn>.
  10
  11 =head3 Perl Interpreter
  12
  13 In order to run this script, you must have a fairly recent version of Perl. Only Windows platforms are supported, since that is where the ss.exe executable is located. Actually, the SourceSafe client has indeed been ported to Unix and MacOS, and this script would probably run on those platforms with little modification, but such use is unsupported.
  14
  15 The latest build of ActiveState Perl 5.8 is highly recommended. It is available for free (both as a Windows Installer package and a .tar.gz archive) at:
  16
  17 L<http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl>
  18
  19 If using the Windows Installer version, be sure to specify that you want the location of the Perl executable added to your PATH.
  20
  21 =head3 Required Perl Modules
  22
  23 This script depends on the following Perl modules. All but the first three are included as part of the base ActiveState Perl install.
  24
  25 =over 4
  26
  27 =item * DBI
  28
  29 =item * DBD::SQLite
  30
  31 =item * Time::ParseDate (install "Time-modules" from PPM)
  32
  33 =item * Getopt::Long
  34
  35 =item * Cwd
  36
  37 =item * File::Path
  38
  39 =item * Pod::Usage
  40
  41 =item * Text::Wrap
  42
  43 =item * Win32::TieRegistry
  44
  45 =back
  46
  47 =head3 Installing DBI and DBD::SQLite
  48
  49 The easiest way to install the C<DBI> and C<DBD::SQLite> modules is using ActiveState's C<ppm> (programmer's package manager) utility. ActivePerl must already be installed before running C<ppm>. From the Command Prompt, type C<ppm>, or, if using ActivePerl 5.6, C<ppm3>. (Older versions of ActivePerl probably use just C<ppm>, but the syntax may be a bit different).
  50
  51 You should be able to type just C<install DBI>, C<install DBD::SQLite>, and C<install Time-modules> from the C<ppm> prompt. Alternatively, you can perform each install as a separate C<ppm> command, such as C<ppm install DBI>.
  52
  53    ppm> install DBI
  54    ====================
  55    Install 'DBI' version 1.42 in ActivePerl 5.8.3.809.
  56    ====================
  57    Downloaded 508164 bytes.
  58    Extracting 69/69: blib/arch/auto/DBI/Driver_xst.h
  59    Files found in blib\arch: installing files in blib\lib into architecture
  60    dependent library tree
  61    Successfully installed DBI version 1.42 in ActivePerl 5.8.3.809.
  62
  63    ppm> install DBD::SQLite
  64    ====================
  65    Install 'DBD-SQLite' version 0.31 in ActivePerl 5.8.3.809.
  66    ====================
  67    Downloaded 125388 bytes.
  68    Extracting 10/10: blib/arch/auto/DBD/SQLite/SQLite.lib
  69    Files found in blib\arch: installing files in blib\lib into architecture
  70    dependent library tree
  71    Successfully installed DBD-SQLite version 0.31 in ActivePerl 5.8.3.809.
  72
  73    ppm> quit
  74
  75 =head3 Setting up your PATH
  76
  77 You should now be able to run C<vss2svn.pl>. The Visual SourceSafe C<ss.exe> command, the Subversion C<svn.exe> command, and C<perl> should all be in your PATH. To check for this, issue the following three commands from the Command Prompt in the directory where C<vss2svn.pl> is located. To open a Windows Command Prompt, choose C<Run> from the Start Menu (or press Windows Key + R) and type C<cmd>.
  78
  79   C:\vss2svn> ss help
  80   C:\vss2svn> svn help
  81   C:\vss2svn> perl -v
  82
  83 All three should return with some status information about the version you have installed. If you get an error message instead, modify your PATH environment variable (from Control Panel, choose System, Advanced, Environment Variables or something similar; it doesn't matter whether you use the User or System PATH variable, as they will be merged). While you are there, ensure the C<SSDIR> environment variable points to the root of your VSS database (wherever the F<srcsafe.ini> file is located). After changing these settings, you must close and re-open your Command Prompt.
  84
  85 If you are using ActivePerl 5.6, you may receive a C<DBD::SQLite> fatal error when the script is first run. In that case, try using our pre-built C<DBD::SQLite> binary files instead, available at:
  86
  87 L<http://vss2svn.tigris.org/servlets/ProjectDocumentList?folderID=2788>
  88