Remove erroneous requirement to import Control.Monad.Fix when using mdo
[ghc-hetmet.git] / docs / users_guide / installing.xml
index 9b1a1e1..71113ee 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
 <?xml version="1.0" encoding="iso-8859-1"?>
-<chapter id="sec-installing-bin-distrib">
+<chapter id="installing-bin-distrib">
   <title>Installing GHC</title>
 <indexterm><primary>binary installations</primary></indexterm>
 <indexterm><primary>installation, of binaries</primary></indexterm>
   <title>Installing GHC</title>
 <indexterm><primary>binary installations</primary></indexterm>
 <indexterm><primary>installation, of binaries</primary></indexterm>
@@ -21,21 +21,21 @@ having a Haskell compiler.)
   <itemizedlist>
     <listitem>
       <para> Installing on Unix-a-likes (<xref
   <itemizedlist>
     <listitem>
       <para> Installing on Unix-a-likes (<xref
-      linkend="sec-unix-a-likes"/>). </para>
+      linkend="unix-a-likes"/>). </para>
     </listitem>
     <listitem>
       <para> Installing on Windows (<xref
     </listitem>
     <listitem>
       <para> Installing on Windows (<xref
-      linkend="sec-install-windows"/>).  </para>
+      linkend="install-windows"/>).  </para>
     </listitem>
     <listitem>
       <para> The layout of installed files (<xref
     </listitem>
     <listitem>
       <para> The layout of installed files (<xref
-      linkend="sec-install-files"/>).  You don't need to know this to
+      linkend="install-files"/>).  You don't need to know this to
       install GHC, but it's useful if you are changing the
       implementation.</para>
     </listitem>
   </itemizedlist>
   
       install GHC, but it's useful if you are changing the
       implementation.</para>
     </listitem>
   </itemizedlist>
   
-  <sect1 id="sec-unix-a-likes"><title>Installing on Unix-a-likes</title>
+  <sect1 id="unix-a-likes"><title>Installing on Unix-a-likes</title>
 
     <sect2>
       <title>When a platform-specific package is available</title>
 
     <sect2>
       <title>When a platform-specific package is available</title>
@@ -119,14 +119,14 @@ following structure:
 <listitem>
 <para>
 the raw material from which the <literal>Makefile</literal>
 <listitem>
 <para>
 the raw material from which the <literal>Makefile</literal>
-will be made (<xref linkend="sec-install"/>).
+will be made (<xref linkend="install"/>).
 </para>
 </listitem></varlistentry>
 <varlistentry>
 <term><literal>configure</literal></term>
 <listitem>
 <para>
 </para>
 </listitem></varlistentry>
 <varlistentry>
 <term><literal>configure</literal></term>
 <listitem>
 <para>
-the configuration script (<xref linkend="sec-install"/>).
+the configuration script (<xref linkend="install"/>).
 </para>
 </listitem></varlistentry>
 <varlistentry>
 </para>
 </listitem></varlistentry>
 <varlistentry>
@@ -238,7 +238,7 @@ sub-directory per project).
 </variablelist>
 </para>
 
 </variablelist>
 </para>
 
-<sect3 id="sec-install">
+<sect3 id="install">
 <title>Installing</title>
 
 <para>
 <title>Installing</title>
 
 <para>
@@ -374,7 +374,7 @@ stuff in your bin directory.
 
 <para>
  Once done, test your &ldquo;installation&rdquo; as suggested in 
 
 <para>
  Once done, test your &ldquo;installation&rdquo; as suggested in 
-<xref linkend="sec-GHC-test"/>.  Be sure to use a <literal>-v</literal>
+<xref linkend="GHC-test"/>.  Be sure to use a <literal>-v</literal>
 option, so you can see exactly what pathnames it's using.
 
 If things don't work as expected, check the list of known pitfalls in
 option, so you can see exactly what pathnames it's using.
 
 If things don't work as expected, check the list of known pitfalls in
@@ -472,7 +472,7 @@ bundles won't install on their own.</para>
 
 </sect3>
 
 
 </sect3>
 
-<sect3 id="sec-GHC-test">
+<sect3 id="GHC-test">
 <title>Testing that GHC seems to be working
 </title>
 
 <title>Testing that GHC seems to be working
 </title>
 
@@ -529,11 +529,11 @@ on...</para>
 </sect1>
 
 
 </sect1>
 
 
-<sect1 id="sec-install-windows"><title>Installing on Windows</title>
+<sect1 id="install-windows"><title>Installing on Windows</title>
 
 <para>
 Getting the Glasgow Haskell Compiler (post 5.02) to run on Windows platforms is
 
 <para>
 Getting the Glasgow Haskell Compiler (post 5.02) to run on Windows platforms is
-a snap: the Installshield does everything you need.  
+a snap: the installer does everything you need.  
 </para>
 
 <sect2><title>Installing GHC on Windows</title>
 </para>
 
 <sect2><title>Installing GHC on Windows</title>
@@ -542,38 +542,29 @@ a snap: the Installshield does everything you need.
 To install GHC, use the following steps:
 </para>
 <itemizedlist>
 To install GHC, use the following steps:
 </para>
 <itemizedlist>
-<listitem><para>Download the Installshield <filename>setup.exe</filename>
-from the GHC download page
+<listitem><para>Download the installer
+from the
 <ulink
 <ulink
-url="http://www.haskell.org/ghc">haskell.org</ulink>.
+url="http://www.haskell.org/ghc/download.html">GHC download page</ulink>.
 </para></listitem>
 
 </para></listitem>
 
