1
2        ____           _
3    ___|  _ \ ___ _ __| |
4   / _ \ |_) / _ \ '__| |
5  |  __/  __/  __/ |  | |
6   \___|_|   \___|_|  |_|
7
8  ePerl -- Embedded Perl 5 Language
9
10  Installation
11  ============
12
13  OVERVIEW FOR THE IMPATIENT
14  ==========================
15
16  To install the stand-alone program into /path/to/eperl/root/{bin,man}/:
17
18      $ ./configure --prefix=/path/to/eperl/root
19      $ make
20      $ make test
21      $ make install
22
23  To install the integrated Perl 5 modules into
24
25    a) your existing Perl system under
26       /path/to/existing/perl/area/lib/site_perl/{Parse,Apache}/:
27
28      $ perl Makefile.PL
29      $ make
30      $ make test
31      $ make install
32
33    b) a private area of your own under
34       /path/to/your/perl/area/lib/site_perl/{Parse,Apache}/:
35
36      $ perl Makefile.PL PREFIX=/path/to/private/perl/area/
37      $ make
38      $ make test
39      $ make install
40
41
42  DETAILED DESCRIPTION
43  ====================
44
45  1. Requirements
46     ------------
47
48     Make sure you have a up-to-date release of Perl already installed on your
49     system. Perl 5.004 is highly recommended to make use of the complete
50     ePerl functionality.  Previous releases are only supported partially: for
51     the stand-alone program you need at least Perl 5.003 compiled with
52     -DEMBED while for the Perl 5 interface modules you need at least Perl
53     5.003_90. Also make sure (``perl -V | grep sfio'')that your
54     Perl-Interpreter doesn't use PerlIO in combination with SfIO, because
55     this currently is not supported by ePerl.
56
57     As a summary the following table shows the details of support grade:
58
59         Perl               stand-alone        Perl 5
60         version            ePerl program      interface modules
61         ------------------ ------------------ -----------------
62         5.003              no                 no
63         5.003+-DEMBED      yes (minimum)      no
64         5.003_01-5.003_25  yes (minimum)      no
65         5.003_25-5.003_99  yes                yes
66         5.004              yes                yes
67         5.005-...          still untested     still untested
68
69  2. Configuring the source
70     ----------------------
71
72     The ePerl distribution is a hybrid source tree. It can be used to either
73     install the stand-alone program "eperl" or the Perl 5 interface modules
74     "Parse::ePerl" and "Apache::ePerl". Decide which one you want or just
75     install both.
76
77     First make sure that the ``perl'' program is in your path, so
78     ``configure'' can find it. If you have different Perl binaries in your
79     path the one with the latest version number will be used. If you want to
80     force ePerl to be build with a specific Perl on your system (if you have
81     more then one installed), you can also use option
82     ``--with-perl=/path/to/bin/perl'' with ``configure'' or specify this
83     specific one when running "Makefile.PL".
84
85     Additionally you need a real ANSI C compiler like GCC to compile ePerl,
86     but most of the vendor compilers also work. Per default the C compiler is
87     used which was used for compiling your Perl itself.  To overwrite this
88     use ``CC=/path/to/bin/cc''.
89
90     Now do _ONLY ONE_ of these steps:
91
92     a) Configure the ePerl source via standard GNU conding style procedure
93        for building the stand-alone program:
94
95        $ [CC=/path/to/bin/cc] ./configure --prefix=/path/to/eperl/root
96                                           [--with-perl=/path/to/bin/perl]
97
98     b) Configure the ePerl sources via standard MakeMaker procedure
99        for building the Perl 5 interface modules:
100
101        $ [/path/to/bin/]perl Makefile.PL [PREFIX=/path/to/private/perl/area/]
102                                          [CC=/path/to/bin/cc]
103
104  3. Build the object files
105     ----------------------
106
107     Now you are ready to run the build process. Start it with a simple
108     ``Make'' call:
109
110        $ make
111
112  4. Run the Test suite
113     ------------------
114
115     You can now run a test suite which will check if the programs work
116     correctly before they get finally installed. I highly recommend you to do
117     this step, even it is optional and not really required.
118
119        $ make test
120
121  5. Installation
122     ------------
123
124     Finally install ePerl into /path/to/eperl/root/{bin,man}/
125     (in case of the stand-alone program) or
126     /path/to/private/perl/area/lib/site_perl/{Parse,Apache}/
127     (in case of the Perl 5 interface modules).
128     _NO_ third-party files are changed on your system.
129
130        $ make install
131
132  6. Cleanup
133     -------
134
135     Now cleanup the source tree to make it a vanilla distribution again.
136
137        $ make distclean
138
139