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://site.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-4_2_1-Win32-msvc9.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<gettext> - library and tools for native language support
  89 L<http://gnuwin32.sourceforge.net/>
  90
  91 B<GMP> - GNU multiple precision arithmetic library
  92 L<http://developer.berlios.de/projects/win32gmp/>
  93
  94 B<OpenGL> / B<GLUT> - Open Graphics Library
  95 L<http://www.xmission.com/~nate/glut.html> or
  96 L<http://www.transmissionzero.co.uk/computing/using-glut-with-mingw/>
  97
  98 B<pcre> - Perl-Compatible Regular Expression library
  99 L<http://gnuwin32.sourceforge.net/>
 100
 101 B<readline> - edit command lines
 102 L<http://gnuwin32.sourceforge.net/>
 103
 104 =item Optional utilities
 105
 106 The availability of these utilities is checked by Configure.pl
 107 or by some test.
 108
 109 B<antlr> - ANother Tool for Language Recognition
 110 L<http://www.antlr.org/>
 111
 112 B<ctags> - Exuberant Ctags
 113 L<http://ctags.sourceforge.net/>
 114
 115 =item Inno Setup
 116
 117 Inno Setup is a I<free> installer for Windows programs.
 118
 119 The latest release of Inno Setup at the time of writing is 5.3.7.
 120
 121 The HomePage is on L<http://www.jrsoftware.org/>.
 122
 123 Add the directory to PATH.
 124
 125     set PATH=%PATH%;C:\Program Files\Inno Setup 5
 126
 127 =item Borland C++
 128
 129 XXX
 130
 131 =item Microsoft Visual C++
 132
 133 Since mid April 2004, Visual C++ comes in two flavors.  Microsoft
 134 Visual Studio .NET 2003 (L<http://msdn.microsoft.com/visualc/>), which
 135 includes the full blown IDE, and Microsoft Visual C++ Toolkit 2003
 136 (L<http://msdn.microsoft.com/visualc/vctoolkit2003/>), which is a free
 137 (but unsupported) package, containing only the basic compiler and
 138 linker stuff.
 139
 140 If you use the Toolkit, be sure to follow the directions for setting up
 141 your build environment that come with the perl distributions. (README.win32
 142 in the latest perl distribution.) You may have to substitute "Microsoft
 143 Platform SDK" wherever "Microsoft SDK" is listed, depending on the your
 144 install. You can ignore the entries regarding "win32/config.vc", but be sure
 145 to create the "link.bat" batch file. Copy the missing files mentioned,
 146 run the Toolkit Command Prompt, set the appropriate env vars, and you
 147 should be fine. (For env vars, you can update them under My Computer->
 148 properties so they are available whenever you open a shell.)
 149
 150 Note: It is possible to use ActiveState Perl with the Toolkit: you don't
 151 have to compile your own perl.
 152
 153 =item Strawberry Perl
 154
 155 With the Strawberry perl distro from
 156 L<http://strawberryperl.com/>, gcc is included. To build parrot,
 157 use the strawberry perl binary to run Configure.pl, and then
 158 follow the directions.
 159
 160 =item MinGW32 with GCC
 161
 162 The latest release of MinGW package at the time of writing is 5.1.6,
 163 which contains gcc-3.4.5 as current release.
 164 It can be downloaded here:
 165 L<http://sourceforge.net/projects/mingw/files/>
 166
 167 The HomePage is on L<http://www.mingw.org/>.
 168
 169 With the ActiveState Perl distribution, tell Configure.pl to use gcc :
 170
 171     perl Configure.pl
 172          --cc=gcc
 173          --icushared="C:\usr\lib\icu\lib\icudt.lib C:\usr\lib\icu\lib\icuuc.lib"
 174          --icuheaders="C:\usr\lib\icu\include"
 175 or
 176     perl Configure.pl --cc=gcc --without-icu
 177
 178 =item Intel C++
 179
 180 XXX
 181
 182 =back
 183
 184 =head2 Building
 185
 186     $MAKE
 187
 188 =head2 Testing
 189
 190     $MAKE test
 191
 192 =head2 Installation
 193
 194     $MAKE install
 195
 196 =head2 Installer
 197
 198     $MAKE win32-inno-installer
 199
 200 This command creates a setup-parrot-x.y.z.exe that contains all parrot install
 201 directories.
 202
 203 =head2 Usage Hints
 204
 205     XXX
 206
 207 =head1 BUGS AND CAVEATS
 208
 209 =over
 210
 211 =item Features
 212
 213 Threads, Events, and Signals are missing.
 214
 215 =back
 216
 217 =head1 ACKNOWLEDGEMENTS
 218
 219 XXX
 220
 221 =head1 AUTHORS
 222
 223 =over
 224
 225 =item Ron Blaschke E<lt>ron@rblasch.orgE<gt>
 226
 227 =item François Perrad  E<lt>francois.perrad@gadz.orgE<gt>
 228
 229 =back
 230
 231 This document is maintained by The Parrot Developers
 232 (E<lt>parrot-dev@lists.parrot.orgE<gt>).
 233
 234 =head1 SEE ALSO
 235
 236     L<parrot>
 237
 238 =head1 HISTORY
 239
 240 This document borrows heavily from Perl's README.win32.
 241
 242 GCC/mingw32 support was added in 0.1.2 (François Perrad).
 243
 244 Last updated: 20 Jan 2009
 245
 246 =cut