-<listitem><para>Run <filename>setup.exe</filename>.
+<listitem><para>Run the installer.
 On Windows, all of GHC's files are installed in a single directory.
 On Windows, all of GHC's files are installed in a single directory.
-If you choose ``Custom'' from the list of install options, you will be given a 
-choice about where this directory is; otherwise it will be installed 
-in <filename>c:/ghc/<replaceable>ghc-version</replaceable></filename>.
-The executable binary for GHC will be installed in the <filename>bin/</filename> sub-directory
-of the installation directory you choose.
-</para>
-<para>(If you have already installed the same version of GHC, Installshield will offer to "modify", 
-or "remove" GHC.  Choose "remove"; then run <filename>setup.exe</filename> a
-second time.  This time it should offer to install.)
+You can override it, but by default this directory is
+<filename>c:/ghc/<replaceable>ghc-version</replaceable></filename>.
+The executable binary for GHC will be installed in the
+<filename>bin/</filename> sub-directory of the installation directory.
+If you want to invoke GHC from a command line, add this
+to your PATH environment variable.
 </para>
 <para>
 </para>
 <para>
-When installation is complete, you should find GHCi and the GHC documentation are 
-available in your Start menu under "Start/Programs/Glasgow Haskell Compiler".
+When installation is complete, you should find GHCi and the GHC
+documentation are available in your Start menu under
+"Start/All Programs/GHC/<replaceable>ghc-version</replaceable>".
 </para>
 </listitem>
 
 <listitem><para>
 </para>
 </listitem>
 
 <listitem><para>
-The final dialogue box from the install process reminds you where the GHC binary 
-has been installed (usually <filename>c:/ghc/<replaceable>ghc-version</replaceable>/bin/</filename>.  
-If you want to invoke GHC from a command line, add this 
-to your PATH environment variable.  
-</para></listitem>
-
-<listitem><para>
 GHC needs a directory in which to create, and later delete, temporary files.
 It uses the standard Windows procedure <literal>GetTempPath()</literal> to
 find a suitable directory.  This procedure returns:
 GHC needs a directory in which to create, and later delete, temporary files.
 It uses the standard Windows procedure <literal>GetTempPath()</literal> to
 find a suitable directory.  This procedure returns:
@@ -608,7 +599,7 @@ bash$ ghc -o main main.hs
 ..
 bash$ ./main
 Hello, world!
 ..
 bash$ ./main
 Hello, world!
-bash$ </screen>
+bash$</screen>
 </listitem>
 </itemizedlist>
 
 </listitem>
 </itemizedlist>
 
@@ -617,7 +608,7 @@ You do <emphasis>not</emphasis> need the Cygwin toolchain, or anything
 else, to install and run GHC.
 </para>
 <para>
 else, to install and run GHC.
 </para>
 <para>
-An installation of GHC requires about 140M of disk space.
+An installation of GHC requires about 340M of disk space.
 To run GHC comfortably, your machine should have at least
 64M of memory.
 </para>
 To run GHC comfortably, your machine should have at least
 64M of memory.
 </para>
@@ -625,10 +616,11 @@ To run GHC comfortably, your machine should have at least
 
 <sect2><title>Moving GHC around</title>
 <para>
 
 <sect2><title>Moving GHC around</title>
 <para>
-At the moment, GHC installs in a fixed place (<filename>c:/ghc/ghc-x.yy</filename>,
-but once it is installed, you can freely move the entire GHC tree just by copying
-the <filename>ghc-x.yy</filename> directory.   (You may need to fix up 
-the links in "Start/Programs/Glasgow Haskell Compiler" if you do this.)
+Once GHC is installed, you can freely move the entire GHC tree just by copying
+the <filename>c:/ghc/<replaceable>ghc-version</replaceable></filename>
+directory. (You will need to fix up 
+the links in "Start/All Programs/GHC/<replaceable>ghc-version</replaceable>"
+if you do this.)
 </para>
 <para>
 It is OK to put GHC tree in a directory whose path involves spaces.  However,
 </para>
 <para>
 It is OK to put GHC tree in a directory whose path involves spaces.  However,
@@ -647,7 +639,8 @@ put GHC in a place with a space-free path.
        <varlistentry>
          <term>I'm having trouble with symlinks.</term>
          <listitem>
        <varlistentry>
          <term>I'm having trouble with symlinks.</term>
          <listitem>
-           <para>Symlinks only work under Cygwin (<xref linkend="sec-install" />), so binaries not linked to the Cygwin
+           <para>Symlinks only work under Cygwin (<xref linkend="install" />),
+          so binaries not linked to the Cygwin
              DLL, in particular those built for Mingwin, will not work with
              symlinks.</para>
          </listitem>
              DLL, in particular those built for Mingwin, will not work with
              symlinks.</para>
          </listitem>
@@ -665,23 +658,12 @@ put GHC in a place with a space-free path.
          </listitem>
        </varlistentry>
       </variablelist>
          </listitem>
        </varlistentry>
       </variablelist>
-
-<!-- doesn't add much value any longer; leave out [sof 7/2002].
-<para>
-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>. Note: ignore the installation instructions, which are rather
-out of date; the <emphasis>Miscellaneous</emphasis> section at the bottom of
-the page is of most interest, covering topics beyond the scope of this
-manual.
-</para>
--->
 </sect2>
 
 </sect1>
 
 
 </sect2>
 
 </sect1>
 
 
-<sect1 id="sec-install-files"><title>The layout of installed files</title>
+<sect1 id="install-files"><title>The layout of installed files</title>
 
 <para>
 This section describes what files get installed where.  You don't need to know it
 
 <para>
 This section describes what files get installed where.  You don't need to know it