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