INSTALL

   1
   2                           Installation Of Stem
   3
   4 Installing Stem is simple as you can use the classic module install
   5 commmands:
   6
   7 `       perl Makefile.PL
   8         make
   9         make test
  10         make install
  11
  12 The installation uses Module::Build so you have to have that. You can
  13 get it from CPAN. The Makefile actually just is a passthrough that calls
  14 the Build program and is there for compatibility. You can bypass make
  15 and use the Build commands directly:
  16
  17 on UNIX flavors do this:
  18
  19         perl Build.PL
  20         Build
  21         Build test
  22         Build install
  23
  24 on Windows do this:
  25
  26         perl Build.PL
  27         perl Build
  28         perl Build test
  29         perl Build install
  30
  31 The perl Makefile.PL or perl Build.PL command will query you for a
  32 short series of answers. These include where is perl, where to store the
  33 Stem executable scripts, where to store the Stem configuration files,
  34 etc. Each question will be explained in detail and has a reasonable
  35 default value.
  36
  37 Stem has a set of demonstration applications and you will be asked if
  38 you want to install them. The driver scripts use xterm to
  39 bring up multiple windows so you can interact with the
  40 demonstrations. The Build.PL script will find xterms on most UNIX
  41 flavors that have X on them. OSX doesn't come with X by default but you
  42 can install the X cdrom if you want.
  43
  44 NOTE: The xterm program is NOT required to run the demostrations. You
  45 can run the scripts and the commands which create the xterms will be
  46 printed. If you don't have xterms, they will fail but you can copy the
  47 Stem command (the part after the -e) and run them in terminal windows
  48 that you bring up yourself. This works on windows and OSX which doesn't
  49 have X installed. Just run those Stem commands in the order they are
  50 printed and each one in its own terminal window.
  51
  52 Another option for the demo scripts is called ssfe (split screen front
  53 end). It is a general purpose C (UNIX only) utility that runs any
  54 command and provides command line editing and history. It is a nice
  55 little utility and it make running the demos a bit nicer. It is bundled
  56 in a IRC application call sirc and if you ask for it to be installed,
  57 the whole sirc package (just ssfe and sirc) will be built and
  58 installed. This build/install will be run in its own xterm. When it is
  59 done installing, it will sleep for a while. You can kill the xterm
  60 window or ^C in it and the rest of the Stem installation will continue.
  61
  62 The installation answers you give will be stored in the module
  63 Stem::InstallConfig for use by any Stem application. This module is used
  64 by Build.PL to override the default installation answers. So the next
  65 time you do perl Build.PL you will see the previous choices you made as
  66 the defaults. Doing Build realclean will remove this module and you will
  67 see the original default answers.
  68
  69 If you know the default answers are fully acceptable, you can do this:
  70
  71         perl Build.PL use_defaults=1
  72
  73 and all the defaults will be used and no questions will be asked.