Splicer 2.2                   May, 1997

#######################################################################

The Splicer package contains the following files and directories:
..................................................................
  files:

  README
  install.splicer_ver22.
..................................................................

  directories:

  splicer_code_ver2.2   Splicer and hsplicer source code and
                        their makefiles

  splicer_bin_ver2.2    Splicer executable: splicer-main-c
                        Splicer's help executable: hsplicer-c.
                        shell script: splicer.
                        defaults file: .splicerdefaults.
                        splicer's color names: color-name-list.
                        Splicer's logo executable: splicerLogo-main-c.

  splicer_help          help text files

  splicer_testdata      various test data sets

  splicer_logo_code     splicer logo code and makefile
..................................................................

  These files and directories should be put in a directory
  accessible to all splicer users. A good policy is to name this
  directory "splicer". It will be referred to as such for
  the remainder of this README.
  Do not rename any of the files or directories described above.

#########################################################################

General Info:

  Splicer is a X11/Motif program designed to run on Sun workstations
  using SunOS 5.5 (solaris) and either OpenWindows, Motif(mwm) or CDE(dtwm)
  window managers.

  All you will need to run Splicer are the files in the directory
  splicer_bin_ver2.2 and the directory splicer_help. The code
  directories splicer_code_ver2.2 and splicer_logo_code are provided
  in case Splicer needs to be recompiled. The file install.splicer_ver2.2
  will do all the steps required to do the recompiling. A test data set is
  also included.

  splicer-main-c is the executable that launches the main program. This
  program  uses two other executables, hsplicer-c and splicerLogo-main-c.
  The program also accesses the files in directory splicer_help and a
  file of color names (color-name-list) in directory splicer_bin_ver2.2.

  A shell script, called "splicer", has beed provided to simplfy running
  splicer. It sets the pathways to the executables and files that Splicer
  needs. It also launches the program and sets Splicer's foreground and
  background colors.

  Splicer also uses a file named .splicerdefault which stores various
  values associated with input/output such as data format and type,
  paths and filenames, cull, smooth and decimate settings. It also saves
  your color choices.
  When Splicer is launched it reads .splicerdefaults and uses these values
  to configure the Splicer running envirnment.
  When Splicer is exited it overwrites the .splicerdefaults with the most
  recent running environment variables.
  .splicerdefaults is always located in the directory from which Splicer
  is launched.

  Splicer has help buttons for all of its operations. And it has a
  convenient help menu in the upper right corner of the main window.
  Look to the help menu and help buttons for useful imformation on
  how splicer functions.

############################################################################

Getting started:

  Customizing your shell script splicer

    Copy the shell script splicer from the directory splicer_bin_ver21.
    to the directory you will run Splicer from (from now on refered to as
    your work directory). Make the following changes to this file to
    customize the application for your work environment.

     a) if needed, change the LD_LIBRARY_PATH from /usr/lib to the
        location of the X11R5 runtime libraries. /usr/lib is the normal
        location for these files and it is not likely that it will
        need to be changed.

     b) Change the SPLICER_HELPFILES_PATH to the full path name of the location
        of the splicer_help directory. example:
            /usr/local/splicer/splicer_help
        It contains the text help files used by the splicer help program and
        must be accessable from where the program is to be run.

     c) Change the SPLICER_HELP_PATH to the full path name of the location
        of the splicer_bin_ver2.2 directory. This is the location of the
        executable hsplicer-c.

     d) Change the SPLICER_LOGO_PATH to the full path name of the location
        of the splicer_bin_ver2.2 directory. This is the location of the
        executable splicerLogo-main-c.

     e) Change the SPLICER_COLOR_PATH to the full path name of the location
        of the splicer_bin_ver2.2 directory. This is the location of the
        file color-name-list.

     f) Change /home/ibex/eqt/splicer/splicer_code_ver2.2/splicer-main-c
        to the correct location of the executable splicer-main-c.
        splicer-main-c is in the directory splicer_bin_ver2.2.
        Note that this is the full path and name not just the path.

     g) the arguments following the program name (splicer-main-c) control
        the background (-bg) and foreground (-fg) colors of splicer.
        You may change them to any valid color name. A listing of the X11
        color set will most likely be in /usr/lib/X11/rgb.txt. Or look
        at the file color-name-list in directory splicer_bin_ver2.2.
        It is a subset of rgb.txt.

    Now you can launch splicer by simply going to your work directory and
    typing splicer. Be aware that an alias to
    ... /splicer/splicer_bin_ver2.2/splicer will cause it to be used
    and not the version in your work directory.

    Creating your own .splicerdefaults file:

    The first time you run Splicer it will create the .splicerdefaults file
    using its default values. This file will be placed in your work directory.
    From then on Splicer will read this file when it is launched , preserving
    the 'settings' of your last session with Splicer.

    .splicerdefaults saves the following
      -Data type and format type.
      -All pathways to open and save files.
      -Cull values for all data types.
      -Smooth and decimate settings.
      -color choices.
        [Note that the value CLIP is not currently in use.
         Do not change its value from 0.]

     Note that it is not a good idea for you to copy the .splicerdefaults
     file that is in the directory splicer_bin_ver2.2 to your work directory 
     since the paths in this file will be meaningless in your environment.
     It is provided only as an example.

#############################################################################

Installing (compiling) Splicer:

  If Splicer needs to be recompiled for SunOS 5.5 (Solaris):

    cd to the directory splicer and type install.splicer_ver2.2.
    Be sure the files and directories in splicer have not been
    renamed or removed.
    If you get a permission denied error chmod on install.splicer_ver21.
    to executable (chmod +x install.splicer_ver2.2).

  If you are using a system other than solaris:

    You must have the complete X11R5 and motif include and lib directories
    to compile splicer. And, before running install.splicer_ver2.2, the
    makefiles for splicer, hsplicer and splicerLogo must be change to
    the correct paths to these directories.

###########################################################################

Miscellany:

  If using Sun Solaris CDE (Common Desktop Environment);
    The Dtwm window manager's policy, by default, is to bring a window
    forward when you click any where in it. This makes Splicer very
    annoying to use.
    Add the following line to your .Xdefaults file.

    Dtwm*FocusAutoRaise:    False

    This will stop the popup dialogs from going behind Splicer's main
    window. You will still be able to bring any window forward with a
    click in the title bar.

  Color allocation failure:
    Some programs, for instance Netscape, gobble up a lot of colors and
    fill the 'color map'. The effect is that Splicer cannot allocate its
    own colors. If this happens to you exit the offending program.

  Solaris:
    Sun provides a package of 'fixes' for system bugs it calls patches.
    The following Sun system patch caused runtime problems with Splicer:

    'motif runtime lib patch'  /system/jumpstart/ldeo/patch-2.5/103186-21

    When the patch was removed Splicer was fine.

#############################################################################

Whom to contact:

  Peter B. deMenocal
  Lamont-Doherty Earth Observatory
  Palisades, NY 10964
  (914) 365-8483 (direct dial)
  (914) 365-2312 (fax)
  peter@lamont.columbia.edu

  Ann G. Esmay
  Lamont-Doherty Earth Observatory
  Palisades, NY 10964
  eqt@lamont.columbia.edu


