Changeset 12157 for trunk/psconfig/INSTALL

Timestamp:

Mar 1, 2007, 2:46:14 PM (19 years ago)

Author:

eugene

Message:

adding instruction, updating psconfig.bash

File:

• trunk/psconfig/INSTALL (modified) (2 diffs)

trunk/psconfig/INSTALL

@@ -7 +7 @@
 different installed versions or to recompile subsets of the IPP tree.
 
-NOTE: the psconfig.sh script uses the csh / tcsh shell. A bash version
-is not currently available.  
-
----
-
-Install Locations
+1. Set up the psconfig system.
+1.1 csh users
 
 To use the psconfig system, place the following line in your ~/.cshrc
@@ -31 +27 @@
 installations. 
 
-Using psconfig to set / examine your install system:
+1.2 bash users
 
-psconfig: set or show the current pslib configuration information
-USAGE: psconfig (version) : set configuration to specified version
-       psconfig --bin     : return the current path
-       psconfig --libs    : return the current library path
-       psconfig --list    : list currently availabe configuration versions
-       psconfig --help    : this listing
+Add the following line to your ~/.bashrc file:
 
----
+alias psconfig="source PATH/psconfig.bash"
 
-Building
+it is also necessary to edit the file psconfig.bash to set the INSTALL
+variable to this directory as well.
+
+2. Using psconfig to set / examine your install system:
+
+Before running or compiling the IPP, it is necessary to use psconfig
+to set the installation version:
+
+psconfig (version)
+
+This command sets aliases and environment variables for the current
+shell to point at the IPP installation labeled with the given version
+name and hardware architecture.  For example:
+
+psconfig default
+
+will set the PATH to include ~/psconfig/default.linux/bin on a 32-bit
+linux system, and the other paths to point at the corresponding
+installation directories.
+
+3. Dependencies
+
+3.1. External C libraries
+
+The program 'pschecklibs' in this directory will check for required
+system libraries and headers.  It examines the system libraries,
+libraries defined by LD_LIBRARY_PATH, and the installation library
+defined by psconfig.  Any missing dependencies will be listed.
+Tarballs for these libraries may be found on the Pan-STARRS web site
+at:
+
+http://pan-starrs.ifa.hawaii.edu/project/IPP/software/ext
+
+These should be installed so they will be available in the user's
+path.  The psconfig commands can be used to install these libraries in
+the psconfig location:
+
+'psautogen' replaces autogen.sh
+'psconfigure' replaces configure
+
+3.2 External Perl Modules
+
+The program 'pscheckperl' in this directory will check for required
+Perl modules, and can be used to install them in the appropriate user
+location in the psconfig system.  The command requires the name of an
+IPP distribution, eg:
+
+pscheckperl ipp-1.0 
+
+will test for the perl modules specified for the ipp 1.0 release.
+if any modules are missing, they can be download from the Pan-STARRS
+web site:
+
+http://pan-starrs.ifa.hawaii.edu/project/IPP/software/extperl
+
+The tarballs should be placed in a directory extperl parallel to the
+ipp directory (two levels up from this directory).  If the tarballs
+are in the correct location, they can be built by supplying the -build
+flag to pscheckperl:
+
+pscheckperl ipp-1.0 -build
+
+4. Building
 
 To build the full IPP tree using the psconfig system, run 'psbuild' in
-this directory, and provide a release version.  (NOTE: if you are
-building from a checked-out tarball, the CVS tags are not used, and
-you will not be able to use the update.
+this directory, and provide a distribution name.  The distributions
+define the set of IPP libraries and programs versions which go
+together.  NOTE: If we provide a tarball, it is appropriate to a
+specific version.  this should be automatically set as the default!
 
+psbuild ipp-1.0
+