[project @ 2000-01-24 10:40:05 by simonpj]
[ghc-hetmet.git] / ghc / docs / users_guide / installing.sgml
1 <Chapter id="sec-installing-bin-distrib">
2 <Title>Installing from binary distributions</Title>
3 <IndexTerm><Primary>binary installations</Primary></IndexTerm>
4 <IndexTerm><Primary>installation, of binaries</Primary></IndexTerm>
5
6 <Para>
7 Installing from binary distributions is easiest, and recommended!
8 (Why binaries?  Because GHC is a Haskell compiler written in Haskell,
9 so you've got to ``bootstrap'' it, somehow.  We provide
10 machine-generated C-files-from-Haskell for this purpose, but it's
11 really quite a pain to use them.  If you must build GHC from its
12 sources, using a binary-distributed GHC to do so is a sensible way to
13 proceed. For the other <Literal>fptools</Literal> programs, many are written in Haskell,
14 so binary distributions allow you to install them without having a Haskell compiler.)
15 </Para>
16
17 <Para>This guide is in two parts: installing on Unix-a-likes, and installing on Windows.</Para>
18
19
20 <Sect1><Title>Installing on Unix-a-likes</Title>
21
22 <Sect2>
23 <Title>Bundle structure</Title>
24
25 <Para>
26 <IndexTerm><Primary>bundles of binary stuff</Primary></IndexTerm>
27 </Para>
28
29 <Para>
30 Binary distributions come in ``bundles,'' one bundle per file called
31 <Literal>&lt;bundle&gt;-&lt;platform&gt;.tar.gz</Literal>.  (See the building guide for the definition of a platform.)  Suppose that you untar a binary-distribution bundle, thus:
32 </Para>
33
34 <Para>
35
36 <Screen>
37 % cd /your/scratch/space
38 % gunzip &#60; ghc-x.xx-sun-sparc-solaris2.tar.gz | tar xvf -
39 </Screen>
40
41 </Para>
42
43 <Para>
44 Then you should find a single directory, <Literal>fptools</Literal>, with the following
45 structure:
46 </Para>
47
48 <Para>
49 <IndexTerm><Primary>binary distribution, layout</Primary></IndexTerm>
50 <IndexTerm><Primary>directory layout (binary distributions)</Primary></IndexTerm>
51 <VariableList>
52
53 <VarListEntry>
54 <Term><Literal>Makefile.in</Literal></Term>
55 <ListItem>
56 <Para>
57 the raw material from which the <Literal>Makefile</Literal>
58 will be made (<Xref LinkEnd="sec-install">).
59 </Para>
60 </ListItem></VarListEntry>
61 <VarListEntry>
62 <Term><Literal>configure</Literal></Term>
63 <ListItem>
64 <Para>
65 the configuration script (<Xref LinkEnd="sec-install">).
66 </Para>
67 </ListItem></VarListEntry>
68 <VarListEntry>
69 <Term><Literal>README</Literal></Term>
70 <ListItem>
71 <Para>
72 Contains this file summary.
73 </Para>
74 </ListItem></VarListEntry>
75 <VarListEntry>
76 <Term><Literal>INSTALL</Literal></Term>
77 <ListItem>
78 <Para>
79 Contains this description of how to install
80 the bundle.
81 </Para>
82 </ListItem></VarListEntry>
83 <VarListEntry>
84 <Term><Literal>ANNOUNCE</Literal></Term>
85 <ListItem>
86 <Para>
87 The announcement message for the bundle.
88 </Para>
89 </ListItem></VarListEntry>
90 <VarListEntry>
91 <Term><Literal>NEWS</Literal></Term>
92 <ListItem>
93 <Para>
94 release notes for the bundle&mdash;a longer version
95 of <Literal>ANNOUNCE</Literal>.  For GHC, the release notes are contained in the User
96 Guide and this file isn't present.
97 </Para>
98 </ListItem></VarListEntry>
99 <VarListEntry>
100 <Term><Literal>bin/&lt;platform&gt;</Literal></Term>
101 <ListItem>
102 <Para>
103 contains platform-specific executable
104 files to be invoked directly by the user.  These are the files that
105 must end up in your path.
106 </Para>
107 </ListItem></VarListEntry>
108 <VarListEntry>
109 <Term><Literal>lib/&lt;platform&gt;/</Literal></Term>
110 <ListItem>
111 <Para>
112 contains platform-specific support
113 files for the installation.  Typically there is a subdirectory for
114 each <Literal>fptools</Literal> project, whose name is the name of the project with its
115 version number.  For example, for GHC there would be a sub-directory
116 <Literal>ghc-x.xx</Literal>/ where <Literal>x.xx</Literal> is the version number of GHC in the bundle.
117 </Para>
118
119 <Para>
120 These sub-directories have the following general structure:
121 </Para>
122
123 <Para>
124 <VariableList>
125
126 <VarListEntry>
127 <Term><Literal>libHS.a</Literal> etc:</Term>
128 <ListItem>
129 <Para>
130 supporting library archives.
131 </Para>
132 </ListItem></VarListEntry>
133 <VarListEntry>
134 <Term><Literal>ghc-iface.prl</Literal> etc:</Term>
135 <ListItem>
136 <Para>
137 support scripts.
138 </Para>
139 </ListItem></VarListEntry>
140 <VarListEntry>
141 <Term><Literal>import/</Literal></Term>
142 <ListItem>
143 <Para>
144 <IndexTerm><Primary>Interface files</Primary></IndexTerm> (<Literal>.hi</Literal>) for the prelude.
145 </Para>
146 </ListItem></VarListEntry>
147 <VarListEntry>
148 <Term><Literal>include/</Literal></Term>
149 <ListItem>
150 <Para>
151 A few C <Literal>&num;include</Literal> files.
152 </Para>
153 </ListItem></VarListEntry>
154 </VariableList>
155 </Para>
156 </ListItem></VarListEntry>
157 <VarListEntry>
158 <Term><Literal>share/</Literal></Term>
159 <ListItem>
160 <Para>
161 contains platform-independent support files
162 for the installation.  Again, there is a sub-directory for each
163 <Literal>fptools</Literal> project.
164 </Para>
165 </ListItem></VarListEntry>
166 <VarListEntry>
167 <Term><Literal>info/</Literal></Term>
168 <ListItem>
169 <Para>
170 contains Emacs info documentation files (one
171 sub-directory per project).
172 </Para>
173 </ListItem></VarListEntry>
174 <VarListEntry>
175 <Term><Literal>html/</Literal></Term>
176 <ListItem>
177 <Para>
178 contains HTML documentation files (one
179 sub-directory per project).
180 </Para>
181 </ListItem></VarListEntry>
182 <VarListEntry>
183 <Term><Literal>man/</Literal></Term>
184 <ListItem>
185 <Para>
186 contains Unix manual pages.
187 </Para>
188 </ListItem></VarListEntry>
189 </VariableList>
190 </Para>
191
192 <Para>
193 This structure is designed so that you can unpack multiple bundles
194 (including ones from different releases or platforms) into a single
195 <Literal>fptools</Literal> directory
196 <FOOTNOTE>
197
198 <Para>
199 this doesn't work at the
200 moment
201 </Para>
202
203 </FOOTNOTE>
204 :
205 </Para>
206
207 <Para>
208
209 <Screen>
210 % cd /your/scratch/space
211 % gunzip &#60; ghc-x.xx-sun-sparc-solaris2.tar.gz | tar xvf -
212 % gunzip &#60; happy-x.xx-sun-sparc-sunos4.tar.gz | tar xvf -
213 </Screen>
214
215 </Para>
216
217 <Para>
218 When you do multiple unpacks like this, the top level <Literal>Makefile</Literal>,
219 <Literal>README</Literal>, and <Literal>INSTALL</Literal> get overwritten each time.
220 That's fine&mdash;they should be the same.  Likewise, the
221 <Literal>ANNOUNCE-&lt;bundle&gt;</Literal> and <Literal>NEWS-&lt;bundle&gt;</Literal>
222 files will be duplicated across multiple platforms, so they will be
223 harmlessly overwritten when you do multiple unpacks.  Finally, the
224 <Literal>share/</Literal> stuff will get harmlessly overwritten when you do
225 multiple unpacks for one bundle on different platforms.
226 </Para>
227
228 <Sect3 id="sec-install">
229 <Title>Installing</Title>
230
231 <Para>
232 OK, so let's assume that you have unpacked your chosen bundles into a
233 scratch directory <Literal>fptools</Literal>. What next? Well, you will at least need
234 to run the <Literal>configure</Literal><IndexTerm><Primary>configure</Primary></IndexTerm> script by changing your
235 directory to <Literal>fptools</Literal> and typing <Literal>./configure</Literal>.  That should convert
236 <Literal>Makefile.in</Literal> to <Literal>Makefile</Literal>.
237 </Para>
238
239 <Para>
240 <IndexTerm><Primary>installing in-place</Primary></IndexTerm>
241 <IndexTerm><Primary>in-place installation</Primary></IndexTerm>
242 </Para>
243
244 <Para>
245 You can now either start using the tools <Emphasis>in-situ</Emphasis> without going
246 through any installation process, just type <Literal>make in-place</Literal> to set the
247 tools up for this. You'll also want to add the path which <Literal>make</Literal> will
248 now echo to your <Literal>PATH</Literal> environment variable. This option is useful if
249 you simply want to try out the package and/or you don't have the
250 necessary privileges (or inclination) to properly install the tools
251 locally. Note that if you do decide to install the package `properly'
252 at a later date, you have to go through the installation steps that
253 follows.
254 </Para>
255
256 <Para>
257 To install an <Literal>fptools</Literal> package, you'll have to do the following:
258 </Para>
259
260 <Para>
261
262 <OrderedList>
263 <ListItem>
264
265 <Para>
266  Edit the <Literal>Makefile</Literal> and check the settings of the following variables:
267
268 <IndexTerm><Primary>directories, installation</Primary></IndexTerm>
269 <IndexTerm><Primary>installation directories</Primary></IndexTerm>
270
271 <VariableList>
272
273 <VarListEntry>
274 <Term><Literal>platform</Literal></Term>
275 <ListItem>
276 <Para>
277 the platform you are going to install for.
278 </Para>
279 </ListItem></VarListEntry>
280 <VarListEntry>
281 <Term><Literal>bindir</Literal></Term>
282 <ListItem>
283 <Para>
284 the directory in which to install user-invokable
285 binaries.
286 </Para>
287 </ListItem></VarListEntry>
288 <VarListEntry>
289 <Term><Literal>libdir</Literal></Term>
290 <ListItem>
291 <Para>
292 the directory in which to install
293 platform-dependent support files.
294 </Para>
295 </ListItem></VarListEntry>
296 <VarListEntry>
297 <Term><Literal>datadir</Literal></Term>
298 <ListItem>
299 <Para>
300 the directory in which to install
301 platform-independent support files.
302 </Para>
303 </ListItem></VarListEntry>
304 <VarListEntry>
305 <Term><Literal>infodir</Literal></Term>
306 <ListItem>
307 <Para>
308 the directory in which to install Emacs info
309 files.
310 </Para>
311 </ListItem></VarListEntry>
312 <VarListEntry>
313 <Term><Literal>htmldir</Literal></Term>
314 <ListItem>
315 <Para>
316 the directory in which to install HTML
317 documentation.
318 </Para>
319 </ListItem></VarListEntry>
320 <VarListEntry>
321 <Term><Literal>dvidir</Literal></Term>
322 <ListItem>
323 <Para>
324 the directory in which to install DVI
325 documentation.
326 </Para>
327 </ListItem></VarListEntry>
328 </VariableList>
329
330 The values for these variables can be set through invocation of the
331 <Command>configure</Command><IndexTerm><Primary>configure</Primary></IndexTerm> script that comes with the distribution,
332 but doing an optical diff to see if the values match your expectations
333 is always a Good Idea.
334
335 <Emphasis>Instead of running <Command>configure</Command>, it is perfectly OK to copy
336 <Filename>Makefile.in</Filename> to <Filename>Makefile</Filename> and set all these variables
337 directly yourself.  But do it right!</Emphasis>
338
339 </Para>
340 </ListItem>
341 <ListItem>
342
343 <Para>
344 Run <Literal>make install</Literal>.  This <Emphasis> should</Emphasis> work with ordinary Unix
345 <Literal>make</Literal>&mdash;no need for fancy stuff like GNU <Literal>make</Literal>. 
346
347 </Para>
348 </ListItem>
349 <ListItem>
350
351 <Para>
352 <Literal>rehash</Literal> (t?csh or zsh users), so your shell will see the new
353 stuff in your bin directory.
354
355 </Para>
356 </ListItem>
357 <ListItem>
358
359 <Para>
360  Once done, test your ``installation'' as suggested in 
361 <XRef LinkEnd="sec-GHC-test">.  Be sure to use a <Literal>-v</Literal>
362 option, so you can see exactly what pathnames it's using.
363
364 If things don't work as expected, check the list of know pitfalls in
365 the building guide.
366 </Para>
367 </ListItem>
368
369 </OrderedList>
370
371 </Para>
372
373 <Para>
374 <IndexTerm><Primary>link, installed as ghc</Primary></IndexTerm>
375 When installing the user-invokable binaries, this installation
376 procedure will install GHC as <Literal>ghc-x.xx</Literal> where <Literal>x.xx</Literal> is the version
377 number of GHC.  It will also make a link (in the binary installation
378 directory) from <Literal>ghc</Literal> to <Literal>ghc-x.xx</Literal>.  If you install multiple versions
379 of GHC then the last one ``wins'', and ``<Literal>ghc</Literal>'' will invoke the last
380 one installed.  You can change this manually if you want.  But
381 regardless, <Literal>ghc-x.xx</Literal> should always invoke GHC version <Literal>x.xx</Literal>.
382 </Para>
383
384 </Sect3>
385
386
387 <Sect3>
388 <Title>What bundles there are</Title>
389
390 <Para>
391 <IndexTerm><Primary>bundles, binary</Primary></IndexTerm>
392 There are plenty of ``non-basic'' GHC bundles.  The files for them are
393 called <Literal>ghc-x.xx-&lt;bundle&gt;-&lt;platform&gt;.tar.gz</Literal>, where
394 the <Literal>&lt;platform&gt;</Literal> is as above, and <Literal>&lt;bundle&gt;</Literal> is one
395 of these:
396 </Para>
397
398 <Para>
399 <VariableList>
400
401 <VarListEntry>
402 <Term><Literal>prof</Literal>:</Term>
403 <ListItem>
404 <Para>
405 Profiling with cost-centres.  You probably want this.
406 <IndexTerm><Primary>profiling bundles</Primary></IndexTerm>
407 <IndexTerm><Primary>bundles, profiling</Primary></IndexTerm>
408 </Para>
409 </ListItem></VarListEntry>
410 <VarListEntry>
411 <Term><Literal>par</Literal>:</Term>
412 <ListItem>
413 <Para>
414 Parallel Haskell features (sits on top of PVM).
415 You'll want this if you're into that kind of thing.
416 <IndexTerm><Primary>parallel bundles</Primary></IndexTerm>
417 <IndexTerm><Primary>bundles, parallel</Primary></IndexTerm>
418 </Para>
419 </ListItem></VarListEntry>
420 <VarListEntry>
421 <Term><Literal>gran</Literal>:</Term>
422 <ListItem>
423 <Para>
424 The ``GranSim'' parallel-Haskell simulator
425 (hmm&hellip; mainly for implementors).
426 <IndexTerm><Primary>bundles, gransim</Primary></IndexTerm>
427 <IndexTerm><Primary>gransim bundles</Primary></IndexTerm>
428 </Para>
429 </ListItem></VarListEntry>
430 <VarListEntry>
431 <Term><Literal>ticky</Literal>:</Term>
432 <ListItem>
433 <Para>
434 ``Ticky-ticky'' profiling; very detailed
435 information about ``what happened when I ran this program''&mdash;really
436 for implementors.
437 <IndexTerm><Primary>bundles, ticky-ticky</Primary></IndexTerm>
438 <IndexTerm><Primary>ticky-ticky bundles</Primary></IndexTerm>
439 </Para>
440 </ListItem></VarListEntry>
441 </VariableList>
442 </Para>
443
444 <Para>
445 One likely scenario is that you will grab <Emphasis>two</Emphasis>
446 binary bundles&mdash;basic, and profiling.  We don't usually make the
447 rest, although you can build them yourself from a source distribution.
448 </Para>
449
450 </Sect3>
451
452 <Sect3 id="sec-GHC-test">
453 <Title>Testing that GHC seems to be working
454 </Title>
455
456 <Para>
457 <IndexTerm><Primary>testing a new GHC</Primary></IndexTerm>
458 </Para>
459
460 <Para>
461 The way to do this is, of course, to compile and run <Emphasis>this</Emphasis> program
462 (in a file <Literal>Main.hs</Literal>):
463 </Para>
464
465 <Para>
466
467 <ProgramListing>
468 main = putStr "Hello, world!\n"
469 </ProgramListing>
470
471 </Para>
472
473 <Para>
474 Compile the program, using the <Literal>-v</Literal> (verbose) flag to verify that
475 libraries, etc., are being found properly:
476
477 <Screen>
478 % ghc -v -o hello Main.hs
479 </Screen>
480
481 </Para>
482
483 <Para>
484 Now run it:
485
486 <Screen>
487 % ./hello
488 Hello, world!
489 </Screen>
490
491 </Para>
492
493 <Para>
494 Some simple-but-profitable tests are to compile and run the notorious
495 <Literal>nfib</Literal><IndexTerm><Primary>nfib</Primary></IndexTerm> program, using different numeric types.  Start with
496 <Literal>nfib :: Int -&gt; Int</Literal>, and then try <Literal>Integer</Literal>, <Literal>Float</Literal>, <Literal>Double</Literal>,
497 <Literal>Rational</Literal> and perhaps the overloaded version.  Code for this is
498 distributed in <Literal>ghc/misc/examples/nfib/</Literal> in a source distribution.
499 </Para>
500
501 <Para>
502 For more information on how to ``drive'' GHC, either do <Literal>ghc -help</Literal> or
503 consult the User's Guide (distributed in several pre-compiled formats
504 with a binary distribution, or in source form in
505 <Literal>ghc/docs/users&lowbar;guide</Literal> in a source distribution).
506 </Para>
507
508 </Sect3>
509
510 </Sect2>
511
512 </Sect1>
513
514
515 <Sect1><Title>Installing on Windows</Title>
516
517 <Para>
518 Getting the Glasgow Haskell Compiler(GHC) to run on Windows95/98 or
519 Windows NT4 platforms can be a bit of a trying experience. This document
520 tries to simplify the task by enumerating the steps you need to
521 follow in order to set up and configure your machine to run GHC (at
522 least that's the intention ;-)
523 </Para>
524
525 <Sect2><Title>System requirements</Title>
526
527 <Para>
528 An installation of GHC requires ca. 70M of disk space. The size of the
529 installed GHC distribution is just(!) 17M, the rest is needed by
530 supporting software.
531 </Para>
532
533 <Para>
534 To run GHC comfortably, your machine should have at least 32M of memory.
535 </Para>
536
537 </Sect2>
538
539
540 <Sect2><Title>Your environment variables</Title>
541
542 <Para>
543 Much of the Unixy stuff below involves setting environment variables.  
544 This section summarises  how to set these variables on a Windows machine, in
545 case you don't know alread.y
546 On WinNT/Win2k, to edit your <Constant>PATH</Constant> variable (for example),
547 do the following:
548 </Para>
549
550 <ItemizedList>
551 <ListItem><Para>Press Start/Settings/Control Panels</Para></ListItem>
552 <ListItem><Para>Double-click System</Para></ListItem>
553 <ListItem><Para>Press Advanced</Para></ListItem>
554 <ListItem><Para>Press Environment Variables</Para></ListItem>
555 <ListItem><Para>Under System Variables, select PATH</Para></ListItem>
556 <ListItem><Para>Press Edit</Para></ListItem>
557 <ListItem><Para>Add "<Filename>;C:/whatever/</Filename>" to the end of the string (for example)</Para></ListItem>
558 <ListItem><Para>Press OK</Para></ListItem>
559 </ItemizedList>
560
561 <Para>
562 Some environment variables are ``user variables'' and
563 some are ``system variables''.  I'm not sure of the difference
564 but both are changed though the same dialogue.
565 </Para>
566
567 <Para>
568 In addition, when running a Cygwin (see <XRef LinkEnd="sec-required">) shell
569 you can set environment variables in your <Filename>.bashrc</Filename> file.
570 But it is better to set your environment variables from the
571 control panel (they get inherited by bash) because then they are visible
572 to applications that aren't started by bash.  For example,
573 when you're invoking CVS (and ssh) via Emacs keybindings;
574 it invokes <Filename>cvs.exe</Filename> without going via bash.
575 </Para>
576
577 <Para>
578 On a Win9x machine you need to edit <Filename>autoexec.bat</Filename> using
579 <Filename>Windows/system/Sysedit</Filename>.  You need to reboot to make
580 the new settings take effect.
581 </Para>
582
583 </Sect2>
584
585
586 <Sect2 id="sec-required"><Title>Software required</Title>
587
588 You need two chunks of software other than GHC itself: the Cygwin toolchain, and
589 Perl.  Here's how to get and install them.
590
591 <Sect3><Title>The cygwin toolchain (beta20.1)</Title>
592
593 <Para>
594 GHC depends at the moment on the cygwin tools to operate, which
595 dresses up the Win32 environment into something more UNIX-like.
596 (notably, it provides <Command>gcc</Command>, <Command>as</Command> and <Command>ld</Command>),
597 so you'll need to install these tools first. You also need
598 Cygwin to use CVS.
599 </Para>
600
601 <Para>
602 Important grungy information about Cygwin:
603 </Para>
604
605 <ItemizedList>
606
607 <ListItem>
608 <Para>
609 Cygwin doesn't deal well with filenames that include
610 spaces. "<Filename>Program Files</Filename>" and "<Filename>Local files</Filename>" are
611 common gotchas.
612 </Para>
613 </ListItem>
614
615 <ListItem>
616 <Para>
617 Cygwin implements a symbolic link as a text file with some
618 magical text in it.  So programs that don't use Cygwin's
619 I/O libraries won't recognise such files as symlinks.  
620 In particular, programs compiled by GHC are meant to be runnable
621 without having Cygwin, so they don't use the Cygwin library, so
622 they don't recognise symlinks.
623 </Para>
624 </ListItem>
625
626 </ItemizedList>
627
628 <Para>
629 Here's how to install Cygwin.
630 </Para>
631
632 <ItemizedList>
633
634 <ListItem>
635 <Para>
636 Download cygwin, beta20.1 (<filename>full.exe</filename>) from
637 <ULink URL="http://sourceware.cygnus.com/cygwin/">sourceware.cygnus.com</ULink>
638 Install this somewhere locally.
639 </Para>
640 </ListItem>
641
642 <ListItem>
643 <Para>
644 Create the following directories (if they aren't already there):
645 </Para>
646
647 <ItemizedList>
648 <ListItem><Para><Filename>c:/etc</Filename></Para></ListItem>
649 <ListItem><Para><Filename>c:/bin</Filename></Para></ListItem>
650 <ListItem><Para><Filename>c:/usr/local/bin</Filename></Para></ListItem>
651 </ItemizedList>
652
653 <Para>
654 (using <Command>mkdir -p /bin</Command>, etc.)
655 </Para>
656 </ListItem>
657
658 <ListItem>
659 <Para>
660 Add the two <Filename>bin</Filename> directories to your <Constant>PATH</Constant>.
661 </Para>
662 </ListItem>
663
664 <ListItem>
665 <Para>
666 Copy <Filename>bash.exe</Filename> from the <Filename>bin</Filename>
667 directory of the cygwin tree
668 (<Filename>cygwin-b20/H-i586-cygwin32/bin/bash.exe</Filename>) to
669 <Filename>/bin</Filename> as <Filename>sh.exe</Filename>.  You might
670 think that it was easier to use bash directly from it original Cygwin
671 directory, but (a) some UNIX utils have got
672 <Filename>/bin/sh</Filename> hardwired in, and (b) the path following
673 <Literal>#!</Literal> is limited to 32 characters.
674 </Para>
675 </ListItem>
676
677 <ListItem>
678 <Para>
679 Add <Filename>C:\cygnus\cygwin-b20\H-i586-cygwin32\bin</Filename> to your <Constant>PATH</Constant>.
680 <Command>bash</Command> needs this, and when it is invoked from <Filename>/bin</Filename> it can't
681 find it.
682 </Para>
683 </ListItem>
684
685 <ListItem>
686 <Para>
687 Set your <Constant>SHELL</Constant> user environment variable to <Filename>c:/bin/sh</Filename>.
688 </Para>
689 </ListItem>
690
691 <ListItem>
692 <Para>
693 Set your <Filename>HOME</Filename> user environment variable to point to your
694 home directory.  This is where, for example,
695 <Command>bash</Command> will look for your <Filename>.bashrc</Filename>
696 file.
697 </Para>
698 </ListItem>
699
700 <ListItem>
701 <Para>
702 Set your <Constant>MAKE_MODE</Constant> user environment variable to <Literal>UNIX</Literal>.  If you don't do
703 this you get very weird messages when you type `<Command>make</Command>', such as:
704 </Para>
705
706 <Screen>
707 /c: /c: No such file or directory
708 </Screen>
709 </ListItem>
710
711 <ListItem>
712 <Para>
713 Set the <Constant>TMPDIR</Constant> user environment variable to
714 <Filename>c:/tmp</Filename>. For some reason, Win2k invisibly sets
715 this variable to point to a temporary directory in your profile, that
716 contains embedded spaces.  If GHC sees the <Constant>TMPDIR</Constant>
717 variable set, it tries to use it for temporary files, but Cygwin
718 doesn't grok filenames with spaces, so disaster results.
719 </Para>
720 <Para>
721 Furthermore, it seems that <Constant>TMPDIR</Constant> must be set to a directory
722 in the same file system in which you invoke GHC.  Otherwise you get very werid messages
723 when you invoke GHC, such as:
724 <Screen>
725   does not exist
726   Action: openFile
727   Reason: file does not exist /tmp/ghc11068.cpp
728 </Screen>
729 We think this is due to a bug in Cygwin.
730 </ListItem>
731
732 <ListItem>
733 <Para>
734 If you're an Emacs user and want to be able to run <Command>bash</Command>
735 from within a shell buffer, see the <ULink URL="http://www.cs.washington.edu/homes/voelker/ntemacs.html">NT Emacs home page</ULink> for
736 instructions on how to set this up.
737 </Para>
738 </ListItem>
739
740 </ItemizedList>
741 </Sect3>
742
743 <Sect3><Title>Perl5</Title>
744
745 <Para>
746 The driver script is written in Perl, so you'll need to have this
747 installed too. However, the ghc binary distribution includes a
748 perl binary for you to make use of, should you not already have a
749 cygwin compatible one. Note: GHC does <Emphasis>not</Emphasis>
750 work with the ActiveState port of perl.
751 </Para>
752
753 </Sect3>  <!-- Perl -->
754
755 </Sect2>  <!-- Reqd software -->
756
757
758 <Sect2><Title>Installing GHC</Title>
759
760 <Para>
761 Download a GHC distribution:
762 </Para>
763
764 <VariableList>
765
766 <VarListEntry>
767 <Term>ghc-4.045&mdash;InstallShield installer, 10M: <ULink URL="http://www.dcs.gla.ac.uk/~sof/ghc-4.045-win32-IS.zip">http</ULink> or <ULink URL="ftp://ftp.dcs.gla.ac.uk/pub/haskell/glasgow/4.04/ghc-4.045-win32-IS.zip">ftp</ULink>
768 </Term>
769
770 <ListItem>
771 <Para>
772 (The version number may change.) It is packaged up using an installer that should be familiar-looking to Windows users. Unpack and double click on <Filename>setup.exe</Filename>.
773 </Para>
774
775 <Para>
776 Note: The cygwin support for long file names containing
777 spaces is not 100%, so make sure that you install ghc in a directory
778 that has no embedded spaces (i.e., resist the temptation to put it
779 in <Filename>/Program Files/</Filename>!)
780 </Para>
781
782 <Para>
783 When the installer has completed its job, you may delete the
784 <Filename>ghcInstall</Filename> directory.
785 </Para>
786
787 <Para>
788 When the installer has completed, make sure you add the location of the
789 ghc <Filename>bin/</Filename> directory to your path (i.e. <Filename>/path/to/wherever/ghc-4.05/bin </Filename>).
790 You need to do this in order to bring the various GHC DLLs into scope;
791 if not, then you need to copy the DLLs into a directory that is (the
792 system directory, for example).
793 </Para>
794
795 <Para>
796 Note: In case you haven't got perl already installed,
797 you will have to manually copy the <Filename>perl.exe</Filename> binary from the
798 ghc <Filename>bin/</Filename> into your <Filename>/bin</Filename> directory before continuing&mdash;the installer will not currently do this.
799 </Para>
800 </ListItem>
801
802 </VarListEntry>
803
804 <VarListEntry>
805 <Term>
806 ghc-4.045 - gzip'ed tarfile, 7.5M: <ULink URL="http://www.dcs.gla.ac.uk/~sof/ghc-4.045-win32.tar.gz">
807 http</ULink> or <ULink URL="ftp://ftp.dcs.gla.ac.uk/pub/haskell/glasgow/4.04/ghc-4.045-win32.tar.gz">ftp</ULink>
808 </Term>
809
810 <ListItem>
811 <Para>
812 A `normal' GHC binary distribution packaged up as a compressed tar file.
813 If you're already accustomed to installing and using GHC distributions
814 on other platforms, the setup should be familiar to you, I
815 hope. Unpack and read the INSTALL file contained in the
816 distribution for instructions on how to set it up.
817 </Para>
818
819 <Para>
820 Notice that the top directory of the distribution contains
821 (rather clumsily) a perl binary (version 5.005_02). If you
822 haven't already got a working perl, install this somewhere
823 along your path too.
824 </Para>
825 </ListItem>
826
827 </VarListEntry>
828 </VariableList>
829
830 <Para>
831 Make sure that you set all the environment variables described above
832 under Cygwin installation, including <Constant>TMPDIR</Constant>
833 </Para>
834 <Para>
835 To test the fruits of your labour, try now to compile a simple
836 Haskell program:
837 </Para>
838
839 <Screen>
840 bash$ cat main.hs
841 module Main(main) where
842
843 main = putStrLn "Hello, world!"
844 bash$ /path/to/the/ghc/bin/directory/ghc-4.05 -o main main.hs
845 ..
846 bash$ ./main
847 Hello, world!
848 bash$ 
849 </Screen>
850
851 <Para>
852 OK, assuming that worked, you're all set. Go forth and write useful
853 Haskell programs :-) If not, consult the installation FAQ (<XRef LinkEnd="winfaq">); if that still doesn't help then please report the problems you're experiencing (see <Xref LinkEnd="wrong">).
854 </Para>
855
856 <Para>
857 Further information on using GHC under Windows can be found in <ULink URL="http://www.dcs.gla.ac.uk/~sof/ghc-win32.html">Sigbj&oslash;rn Finne's pages</ULink>.
858 </Para>
859
860 </Sect2>
861
862 </Sect1>
863
864
865 <Sect1 id="winfaq"><title>Installing ghc-win32 FAQ</title>
866
867 <QandASet>
868
869 <QandAEntry>
870
871 <Question>
872 <Para>
873 Invoking ghc doesn't seem to do anything, it immediately returns without having compiled the input file.
874 </Para>
875 </Question>
876
877 <Answer>
878 <Para>
879 One cause of this is that <Filename>/bin/sh</Filename> is missing. To verify, open up a
880 bash session and type <Command>ls -l /bin/sh.exe</Command>. If <Filename>sh.exe</Filename> is 
881 reported as not being there, copy <Filename>bash.exe</Filename> (which you'll find
882 inside the cygwin installation tree as <Filename>H-i586-cygwin32/bin/bash.exe</Filename>)
883 to <Filename>/bin/sh.exe</Filename>.
884 </Para>
885
886 <Para>
887 All being well, ghc should then start to function.
888 </Para>
889 </Answer>
890
891 </QandAEntry>
892
893 <QandAEntry>
894
895 <Question>
896 <Para>
897 When compiling up the <Literal>Hello World</Literal> example, the following happens:
898 </Para>
899
900 <Screen>
901 bash$ /ghc/ghc-4.05/bin/ghc-4.05 main.hs
902 &lt;stdin&gt;:0:25: Character literal '{-# LINE 1 "main.hs" -}' too long
903 &lt;stdin&gt;:0:25:  on input: "'"
904 bash$ 
905 </Screen>
906
907 <Para>
908 or
909 </Para>
910
911 <Screen>
912 bash$ /ghc/ghc-4.05/bin/ghc-4.05 main.hs
913 Program too big fit into memory under NT
914 bash$ 
915 </Screen>
916 </Question>
917
918 <Answer>
919 <Para>
920 The cause of this is that you're using a version of <Command>perl</Command> that employs the Microsoft <Command>cmd</Command>/<Command>command</Command> shell when launching sub-processes to execute <Function>system()</Function> calls.
921 </Para>
922
923 <Para>
924 The GHC driver really needs a <Command>perl</Command> which uses a `UNIX'y  shell instead, so
925 make sure that the version you're using is of an compatible ilk. In particular, 
926 if <Command>perl -v</Command> reports that you've got a copy of the (otherwise fine) port
927 of perl done by ActiveState, you're in trouble.
928 </Para>
929
930 <Para>
931 If you're stuck with an incompatible <Command>perl</Command>, the GHC installation comes with a very basic <Command>perl</Command> binary for you to use. Simply copy it into the <Command>/bin</Command> directory.
932 </Para>
933
934 <Para>
935 Notice that copying <Filename>perl.exe</Filename> into <Filename>/bin</Filename> will not cause
936 the GHC install to suddenly start functioning. If you don't want to
937 re-run the InstallShield installer again, you need to edit the following
938 files within the directory tree that the installer created:
939 </Para>
940
941 <Screen>
942 bin/ghc-4.xx   -- where xx is the minor release number
943 bin/stat2resid
944 bin/hstags
945 lib/mkdependHS
946 </Screen>
947
948 <Para>
949 For each of these files, you need to edit the first line from instead
950 saying <Command>#!/path/to/your/other/perl/install</Command> to <Command>#!/bin/perl</Command>.
951 Once that is done, try compiling up the Hello, World example again.
952 </Para>
953
954 <Para>
955 Should you want to pick up a complete installation of a ghc-friendly port
956 of perl instead, a <ULink URL="http://cygutils.netpedia.net/">cygwin port</ULink> is available.
957 </Para>
958 </Answer>
959
960 </QandAEntry>
961
962 <QAndAEntry>
963
964 <Question>
965 <Para>
966 <Function>System.getArgs</Function> always return the empty list, i.e. the following program always prints <Screen>"[]"</Screen>:
967 </Para>
968
969 <ProgramListing>
970 module Main(main) where
971 import qualified System
972 main = System.getArgs >>= print
973 </ProgramListing>
974
975 </Question>
976
977 <Answer>
978 <Para>
979 This is a bug with the RTS DLL that comes with ghc-4.03. To fix, upgrade to
980 ghc-4.05.
981 </Para>
982 </Answer>
983
984 </QAndAEntry>
985
986 </QandASet>
987
988 </Sect1>
989
990 </Chapter>