1 If you read this file _as_is_, just ignore the funny characters you see.
2 It is written in the POD format (see pod/perlpod.pod) which is specially
3 designed to be readable as is.
7 Install - Build and install wxPerl
9 =head1 wxPerl installation
11 ************************************************************************
12 You need to install wxWidgets 2.5.3 or later before you can compile wxPerl.
13 For UNIX systems look at the section "INSTALL wxWidgets"; for Win32
14 systems, detailed build instructions for wxWidgets + wxPerl are included
15 in the section "COMPILING UNDER WIN32"; for Mac OS X, refer to
16 "INSTALL wxWidgets", and then to "USING wxPerl on MAC OS X"
17 ************************************************************************
19 =head1 Quick installation
21 This applies to UN*X systems, and only if wxWidgets 2.5.3 or later is already
22 compiled and installed.
24 # unpack the wxPerl archive
25 tar xzvf Wx-0.xx.tar.gz
27 perl Makefile.PL # (1)
32 1) see below for a way to specify a different installation directory
34 2) under Windows you may need to use nmake, or another *make
36 3) you may also want to do
42 against the samples in the 'samples' subdirectory, and
48 4) you may need Administrator/root privileges to install
50 =head1 Additional flags to Makefile.PL
52 In addition to ExtUtils::MakeMaker flags wxPerl Makefile.PL accepts
56 Currently only under Win32 or GCC
57 adds debugging information to the library
59 --extra-libs={extra libraries}
61 Adds extra libraries to the link command line
63 --extra-cflags={extra compiler flags}
65 Adds extra compiler flags to compiler line
69 Show the full list of options
71 =head1 Installing wxWidgets (on UNIX systems and Mac OS X)
73 wxWidgets 2.5.3 or later is required for wxPerl to work.
75 For UNIX systems only. If you are using prepackaged wxWidgets binaries you
76 need to install the -dev and -contrib-dev packages in order to compile
77 wxPerl, otherwise you just need the main package and the -contrib package.
78 If you are compiling wxWidgets yourself, the quick way is:
87 If something goes wrong, please refer to the wxWidgets
88 installation instructions.
90 =head1 Installing under Win32
92 This wxPerl version was tested with MinGW 3.0 and MS Visual C++ 5.
93 Older MinGW versions (from 1.1 onwards) and newer versions will likely work.
94 For the remainder of this section I'll assume that your Perl is installed
97 =head2 MS Visual C++ 5 (wxWidgets 2.5.x), MS Visual C++ 6 SP4 (wxWidgets 2.5.x)
99 wxWidgets 2.5.3 or later is required for wxPerl to work.
101 Build wxWidgets as a dll
103 cd z:\path\to\wx\build\msw
104 nmake -f makefile.vc SHARED=1 BUILD=release
105 cd ..\..\contrib\build\stc
106 nmake -f makefile.vc SHARED=1 BUILD=release
109 set WXDIR=z:\path\to\wx
110 set WXWIN=z:\path\to\wx
117 To build a debugging wxPerl, follow the instructions above passing
118 BUILD=debug DEBUG_RUNTIME_LIBS=0 to wxWidgets makefile and --debug
121 =head2 MinGW 1.1 or later (wxWidgets 2.5.x)
123 wxWidgets 2.5.3 or later is required for wxPerl to work.
125 Get MinGW from http://www.mingw.org/ ; choose the all-in-one
126 package (downloading the individual packages will work but requires
127 you knowing how to install them). MSYS is not required.
129 If you want to compile wxPerl against ActivePerl using MinGW,
130 you ned to first download and install ExtUtils::FakeConfig from
131 http://wxperl.sourceforge.net/ap_mingw/ ; then just replace the
132 "perl Makefile.PL" with "perl -MConfig_m Makefile.PL". If you built
133 Perl from sources, you don't need this additional step.
135 Build wxWidgets as a dll
137 cd z:\path\to\wx\build\msw
138 make -f makefile.gcc SHARED=1 BUILD=release
139 cd ..\..\contrib\src\stc
140 make -f makefile.gcc SHARED=1 BUILD=release
143 # get dmake from http://www.cpan.org/authors/id/GSAR/dmake-4.1pl1-win32.zip
144 set WXDIR=z:\path\to\wx
145 set WXWIN=z:\path\to\wx
152 To build a debugging wxPerl, follow the instructions above passing
153 BUILD=debug to wxWidgets makefile and --debug to Makefile.PL.
155 =head1 Specifying the installation path
157 If you don't want to install wxPerl as a system module, you must
158 specify a different installation path. With recent ExtUtils::MakeMaker
159 you can do this by using
161 perl Makefile.PL PREFIX=path
163 On older ExtUtils::MakeMaker version the correct incantation
166 =head1 Using wxPerl on Mac OS X
168 The 'perl' executable shipped with your OS can't be used to run executables
169 that interact with the GUI, hence you need to use the special 'wxPerl'
170 executable created by wxPerl.
174 =head2 Problems compiling XRC and/or STC
176 Usually they start like this:
178 STC.c:33:24: wx/stc/stc.h: No such file or directory
180 and go ahead with many compilation errors.
181 This usually means you did not install wxWidgets' 'contrib' libraries;
182 either install them or disable STC/XRC passing --disable-stc --disable-xrc
187 wxPerl needs a C++ compiler to build. By default it will use
188 the C++ compiler that was used to compile wxWidgets; this can cause
189 problems if Perl was compiled with a C compiler of a different brand.
190 For example if you compile Perl with GCC and wxWidgets with ICC or
191 Perl with Sun C compiler and wxWidgets with G++ you will most likely
192 not be able to compile wxPerl. Exceptions are: under Windows you can
193 use ActivePerl (compiled with MS Visual Studio) and wxWidgets compiled
194 with MinGW by using ExtUtils::FakeConfig, under Solaris a similar
195 tool exists for Sun C Compiler -> GCC/G++ compilation.