distrib/INSTALL

   1 This is the INSTALL instructions for a binary bundle of the
   2 Glorious Glasgow Haskell Compilation System. For more details
   3 on what on earth this package is up to, please consult the README
   4 and ANNOUNCE.
   5
   6 To start using the bundle, you can either:
   7
   8 * use it in-place, i.e., don't go ahead with a
   9   full install, but just set it up to use the unpacked
  10   distribution in-situ.
  11
  12 * get it over with, and do the full install (details of how are ahead).
  13
  14 NOTE Win32 users: see comment below before continuing.
  15
  16 To set the ball rolling, run the configure script (as usual, run
  17 the script with --help to see what options it supports).
  18
  19 This will figure out what platform you're running on, and a couple of other
  20 interesting pieces of trivia, which it will then fill in the Makefile.in
  21 template to give you a real Makefile.
  22
  23 [Win32 users: don't be alarmed if you should encounter the following
  24  message from the configure script:
  25
  26       not updating unwritable cache ./config.cache
  27
  28 This is a known problem of generated autoconf configure scripts running
  29 on cygwin32, but harmless (it only means you get to re-do all the configure
  30 tests should you decide to re-run the script.)
  31 ]
  32
  33 Have a look at the Makefile to see if you agree with the information
  34 therein. If you want to use the bundle in-place, now run `make in-place'.
  35 If you're installing, `make install' (`make show-install-setup' prints
  36 the details of where the different pieces of the bundle are heading when
  37 -- possibly helpful).
  38
  39 For more information, please consult the installation guide in
  40 {html,dvi,info}/ghc-2.10/installing{.dvi,.info,_toc.html}.
  41
  42 Bug reports/suggestions for improvement to the installation procedure/setup
  43 (as well as other GHC related troubles you're experiencing, of course),
  44 gratefully received at glasgow-haskell-bugs@dcs.gla.ac.uk
  45
  46 Enjoy.
  47
  48
  49 -------Win32 users only----------------------------------------
  50 NOTE to Win32 users: to enjoy any sort of happiness with the GHC
  51 tools, you will have to install the cygwin32 toolchain, which dresses
  52 up the Win32 environment into something more UNIX-like (which
  53 this initial port of ghc relies on being the case). The cygwin32 tools
  54 are available from
  55
  56     ftp://ftp.cygnus.com/pub/gnu-win32/latest/
  57        (Cygnus Solutions; Mt. View, CA.)
  58     ftp://sunsite.doc.ic.ac.uk/pub/gnu/cygnus/gnu-win32/
  59         (Sunsite Northern Europe; Imperial College, London)
  60     ftp://ftp.crl.go.jp/pub/GNU/cygnus/gnu-win32/
  61         (CRL, Ministry of Posts and Telecom., Japan)
  62
  63 GHC was built with beta18 of the cygwin32 tools and depends on
  64 it to work.
  65
  66 The GHC tools are also quite picky about Perl, the commonly-used
  67 Hip/ActiveWare Win32 port of perl5 just ain't Cool Enough (main reason:
  68 GHC scripts assume they are talking to an underlying UNIX command
  69 shell). A basic port of perl5.004 done on top of cygwin32-b18 is
  70 is available from
  71
  72    ftp://ftp.dcs.gla.ac.uk/pub/haskell/glasgow/working/perl5-004pl1.zip
  73
  74 this port is by no means complete, but is sufficient for our needs.
  75 (more complete perl5 cygwin32 binary bundles are available
  76  elsewhere - search the web if you need it.)
  77
  78 Install both cygwin32&perl5 before continuing. Couple of things
  79 to remember doing while installing these two:
  80
  81   - Create a toplevel /bin directory, and copy bash.exe into it
  82     as sh.exe (we'll need this for running the configure script.)
  83     Add /bin to your PATH.
  84   - Create a toplevel /tmp directory.
  85   - If you don't have a good reason not to, it is also recommended
  86     that you also put the perl binary inside /bin as well. Don't
  87     put it inside the bin/ directory inside the installed cygwin32
  88     tree, as this is likely to cause #! not to work on perl scripts
  89     (path is likely to exceed 32 chars.)
  90
  91 NOTE: If you're planning to install ghc on a drive different from
  92 where you're going to compile programs, you either need to
  93 change the TMPDIR variable in the Makefile to "." or the
  94 environment variable TMPDIR to "." when running ghc. This is clearly
  95 not desirable, but the only solution known to work under beta18.
  96
  97 -------Win32 users only----------------------------------------