README_win32.pod

   1 # $Id$
   2
   3 This file is best viewed with "perldoc README.win32".
   4
   5 =head1 NAME
   6
   7 README.win32 - Parrot under Windows
   8
   9 =head1 SYNOPSIS
  10
  11 These are instructions for building the "native" port of Parrot under
  12 Windows 2000/XP on the Intel x86 architecture.
  13
  14 =head1 DESCRIPTION
  15
  16 Win32 "native" ports require no additional software to run but the
  17 operating system.  There should be other READMEs for (emulation)
  18 systems that run on Win32, eg Cygwin.
  19
  20 Native compilers include:
  21
  22        Borland C++ (bcc)                version xxx or later
  23        Microsoft Visual C++ (cl)        version 13.10.3077 or later
  24        MinGW32 with GCC (gcc)           version 3.4.2 or later
  25        Intel C++ (icl)                  version 8.0.48 works
  26
  27 =head2 Setting Up Parrot
  28
  29 =over
  30
  31 =item Make
  32
  33 You need "nmake" to build Parrot under Windows with Microsoft compilers.  It
  34 should be available via Microsoft Visual Studio .NET 2003 or the Microsoft .NET
  35 Framework SDK 1.1.  Download the latter from the Microsoft .NET Framework
  36 Homepage L<http://msdn.microsoft.com/netframework/>.
  37
  38 Note: Parrot will not build using nmake v1.5 from the MS web site.  Download
  39 one of the above toolkits to obtain a later version, either v7 or v8.
  40
  41 MinGW works with its GNU "make" (v 3.81) port and its name is
  42 'mingw32-make.exe'.  If you also have the Minimal SYStem (MSYS) installed,
  43 you will need to remove the Msys/bin folder from your PATH environment
  44 variable before calling "perl Configure.pl" and mingw32-make.  Perl detects
  45 and calls /bin/sh.exe, if found, whenever shelling a new process.  sh.exe
  46 causes problems for mingw32-make.exe because of its inability to handle
  47 Windows pathnames with backslashes.  You must run "perl Configure.pl" and
  48 mingw32-make from a dosbox; running those commands from an MSYS shell window
  49 will experience the same backslash path problems.
  50
  51 =item Command Shell
  52
  53 The surest way to build it is on Windows NT/2000/XP, using the cmd shell.
  54
  55 =item ICU
  56
  57 Parrot no longer comes with its own ICU, thus you need to install it on your
  58 system if you want to use it.  Note that ICU is now optional, you can
  59 build Parrot without it, by not installing it or asking Parrot to
  60 ignore it (C<--without-icu>).
  61
  62 If you want to use ICU, download it from
  63 L<http://www.icu-project.org/download/>.
  64
  65 If you want to use precompiled binaries, do the following.
  66 Download the package matching your compiler, unpack it (say, into
  67 C:\usr\lib), add the F<bin> directory to C<PATH>, and tell
  68 Configure.pl to use it.
  69
  70     mkdir C:\usr\lib
  71     unzip icu4c-3_8_1-Win32-msvc8.zip -d C:\usr\lib
  72     mkdir C:\usr\lib\data
  73     set PATH=%PATH%;C:\usr\lib\icu\bin
  74     cd <parrot directory>
  75     perl Configure.pl
  76         --icushared="C:\usr\lib\icu\lib\icudt.lib C:\usr\lib\icu\lib\icuuc.lib"
  77         --icuheaders="C:\usr\lib\icu\include"
  78
  79 Note the step of creating the F<C:\usr\lib\data> directory, as Parrot
  80 really wants it and the binary packages don't contain it.  It doesn't
  81 need to contain anything though, as the data is pulled in from
  82 F<lib/icudt.lib>, which contains the standard data in binary form.
  83
  84 =item Optional libraries
  85
  86 The availability of these libraries is checked by Configure.pl.
  87
  88 B<libcrypto> - a part of libssl
  89 L<http://www.openssl.org/>
  90
  91 B<gettext> - library and tools for native language support
  92 L<http://gnuwin32.sourceforge.net/>
  93
  94 B<gdbm> - GNU database manager
  95 L<http://gnuwin32.sourceforge.net/>
  96
  97 B<GMP> - GNU multiple precision arithmetic library
  98 L<http://developer.berlios.de/projects/win32gmp/>
  99
 100 B<pcre> - Perl-Compatible Regular Expression library
 101 L<http://gnuwin32.sourceforge.net/>
 102
 103 B<readline> - edit command lines
 104 L<http://gnuwin32.sourceforge.net/>
 105
 106 =item Optional utilities
 107
 108 The availability of these utilities is checked by Configure.pl
 109 or by some test.
 110
 111 B<antlr> - ANother Tool for Language Recognition
 112 L<http://www.antlr.org/>
 113
 114 B<m4> - macro language processor
 115 L<http://gnuwin32.sourceforge.net/>
 116
 117 B<SVN::Client> - Perl wrapper of Subversion client functions
 118 L<http://subversion.tigris.org/> (svn-win32-1.4.x_pl.zip)
 119
 120 =item Inno Setup
 121
 122 Inno Setup is a I<free> installer for Windows programs.
 123
 124 The latest release of Inno Setup at the time of writing is 5.2.3.
 125
 126 The HomePage is on L<http://www.jrsoftware.org/>.
 127
 128 Add the directory to PATH.
 129
 130     set PATH=%PATH%;C:\Program Files\Inno Setup 5
 131
 132 =item Borland C++
 133
 134 XXX
 135
 136 =item Microsoft Visual C++
 137
 138 Since mid April 2004, Visual C++ comes in two flavors.  Microsoft
 139 Visual Studio .NET 2003 (L<http://msdn.microsoft.com/visualc/>), which
 140 includes the full blown IDE, and Microsoft Visual C++ Toolkit 2003
 141 (L<http://msdn.microsoft.com/visualc/vctoolkit2003/>), which is a free
 142 (but unsupported) package, containing only the basic compiler and
 143 linker stuff.
 144
 145 If you use the Toolkit, be sure to follow the directions for setting up
 146 your build environment that come with the perl distributions. (README.win32
 147 in the latest perl distribution.) You may have to substitute "Microsoft
 148 Platform SDK" wherever "Microsoft SDK" is listed, depending on the your
 149 install. You can ignore the entries regarding "win32/config.vc", but be sure
 150 to create the "link.bat" batch file. Copy the missing files mentioned,
 151 run the Toolkit Command Prompt, set the appropriate env vars, and you
 152 should be fine. (For env vars, you can update them under My Computer->
 153 properties so they are available whenever you open a shell.)
 154
 155 Note: It is possible to use ActiveState Perl with the Toolkit: you don't
 156 have to compile your own perl.
 157
 158 =item Strawberry Perl
 159
 160 With the Strawberry perl distro from
 161 L<http://strawberryperl.com/>, gcc is included. To build parrot,
 162 use the strawberry perl binary to run Configure.pl, and then
 163 follow the directions.
 164
 165 =item MinGW32 with GCC
 166
 167 The latest release of MinGW package at the time of writing is 5.1.3,
 168 which contains gcc-3.4.5 as current release.
 169 It can be downloaded here:
 170 L<http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe>
 171
 172 The HomePage is on L<http://www.mingw.org/>.
 173
 174 With the ActiveState Perl distribution, tell Configure.pl to use gcc :
 175
 176     perl Configure.pl
 177          --cc=gcc
 178          --icushared="C:\usr\lib\icu\lib\icudt.lib C:\usr\lib\icu\lib\icuuc.lib"
 179          --icuheaders="C:\usr\lib\icu\include"
 180 or
 181     perl Configure.pl --cc=gcc --without-icu
 182
 183 =item Intel C++
 184
 185 XXX
 186
 187 =back
 188
 189 =head2 Building
 190
 191     $MAKE
 192
 193 =head2 Testing
 194
 195     $MAKE test
 196
 197 =head2 Installation
 198
 199     $MAKE install
 200
 201 =head2 Installer
 202
 203     $MAKE win32-inno-installer
 204
 205 This command creates a setup-parrot-x.y.z.exe that contains all parrot install
 206 directories.
 207
 208 =head2 Usage Hints
 209
 210     XXX
 211
 212 =head1 BUGS AND CAVEATS
 213
 214 =over
 215
 216 =item Features
 217
 218 Threads, Events, and Signals are missing.
 219
 220 =back
 221
 222 =head1 ACKNOWLEDGEMENTS
 223
 224 XXX
 225
 226 =head1 AUTHORS
 227
 228 =over
 229
 230 =item Ron Blaschke E<lt>ron@rblasch.orgE<gt>
 231
 232 =item François Perrad  E<lt>francois.perrad@gadz.orgE<gt>
 233
 234 =back
 235
 236 This document is maintained by The Parrot Developers
 237 (E<lt>parrot-porters@perl.orgE<gt>).
 238
 239 =head1 SEE ALSO
 240
 241     L<parrot>
 242
 243 =head1 HISTORY
 244
 245 This document borrows heavily from Perl's README.win32.
 246
 247 GCC/mingw32 support was added in 0.1.2 (François Perrad).
 248
 249 Last updated: 17 April 2008
 250
 251 =cut